Add path argument to plugin create command (jupyterlab#124)

* add path/name argument in plugin create command

* fix test

* add suggestions

* fix test and cleanup

* add path to skill

* remove plugin suffix

Author: MUFFANUJ

_agents/skills/plugin-authoring/SKILL.md

@@ -32,7 +32,7 @@ Produce working plugin code that can be loaded with `plugin-playground:load-as-e
 
 1. Prepare a TypeScript file
 
-- If the user does not already have a plugin file open or specified, run `plugin-playground:create-new-plugin`.
+- If the user does not already have a plugin file open or specified, run `plugin-playground:create-new-plugin` with a meaningful `path` argument (for example `app.commands.execute('plugin-playground:create-new-plugin', { path: 'status-indicator.ts' })`) instead of relying on untitled defaults.
 - Start from the generated TypeScript scaffold and adapt it.
 - Focus on TypeScript/TSX plugin code. Do not scaffold Python projects (`pyproject.toml`, Python package layout) unless explicitly requested.
 

src/index.ts

@@ -33,6 +33,7 @@ import {
 } from '@jupyterlab/ui-components';
 
 import { IDocumentManager } from '@jupyterlab/docmanager';
+import { PathExt } from '@jupyterlab/coreutils';
 
 import { Contents } from '@jupyterlab/services';
 import { ICompletionProviderManager } from '@jupyterlab/completer';
@@ -204,6 +205,7 @@ const LIST_QUERY_ARGS_SCHEMA = {
     }
   }
 };
+
 const EXPORT_AS_EXTENSION_ARGS_SCHEMA = {
   type: 'object',
   additionalProperties: false,
@@ -215,6 +217,18 @@ const EXPORT_AS_EXTENSION_ARGS_SCHEMA = {
     }
   }
 };
+
+const CREATE_PLUGIN_ARGS_SCHEMA = {
+  type: 'object',
+  additionalProperties: false,
+  properties: {
+    path: {
+      type: 'string',
+      description:
+        'Optional file path. Relative paths are resolved from the current working directory; paths starting with "/" are resolved from the workspace root. If no extension is provided, ".ts" is appended.'
+    }
+  }
+};
 const LOAD_ON_SAVE_TOGGLE_TOOLBAR_ITEM = 'plugin-playground-load-on-save';
 const LOAD_ON_SAVE_CHECKBOX_LABEL = 'Auto Load on Save';
 const LOAD_ON_SAVE_SETTING = 'loadOnSave';
@@ -371,25 +385,66 @@ class PluginPlayground {
     app.commands.addCommand(CommandIDs.createNewFile, {
       label: 'TypeScript File (Playground)',
       caption: 'Create a new TypeScript file',
-      describedBy: { args: null },
+      describedBy: { args: CREATE_PLUGIN_ARGS_SCHEMA },
       icon: extensionIcon,
       execute: async args => {
-        const model = await app.commands.execute('docmanager:new-untitled', {
-          path: args['cwd'],
+        const rawPathArg =
+          typeof args.path === 'string' ? args.path.trim() : '';
+        const isRootRelativePath = rawPathArg.startsWith('/');
+
+        const model = await app.serviceManager.contents.newUntitled({
           type: 'file',
           ext: 'ts'
         });
-        const widget: IDocumentWidget<FileEditor> | undefined =
-          await app.commands.execute('docmanager:open', {
-            path: model.path,
-            factory: 'Editor'
-          });
-        if (widget) {
-          widget.content.ready.then(() => {
-            widget.content.model.sharedModel.setSource(PLUGIN_TEMPLATE);
+
+        let openPath = model.path;
+        const normalizedPathArg = normalizeContentsPath(rawPathArg);
+        if (normalizedPathArg) {
+          const baseDirectory = normalizeContentsPath(
+            PathExt.dirname(model.path)
+          );
+          let targetPath = isRootRelativePath
+            ? normalizedPathArg
+            : normalizeContentsPath(
+                PathExt.join(baseDirectory, normalizedPathArg)
+              );
+
+          if (!/\.[^/]+$/.test(targetPath)) {
+            targetPath = `${targetPath}.ts`;
+          }
+
+          if (targetPath !== model.path) {
+            openPath = (
+              await app.serviceManager.contents.rename(model.path, targetPath)
+            ).path;
+          }
+        }
+
+        await app.commands.execute('docmanager:open', {
+          path: openPath,
+          factory: 'Editor'
+        });
+
+        const normalizedOpenPath = normalizeContentsPath(openPath);
+        let widget: IDocumentWidget<FileEditor> | null = null;
+        editorTracker.forEach(candidate => {
+          if (
+            !widget &&
+            normalizeContentsPath(candidate.context.path) === normalizedOpenPath
+          ) {
+            widget = candidate;
+          }
+        });
+        if (!widget) {
+          widget = editorTracker.currentWidget;
+        }
+        const activeWidget = widget;
+        if (activeWidget) {
+          activeWidget.content.ready.then(() => {
+            activeWidget.content.model.sharedModel.setSource(PLUGIN_TEMPLATE);
           });
         }
-        return widget;
+        return activeWidget;
       }
     });
 

ui-tests/tests/plugin-playground.spec.ts

@@ -261,6 +261,39 @@ test('opens a dummy extension example from the sidebar', async ({ page }) => {
   }, expectedReadmePath);
 });
 
+test('creates a plugin file with an explicit path argument', async ({
+  page,
+  tmpPath
+}) => {
+  const requestedPath = `/${tmpPath}/named-by-command`;
+  const expectedPath = `${tmpPath}/named-by-command.ts`;
+
+  try {
+    await page.goto();
+    await page.waitForCondition(() =>
+      page.evaluate((id: string) => {
+        return window.jupyterapp.commands.hasCommand(id);
+      }, CREATE_FILE_COMMAND)
+    );
+
+    const openPath = await page.evaluate(
+      async ({ id, path }) => {
+        await window.jupyterapp.commands.execute(id, { path });
+        const current = window.jupyterapp.shell
+          .currentWidget as FileEditorWidget | null;
+        return current?.context?.path ?? null;
+      },
+      {
+        id: CREATE_FILE_COMMAND,
+        path: requestedPath
+      }
+    );
+    expect(openPath).toBe(expectedPath);
+  } finally {
+    await page.unrouteAll({ behavior: 'ignoreErrors' });
+  }
+});
+
 test('lists tokens and searches commands via command APIs', async ({
   page
 }) => {