Migrate extension metadata to plugin.json and enforce conventions (#2177)

* Remove pluginRoots property from marketplace.json The pluginRoots property is not used by install tooling and was only informational about the extension/plugin source directories. Removing it simplifies the marketplace.json structure while maintaining all functionality. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Migrate java-modernization-studio to plugin.json and update validation workflow - Create .github/plugin/plugin.json for java-modernization-studio extension - Remove legacy canvas.json from java-modernization-studio - Update validate-canvas-extensions.yml workflow to check for plugin.json instead of canvas.json - Update workflow to trigger on .schemas/plugin.schema.json changes (instead of canvas.schema.json) - Remove schema validation logic that relied on canvas.schema.json - All 12 extensions now use plugin.json for metadata Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Add extensions field to all extension plugin.json files Per https://github.com/github/copilot-agent-runtime/pull/9929, plugins that ship extensions need to include an extensions field specifying where the extension code is located. All 12 extensions now have extensions set to '.' to reference the current directory where extension.mjs is located. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Enforce convention-based extension metadata and remove x-awesome-copilot - Remove x-awesome-copilot.screenshots from all extension plugin.json files - Enforce logo=assets/preview.png convention for all extensions - Enforce extensions=. per copilot-agent-runtime#9929 - Update validate-plugins.mjs to enforce conventions - Update validate-canvas-extensions.yml workflow with convention checks - Update AGENTS.md and CONTRIBUTING.md documentation All 12 extensions validated successfully. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * Use standard plugin validation for extensions Remove the custom extension schema and schema validation helper, and validate extension plugin.json files through the existing plugin validator instead. Update workflows to stop depending on the removed schema. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
2026-07-14 01:51:02 +00:00 · 2026-07-03 12:24:38 +10:00
parent da3855ab20
commit e986f49695
27 changed files with 748 additions and 687 deletions
@@ -6,6 +6,7 @@ import { ROOT_FOLDER } from "./constants.mjs";
 import { readExternalPlugins } from "./external-plugin-validation.mjs";

 const PLUGINS_DIR = path.join(ROOT_FOLDER, "plugins");
+const EXTENSIONS_DIR = path.join(ROOT_FOLDER, "extensions");

 // Validation functions
 function validateName(name, folderName) {
@@ -77,6 +78,29 @@ function sortPluginEntries(entries) {
  return [...entries].sort((left, right) => left.localeCompare(right));
 }

+function parseJsonFile(filePath) {
+  try {
+    return JSON.parse(fs.readFileSync(filePath, "utf-8"));
+  } catch (err) {
+    return { parseError: err.message };
+  }
+}
+
+function getExtensionFolderNames() {
+  if (!fs.existsSync(EXTENSIONS_DIR)) {
+    return [];
+  }
+
+  return fs.readdirSync(EXTENSIONS_DIR, { withFileTypes: true })
+    .filter((entry) => {
+      if (!entry.isDirectory()) return false;
+      const extensionEntryPoint = path.join(EXTENSIONS_DIR, entry.name, "extension.mjs");
+      return fs.existsSync(extensionEntryPoint);
+    })
+    .map((entry) => entry.name)
+    .sort();
+}
+
 function validateSpecPaths(plugin) {
  const errors = [];
  const specs = {
@@ -131,9 +155,51 @@ function validateSpecPaths(plugin) {
  return errors;
 }

+function validateCuratedPluginExtensionRefs(plugin) {
+  const errors = [];
+  const extensionRefs = plugin?.["x-awesome-copilot"]?.extensions;
+  if (extensionRefs === undefined) {
+    return errors;
+  }
+
+  if (!Array.isArray(extensionRefs)) {
+    errors.push('x-awesome-copilot.extensions must be an array');
+    return errors;
+  }
+
+  if (!arraysEqual(extensionRefs, sortPluginEntries(extensionRefs))) {
+    errors.push('x-awesome-copilot.extensions must be sorted alphabetically');
+  }
+
+  const knownExtensions = new Set(getExtensionFolderNames());
+  for (let i = 0; i < extensionRefs.length; i++) {
+    const ref = extensionRefs[i];
+    if (typeof ref !== "string") {
+      errors.push(`x-awesome-copilot.extensions[${i}] must be a string`);
+      continue;
+    }
+    if (!ref.startsWith("./extensions/")) {
+      errors.push(`x-awesome-copilot.extensions[${i}] must start with "./extensions/"`);
+      continue;
+    }
+
+    const normalized = ref.replace(/^\.\/extensions\//, "").replace(/\/$/, "");
+    if (!normalized) {
+      errors.push(`x-awesome-copilot.extensions[${i}] must include an extension folder name`);
+      continue;
+    }
+    if (!knownExtensions.has(normalized)) {
+      errors.push(`x-awesome-copilot.extensions[${i}] source not found: extensions/${normalized}`);
+    }
+  }
+
+  return errors;
+}
+
 function validatePlugin(folderName) {
  const pluginDir = path.join(PLUGINS_DIR, folderName);
  const errors = [];
+  let parsedPlugin = null;

  // Rule 1: Must have .github/plugin/plugin.json
  const pluginJsonPath = path.join(pluginDir, ".github/plugin", "plugin.json");
@@ -153,9 +219,10 @@ function validatePlugin(folderName) {
  try {
    const raw = fs.readFileSync(pluginJsonPath, "utf-8");
    plugin = JSON.parse(raw);
+    parsedPlugin = plugin;
  } catch (err) {
    errors.push(`failed to parse plugin.json: ${err.message}`);
-    return errors;
+    return { errors, plugin: parsedPlugin };
  }

  // Rule 3 & 4: name, description, version
@@ -176,35 +243,101 @@ function validatePlugin(folderName) {
  const specErrors = validateSpecPaths(plugin);
  errors.push(...specErrors);

-  return errors;
+  const extensionRefErrors = validateCuratedPluginExtensionRefs(plugin);
+  errors.push(...extensionRefErrors);
+
+  return { errors, plugin: parsedPlugin };
+}
+
+function validateExtensionScreenshotPath(extensionDir, pathValue, fieldName, errors) {
+  if (!pathValue || typeof pathValue !== "string") {
+    errors.push(`${fieldName} must be a string path`);
+    return;
+  }
+
+  const normalizedPath = pathValue.replace(/^\.\/+/, "");
+  const absolutePath = path.join(extensionDir, normalizedPath);
+  if (!fs.existsSync(absolutePath)) {
+    errors.push(`${fieldName} not found: ${normalizedPath}`);
+  }
+}
+
+function validateExtensionManifest(folderName) {
+  const extensionDir = path.join(EXTENSIONS_DIR, folderName);
+  const errors = [];
+  let parsedPlugin = null;
+
+  const pluginJsonPath = path.join(extensionDir, ".github/plugin", "plugin.json");
+  if (!fs.existsSync(pluginJsonPath)) {
+    errors.push("missing required file: .github/plugin/plugin.json");
+    return { errors, plugin: parsedPlugin };
+  }
+
+  const parsed = parseJsonFile(pluginJsonPath);
+  if (parsed.parseError) {
+    errors.push(`failed to parse plugin.json: ${parsed.parseError}`);
+    return { errors, plugin: parsedPlugin };
+  }
+
+  parsedPlugin = parsed;
+
+  const nameErrors = validateName(parsed.name, folderName);
+  errors.push(...nameErrors);
+
+  const descError = validateDescription(parsed.description);
+  if (descError) errors.push(descError);
+
+  const versionError = validateVersion(parsed.version);
+  if (versionError) errors.push(versionError);
+
+  const keywordsError = validateKeywords(parsed.keywords ?? parsed.tags);
+  if (keywordsError) errors.push(keywordsError);
+
+  // Extension convention: logo must be exactly "assets/preview.png"
+  if (parsed.logo !== "assets/preview.png") {
+    errors.push('logo must be exactly "assets/preview.png" (extension convention)');
+  } else {
+    validateExtensionScreenshotPath(extensionDir, parsed.logo, "logo", errors);
+  }
+
+  // Extension convention: x-awesome-copilot must not be present
+  if (parsed["x-awesome-copilot"] !== undefined) {
+    errors.push("x-awesome-copilot field must not be present (use convention-based logo instead)");
+  }
+
+  // Extension convention: extensions field must be "."
+  if (parsed.extensions !== ".") {
+    errors.push('extensions field must be exactly "." (extension convention)');
+  }
+
+  return { errors, plugin: parsedPlugin };
 }

 // Main validation function
 function validatePlugins() {
-  if (!fs.existsSync(PLUGINS_DIR)) {
-    console.log("No plugins directory found - validation skipped");
-    return true;
-  }
+  const pluginDirs = fs.existsSync(PLUGINS_DIR)
+    ? fs.readdirSync(PLUGINS_DIR, { withFileTypes: true })
+      .filter((d) => d.isDirectory())
+      .map((d) => d.name)
+    : [];
+  const extensionDirs = getExtensionFolderNames();

-  const pluginDirs = fs
-    .readdirSync(PLUGINS_DIR, { withFileTypes: true })
-    .filter((d) => d.isDirectory())
-    .map((d) => d.name);
-
-  if (pluginDirs.length === 0) {
-    console.log("No plugin directories found - validation skipped");
+  if (pluginDirs.length === 0 && extensionDirs.length === 0) {
+    console.log("No plugins or extension plugin manifests found - validation skipped");
    return true;
  }

  console.log(`Validating ${pluginDirs.length} plugins...\n`);
+  console.log(`Validating ${extensionDirs.length} extensions as plugin sources...\n`);

  let hasErrors = false;
  const seenNames = new Set();
+  const localPluginNames = [];

  for (const dir of pluginDirs) {
    console.log(`Validating ${dir}...`);

-    const errors = validatePlugin(dir);
+    const { errors, plugin } = validatePlugin(dir);

    if (errors.length > 0) {
      console.error(`❌ ${dir}:`);
@@ -214,18 +347,47 @@ function validatePlugins() {
      console.log(`✅ ${dir} is valid`);
    }

-    // Rule 10: duplicate names
-    if (seenNames.has(dir)) {
-      console.error(`❌ Duplicate plugin name "${dir}"`);
+    if (plugin?.name) {
+      if (seenNames.has(plugin.name)) {
+        console.error(`❌ Duplicate plugin name "${plugin.name}"`);
+        hasErrors = true;
+      } else {
+        seenNames.add(plugin.name);
+        localPluginNames.push(plugin.name);
+      }
+    }
+  }
+
+  if (extensionDirs.length > 0) {
+    console.log("");
+  }
+
+  for (const dir of extensionDirs) {
+    console.log(`Validating extension ${dir}...`);
+    const { errors, plugin } = validateExtensionManifest(dir);
+
+    if (errors.length > 0) {
+      console.error(`❌ extension ${dir}:`);
+      errors.forEach((e) => console.error(`   - ${e}`));
      hasErrors = true;
    } else {
-      seenNames.add(dir);
+      console.log(`✅ extension ${dir} is valid`);
+    }
+
+    if (plugin?.name) {
+      if (seenNames.has(plugin.name)) {
+        console.error(`❌ Duplicate plugin name "${plugin.name}"`);
+        hasErrors = true;
+      } else {
+        seenNames.add(plugin.name);
+        localPluginNames.push(plugin.name);
+      }
    }
  }

  console.log("\nValidating external plugin catalog...");
  const { plugins: externalPlugins, errors: externalErrors, warnings: externalWarnings } = readExternalPlugins({
-    localPluginNames: pluginDirs,
+    localPluginNames,
    policy: "marketplace",
  });

@@ -240,7 +402,7 @@ function validatePlugins() {
  }

  if (!hasErrors) {
-    console.log(`\n✅ All ${pluginDirs.length} plugins and the external catalog are valid`);
+    console.log(`\n✅ All ${pluginDirs.length} plugins, ${extensionDirs.length} extensions, and the external catalog are valid`);
  }

  return !hasErrors;