@backstage/cli-module-new 0.0.0-nightly-20260317031259

package/dist/lib/execution/installNewPackage.cjs.js

@@ -0,0 +1,127 @@
+'use strict';
+
+var fs = require('fs-extra');
+var upperFirst = require('lodash/upperFirst');
+var camelCase = require('lodash/camelCase');
+var cliCommon = require('@backstage/cli-common');
+var tasks = require('../tasks.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+var upperFirst__default = /*#__PURE__*/_interopDefaultCompat(upperFirst);
+var camelCase__default = /*#__PURE__*/_interopDefaultCompat(camelCase);
+
+async function installNewPackage(input) {
+  switch (input.roleParams.role) {
+    case "web-library":
+    case "node-library":
+    case "common-library":
+    case "plugin-web-library":
+    case "plugin-node-library":
+    case "plugin-common-library":
+      return;
+    // No installation action needed for library packages
+    case "frontend-plugin":
+      await addDependency(input, "packages/app/package.json");
+      await tryAddFrontendLegacy(input);
+      return;
+    case "frontend-plugin-module":
+      await addDependency(input, "packages/app/package.json");
+      return;
+    case "backend-plugin":
+      await addDependency(input, "packages/backend/package.json");
+      await tryAddBackend(input);
+      return;
+    case "backend-plugin-module":
+      await addDependency(input, "packages/backend/package.json");
+      await tryAddBackend(input);
+      return;
+    default:
+      throw new Error(
+        `Unsupported role ${input.roleParams.role}`
+      );
+  }
+}
+async function addDependency(input, path) {
+  const pkgJsonPath = cliCommon.targetPaths.resolveRoot(path);
+  const pkgJson = await fs__default.default.readJson(pkgJsonPath).catch((error) => {
+    if (error.code === "ENOENT") {
+      return void 0;
+    }
+    throw error;
+  });
+  if (!pkgJson) {
+    return;
+  }
+  try {
+    pkgJson.dependencies = {
+      ...pkgJson.dependencies,
+      [input.packageName]: `workspace:^`
+    };
+    await fs__default.default.writeJson(path, pkgJson, { spaces: 2 });
+  } catch (error) {
+    throw new Error(`Failed to add package dependencies, ${error}`);
+  }
+}
+async function tryAddFrontendLegacy(input) {
+  const { roleParams } = input;
+  if (roleParams.role !== "frontend-plugin") {
+    throw new Error(
+      "add-frontend-legacy can only be used for frontend plugins"
+    );
+  }
+  const appDefinitionPath = cliCommon.targetPaths.resolveRoot("packages/app/src/App.tsx");
+  if (!await fs__default.default.pathExists(appDefinitionPath)) {
+    return;
+  }
+  await tasks.Task.forItem("app", "adding import", async () => {
+    const content = await fs__default.default.readFile(appDefinitionPath, "utf8");
+    const revLines = content.split("\n").reverse();
+    const lastImportIndex = revLines.findIndex(
+      (line) => line.match(/ from ("|').*("|')/)
+    );
+    const lastRouteIndex = revLines.findIndex(
+      (line) => line.match(/<\/FlatRoutes/)
+    );
+    if (lastImportIndex !== -1 && lastRouteIndex !== -1) {
+      const extensionName = upperFirst__default.default(`${camelCase__default.default(roleParams.pluginId)}Page`);
+      const importLine = `import { ${extensionName} } from '${input.packageName}';`;
+      if (!content.includes(importLine)) {
+        revLines.splice(lastImportIndex, 0, importLine);
+      }
+      const componentLine = `<Route path="/${roleParams.pluginId}" element={<${extensionName} />} />`;
+      if (!content.includes(componentLine)) {
+        const [indentation] = revLines[lastRouteIndex + 1].match(/^\s*/) ?? [];
+        revLines.splice(lastRouteIndex + 1, 0, indentation + componentLine);
+      }
+      const newContent = revLines.reverse().join("\n");
+      await fs__default.default.writeFile(appDefinitionPath, newContent, "utf8");
+    }
+  });
+}
+async function tryAddBackend(input) {
+  const backendIndexPath = cliCommon.targetPaths.resolveRoot(
+    "packages/backend/src/index.ts"
+  );
+  if (!await fs__default.default.pathExists(backendIndexPath)) {
+    return;
+  }
+  await tasks.Task.forItem("backend", `adding ${input.packageName}`, async () => {
+    const content = await fs__default.default.readFile(backendIndexPath, "utf8");
+    const lines = content.split("\n");
+    const backendAddLine = `backend.add(import('${input.packageName}'));`;
+    const backendStartIndex = lines.findIndex(
+      (line) => line.match(/backend.start/)
+    );
+    if (backendStartIndex !== -1) {
+      const [indentation] = lines[backendStartIndex].match(/^\s*/);
+      lines.splice(backendStartIndex, 0, `${indentation}${backendAddLine}`);
+      const newContent = lines.join("\n");
+      await fs__default.default.writeFile(backendIndexPath, newContent, "utf8");
+    }
+  });
+}
+
+exports.installNewPackage = installNewPackage;
+//# sourceMappingURL=installNewPackage.cjs.js.map

package/dist/lib/execution/installNewPackage.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"installNewPackage.cjs.js","sources":["../../../src/lib/execution/installNewPackage.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport fs from 'fs-extra';\nimport upperFirst from 'lodash/upperFirst';\nimport camelCase from 'lodash/camelCase';\nimport { targetPaths } from '@backstage/cli-common';\n\nimport { Task } from '../tasks';\nimport { PortableTemplateInput } from '../types';\n\nexport async function installNewPackage(input: PortableTemplateInput) {\n  switch (input.roleParams.role) {\n    case 'web-library':\n    case 'node-library':\n    case 'common-library':\n    case 'plugin-web-library':\n    case 'plugin-node-library':\n    case 'plugin-common-library':\n      return; // No installation action needed for library packages\n    case 'frontend-plugin':\n      await addDependency(input, 'packages/app/package.json');\n      await tryAddFrontendLegacy(input);\n      return;\n    case 'frontend-plugin-module':\n      await addDependency(input, 'packages/app/package.json');\n      return;\n    case 'backend-plugin':\n      await addDependency(input, 'packages/backend/package.json');\n      await tryAddBackend(input);\n      return;\n    case 'backend-plugin-module':\n      await addDependency(input, 'packages/backend/package.json');\n      await tryAddBackend(input);\n      return;\n    default:\n      throw new Error(\n        `Unsupported role ${(input.roleParams as { role: string }).role}`,\n      );\n  }\n}\n\nasync function addDependency(input: PortableTemplateInput, path: string) {\n  const pkgJsonPath = targetPaths.resolveRoot(path);\n\n  const pkgJson = await fs.readJson(pkgJsonPath).catch(error => {\n    if (error.code === 'ENOENT') {\n      return undefined;\n    }\n    throw error;\n  });\n  if (!pkgJson) {\n    return;\n  }\n\n  try {\n    pkgJson.dependencies = {\n      ...pkgJson.dependencies,\n      [input.packageName]: `workspace:^`,\n    };\n\n    await fs.writeJson(path, pkgJson, { spaces: 2 });\n  } catch (error) {\n    throw new Error(`Failed to add package dependencies, ${error}`);\n  }\n}\n\nasync function tryAddFrontendLegacy(input: PortableTemplateInput) {\n  const { roleParams } = input;\n  if (roleParams.role !== 'frontend-plugin') {\n    throw new Error(\n      'add-frontend-legacy can only be used for frontend plugins',\n    );\n  }\n\n  const appDefinitionPath = targetPaths.resolveRoot('packages/app/src/App.tsx');\n  if (!(await fs.pathExists(appDefinitionPath))) {\n    return;\n  }\n\n  await Task.forItem('app', 'adding import', async () => {\n    const content = await fs.readFile(appDefinitionPath, 'utf8');\n    const revLines = content.split('\\n').reverse();\n\n    const lastImportIndex = revLines.findIndex(line =>\n      line.match(/ from (\"|').*(\"|')/),\n    );\n    const lastRouteIndex = revLines.findIndex(line =>\n      line.match(/<\\/FlatRoutes/),\n    );\n\n    if (lastImportIndex !== -1 && lastRouteIndex !== -1) {\n      const extensionName = upperFirst(`${camelCase(roleParams.pluginId)}Page`);\n      const importLine = `import { ${extensionName} } from '${input.packageName}';`;\n      if (!content.includes(importLine)) {\n        revLines.splice(lastImportIndex, 0, importLine);\n      }\n\n      const componentLine = `<Route path=\"/${roleParams.pluginId}\" element={<${extensionName} />} />`;\n      if (!content.includes(componentLine)) {\n        const [indentation] = revLines[lastRouteIndex + 1].match(/^\\s*/) ?? [];\n        revLines.splice(lastRouteIndex + 1, 0, indentation + componentLine);\n      }\n\n      const newContent = revLines.reverse().join('\\n');\n      await fs.writeFile(appDefinitionPath, newContent, 'utf8');\n    }\n  });\n}\n\nasync function tryAddBackend(input: PortableTemplateInput) {\n  const backendIndexPath = targetPaths.resolveRoot(\n    'packages/backend/src/index.ts',\n  );\n  if (!(await fs.pathExists(backendIndexPath))) {\n    return;\n  }\n\n  await Task.forItem('backend', `adding ${input.packageName}`, async () => {\n    const content = await fs.readFile(backendIndexPath, 'utf8');\n    const lines = content.split('\\n');\n    const backendAddLine = `backend.add(import('${input.packageName}'));`;\n\n    const backendStartIndex = lines.findIndex(line =>\n      line.match(/backend.start/),\n    );\n\n    if (backendStartIndex !== -1) {\n      const [indentation] = lines[backendStartIndex].match(/^\\s*/)!;\n      lines.splice(backendStartIndex, 0, `${indentation}${backendAddLine}`);\n\n      const newContent = lines.join('\\n');\n      await fs.writeFile(backendIndexPath, newContent, 'utf8');\n    }\n  });\n}\n"],"names":["targetPaths","fs","Task","upperFirst","camelCase"],"mappings":";;;;;;;;;;;;;;AAuBA,eAAsB,kBAAkB,KAAA,EAA8B;AACpE,EAAA,QAAQ,KAAA,CAAM,WAAW,IAAA;AAAM,IAC7B,KAAK,aAAA;AAAA,IACL,KAAK,cAAA;AAAA,IACL,KAAK,gBAAA;AAAA,IACL,KAAK,oBAAA;AAAA,IACL,KAAK,qBAAA;AAAA,IACL,KAAK,uBAAA;AACH,MAAA;AAAA;AAAA,IACF,KAAK,iBAAA;AACH,MAAA,MAAM,aAAA,CAAc,OAAO,2BAA2B,CAAA;AACtD,MAAA,MAAM,qBAAqB,KAAK,CAAA;AAChC,MAAA;AAAA,IACF,KAAK,wBAAA;AACH,MAAA,MAAM,aAAA,CAAc,OAAO,2BAA2B,CAAA;AACtD,MAAA;AAAA,IACF,KAAK,gBAAA;AACH,MAAA,MAAM,aAAA,CAAc,OAAO,+BAA+B,CAAA;AAC1D,MAAA,MAAM,cAAc,KAAK,CAAA;AACzB,MAAA;AAAA,IACF,KAAK,uBAAA;AACH,MAAA,MAAM,aAAA,CAAc,OAAO,+BAA+B,CAAA;AAC1D,MAAA,MAAM,cAAc,KAAK,CAAA;AACzB,MAAA;AAAA,IACF;AACE,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,iBAAA,EAAqB,KAAA,CAAM,UAAA,CAAgC,IAAI,CAAA;AAAA,OACjE;AAAA;AAEN;AAEA,eAAe,aAAA,CAAc,OAA8B,IAAA,EAAc;AACvE,EAAA,MAAM,WAAA,GAAcA,qBAAA,CAAY,WAAA,CAAY,IAAI,CAAA;AAEhD,EAAA,MAAM,UAAU,MAAMC,mBAAA,CAAG,SAAS,WAAW,CAAA,CAAE,MAAM,CAAA,KAAA,KAAS;AAC5D,IAAA,IAAI,KAAA,CAAM,SAAS,QAAA,EAAU;AAC3B,MAAA,OAAO,MAAA;AAAA,IACT;AACA,IAAA,MAAM,KAAA;AAAA,EACR,CAAC,CAAA;AACD,EAAA,IAAI,CAAC,OAAA,EAAS;AACZ,IAAA;AAAA,EACF;AAEA,EAAA,IAAI;AACF,IAAA,OAAA,CAAQ,YAAA,GAAe;AAAA,MACrB,GAAG,OAAA,CAAQ,YAAA;AAAA,MACX,CAAC,KAAA,CAAM,WAAW,GAAG,CAAA,WAAA;AAAA,KACvB;AAEA,IAAA,MAAMA,oBAAG,SAAA,CAAU,IAAA,EAAM,SAAS,EAAE,MAAA,EAAQ,GAAG,CAAA;AAAA,EACjD,SAAS,KAAA,EAAO;AACd,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,oCAAA,EAAuC,KAAK,CAAA,CAAE,CAAA;AAAA,EAChE;AACF;AAEA,eAAe,qBAAqB,KAAA,EAA8B;AAChE,EAAA,MAAM,EAAE,YAAW,GAAI,KAAA;AACvB,EAAA,IAAI,UAAA,CAAW,SAAS,iBAAA,EAAmB;AACzC,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KACF;AAAA,EACF;AAEA,EAAA,MAAM,iBAAA,GAAoBD,qBAAA,CAAY,WAAA,CAAY,0BAA0B,CAAA;AAC5E,EAAA,IAAI,CAAE,MAAMC,mBAAA,CAAG,UAAA,CAAW,iBAAiB,CAAA,EAAI;AAC7C,IAAA;AAAA,EACF;AAEA,EAAA,MAAMC,UAAA,CAAK,OAAA,CAAQ,KAAA,EAAO,eAAA,EAAiB,YAAY;AACrD,IAAA,MAAM,OAAA,GAAU,MAAMD,mBAAA,CAAG,QAAA,CAAS,mBAAmB,MAAM,CAAA;AAC3D,IAAA,MAAM,QAAA,GAAW,OAAA,CAAQ,KAAA,CAAM,IAAI,EAAE,OAAA,EAAQ;AAE7C,IAAA,MAAM,kBAAkB,QAAA,CAAS,SAAA;AAAA,MAAU,CAAA,IAAA,KACzC,IAAA,CAAK,KAAA,CAAM,oBAAoB;AAAA,KACjC;AACA,IAAA,MAAM,iBAAiB,QAAA,CAAS,SAAA;AAAA,MAAU,CAAA,IAAA,KACxC,IAAA,CAAK,KAAA,CAAM,eAAe;AAAA,KAC5B;AAEA,IAAA,IAAI,eAAA,KAAoB,EAAA,IAAM,cAAA,KAAmB,EAAA,EAAI;AACnD,MAAA,MAAM,gBAAgBE,2BAAA,CAAW,CAAA,EAAGC,2BAAU,UAAA,CAAW,QAAQ,CAAC,CAAA,IAAA,CAAM,CAAA;AACxE,MAAA,MAAM,UAAA,GAAa,CAAA,SAAA,EAAY,aAAa,CAAA,SAAA,EAAY,MAAM,WAAW,CAAA,EAAA,CAAA;AACzE,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAA,CAAS,UAAU,CAAA,EAAG;AACjC,QAAA,QAAA,CAAS,MAAA,CAAO,eAAA,EAAiB,CAAA,EAAG,UAAU,CAAA;AAAA,MAChD;AAEA,MAAA,MAAM,aAAA,GAAgB,CAAA,cAAA,EAAiB,UAAA,CAAW,QAAQ,eAAe,aAAa,CAAA,OAAA,CAAA;AACtF,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAA,CAAS,aAAa,CAAA,EAAG;AACpC,QAAA,MAAM,CAAC,WAAW,CAAA,GAAI,QAAA,CAAS,cAAA,GAAiB,CAAC,CAAA,CAAE,KAAA,CAAM,MAAM,CAAA,IAAK,EAAC;AACrE,QAAA,QAAA,CAAS,MAAA,CAAO,cAAA,GAAiB,CAAA,EAAG,CAAA,EAAG,cAAc,aAAa,CAAA;AAAA,MACpE;AAEA,MAAA,MAAM,UAAA,GAAa,QAAA,CAAS,OAAA,EAAQ,CAAE,KAAK,IAAI,CAAA;AAC/C,MAAA,MAAMH,mBAAA,CAAG,SAAA,CAAU,iBAAA,EAAmB,UAAA,EAAY,MAAM,CAAA;AAAA,IAC1D;AAAA,EACF,CAAC,CAAA;AACH;AAEA,eAAe,cAAc,KAAA,EAA8B;AACzD,EAAA,MAAM,mBAAmBD,qBAAA,CAAY,WAAA;AAAA,IACnC;AAAA,GACF;AACA,EAAA,IAAI,CAAE,MAAMC,mBAAA,CAAG,UAAA,CAAW,gBAAgB,CAAA,EAAI;AAC5C,IAAA;AAAA,EACF;AAEA,EAAA,MAAMC,WAAK,OAAA,CAAQ,SAAA,EAAW,UAAU,KAAA,CAAM,WAAW,IAAI,YAAY;AACvE,IAAA,MAAM,OAAA,GAAU,MAAMD,mBAAA,CAAG,QAAA,CAAS,kBAAkB,MAAM,CAAA;AAC1D,IAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,KAAA,CAAM,IAAI,CAAA;AAChC,IAAA,MAAM,cAAA,GAAiB,CAAA,oBAAA,EAAuB,KAAA,CAAM,WAAW,CAAA,IAAA,CAAA;AAE/D,IAAA,MAAM,oBAAoB,KAAA,CAAM,SAAA;AAAA,MAAU,CAAA,IAAA,KACxC,IAAA,CAAK,KAAA,CAAM,eAAe;AAAA,KAC5B;AAEA,IAAA,IAAI,sBAAsB,EAAA,EAAI;AAC5B,MAAA,MAAM,CAAC,WAAW,CAAA,GAAI,MAAM,iBAAiB,CAAA,CAAE,MAAM,MAAM,CAAA;AAC3D,MAAA,KAAA,CAAM,OAAO,iBAAA,EAAmB,CAAA,EAAG,GAAG,WAAW,CAAA,EAAG,cAAc,CAAA,CAAE,CAAA;AAEpE,MAAA,MAAM,UAAA,GAAa,KAAA,CAAM,IAAA,CAAK,IAAI,CAAA;AAClC,MAAA,MAAMA,mBAAA,CAAG,SAAA,CAAU,gBAAA,EAAkB,UAAA,EAAY,MAAM,CAAA;AAAA,IACzD;AAAA,EACF,CAAC,CAAA;AACH;;;;"}

package/dist/lib/execution/writeTemplateContents.cjs.js

@@ -0,0 +1,116 @@
+'use strict';
+
+var fs = require('fs-extra');
+var path = require('node:path');
+var errors = require('@backstage/errors');
+var cliNode = require('@backstage/cli-node');
+var PortableTemplater = require('./PortableTemplater.cjs.js');
+var cliCommon = require('@backstage/cli-common');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+
+async function writeTemplateContents(template, input) {
+  const targetDir = cliCommon.targetPaths.resolveRoot(input.packagePath);
+  if (await fs__default.default.pathExists(targetDir)) {
+    throw new errors.InputError(`Package '${input.packagePath}' already exists`);
+  }
+  try {
+    const isMonoRepo = await cliNode.isMonoRepo();
+    const { role, ...roleValues } = input.roleParams;
+    const templater = await PortableTemplater.PortableTemplater.create({
+      values: {
+        ...roleValues,
+        packageName: input.packageName
+      },
+      templatedValues: template.values
+    });
+    if (!isMonoRepo) {
+      await fs__default.default.writeJson(
+        path.resolve(targetDir, "tsconfig.json"),
+        {
+          extends: "@backstage/cli/config/tsconfig.json",
+          include: ["src", "dev", "migrations"],
+          exclude: ["node_modules"],
+          compilerOptions: {
+            outDir: "dist-types",
+            rootDir: "."
+          }
+        },
+        { spaces: 2 }
+      );
+    }
+    for (const file of template.files) {
+      const destPath = path.resolve(targetDir, templater.template(file.path));
+      if (!cliCommon.isChildPath(targetDir, destPath)) {
+        throw new Error(
+          `Path ${destPath} is outside of target directory ${targetDir}`
+        );
+      }
+      await fs__default.default.ensureDir(path.dirname(destPath));
+      let content = file.syntax === "handlebars" ? templater.template(file.content) : file.content;
+      if (file.path === "package.json") {
+        try {
+          content = injectPackageJsonInput(input, content);
+        } catch (error) {
+          throw new errors.ForwardedError(
+            "Failed to transform templated package.json",
+            error
+          );
+        }
+      }
+      await fs__default.default.writeFile(destPath, content).catch((error) => {
+        throw new errors.ForwardedError(`Failed to copy file to ${destPath}`, error);
+      });
+    }
+    return { targetDir };
+  } catch (error) {
+    await fs__default.default.rm(targetDir, { recursive: true, force: true, maxRetries: 10 });
+    throw error;
+  }
+}
+function injectPackageJsonInput(input, content) {
+  const pkgJson = JSON.parse(content);
+  const toAdd = new Array();
+  if (pkgJson.version) {
+    pkgJson.version = input.version;
+  } else {
+    toAdd.push(["version", input.version]);
+  }
+  if (pkgJson.license) {
+    pkgJson.license = input.license;
+  } else {
+    toAdd.push(["license", input.license]);
+  }
+  if (input.private) {
+    if (pkgJson.private === false) {
+      pkgJson.private = true;
+    } else if (!pkgJson.private) {
+      toAdd.push(["private", true]);
+    }
+  } else {
+    delete pkgJson.private;
+  }
+  if (input.publishRegistry) {
+    if (pkgJson.publishConfig) {
+      pkgJson.publishConfig = {
+        ...pkgJson.publishConfig,
+        registry: input.publishRegistry
+      };
+    } else {
+      toAdd.push(["publishConfig", { registry: input.publishRegistry }]);
+    }
+  }
+  const entries = Object.entries(pkgJson);
+  const nameIndex = entries.findIndex(([name]) => name === "name");
+  if (nameIndex === -1) {
+    throw new Error("templated package.json does not contain a name field");
+  }
+  entries.splice(nameIndex + 1, 0, ...toAdd);
+  return JSON.stringify(Object.fromEntries(entries), null, 2);
+}
+
+exports.injectPackageJsonInput = injectPackageJsonInput;
+exports.writeTemplateContents = writeTemplateContents;
+//# sourceMappingURL=writeTemplateContents.cjs.js.map

package/dist/lib/execution/writeTemplateContents.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"writeTemplateContents.cjs.js","sources":["../../../src/lib/execution/writeTemplateContents.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport fs from 'fs-extra';\nimport { dirname, resolve as resolvePath } from 'node:path';\n\nimport { PortableTemplate, PortableTemplateInput } from '../types';\nimport { ForwardedError, InputError } from '@backstage/errors';\nimport { isMonoRepo as getIsMonoRepo } from '@backstage/cli-node';\nimport { PortableTemplater } from './PortableTemplater';\nimport { isChildPath, targetPaths } from '@backstage/cli-common';\n\nexport async function writeTemplateContents(\n  template: PortableTemplate,\n  input: PortableTemplateInput,\n): Promise<{ targetDir: string }> {\n  const targetDir = targetPaths.resolveRoot(input.packagePath);\n\n  if (await fs.pathExists(targetDir)) {\n    throw new InputError(`Package '${input.packagePath}' already exists`);\n  }\n\n  try {\n    const isMonoRepo = await getIsMonoRepo();\n\n    const { role, ...roleValues } = input.roleParams;\n\n    const templater = await PortableTemplater.create({\n      values: {\n        ...roleValues,\n        packageName: input.packageName,\n      },\n      templatedValues: template.values,\n    });\n\n    if (!isMonoRepo) {\n      await fs.writeJson(\n        resolvePath(targetDir, 'tsconfig.json'),\n        {\n          extends: '@backstage/cli/config/tsconfig.json',\n          include: ['src', 'dev', 'migrations'],\n          exclude: ['node_modules'],\n          compilerOptions: {\n            outDir: 'dist-types',\n            rootDir: '.',\n          },\n        },\n        { spaces: 2 },\n      );\n    }\n\n    for (const file of template.files) {\n      const destPath = resolvePath(targetDir, templater.template(file.path));\n      if (!isChildPath(targetDir, destPath)) {\n        throw new Error(\n          `Path ${destPath} is outside of target directory ${targetDir}`,\n        );\n      }\n      await fs.ensureDir(dirname(destPath));\n\n      let content =\n        file.syntax === 'handlebars'\n          ? templater.template(file.content)\n          : file.content;\n\n      // Automatically inject input values into package.json\n      if (file.path === 'package.json') {\n        try {\n          content = injectPackageJsonInput(input, content);\n        } catch (error) {\n          throw new ForwardedError(\n            'Failed to transform templated package.json',\n            error,\n          );\n        }\n      }\n\n      await fs.writeFile(destPath, content).catch(error => {\n        throw new ForwardedError(`Failed to copy file to ${destPath}`, error);\n      });\n    }\n\n    return { targetDir };\n  } catch (error) {\n    await fs.rm(targetDir, { recursive: true, force: true, maxRetries: 10 });\n    throw error;\n  }\n}\n\nexport function injectPackageJsonInput(\n  input: PortableTemplateInput,\n  content: string,\n) {\n  const pkgJson = JSON.parse(content);\n\n  const toAdd = new Array<[name: string, value: unknown]>();\n\n  if (pkgJson.version) {\n    pkgJson.version = input.version;\n  } else {\n    toAdd.push(['version', input.version]);\n  }\n  if (pkgJson.license) {\n    pkgJson.license = input.license;\n  } else {\n    toAdd.push(['license', input.license]);\n  }\n  if (input.private) {\n    if (pkgJson.private === false) {\n      pkgJson.private = true;\n    } else if (!pkgJson.private) {\n      toAdd.push(['private', true]);\n    }\n  } else {\n    delete pkgJson.private;\n  }\n\n  if (input.publishRegistry) {\n    if (pkgJson.publishConfig) {\n      pkgJson.publishConfig = {\n        ...pkgJson.publishConfig,\n        registry: input.publishRegistry,\n      };\n    } else {\n      toAdd.push(['publishConfig', { registry: input.publishRegistry }]);\n    }\n  }\n\n  const entries = Object.entries(pkgJson);\n\n  const nameIndex = entries.findIndex(([name]) => name === 'name');\n  if (nameIndex === -1) {\n    throw new Error('templated package.json does not contain a name field');\n  }\n\n  entries.splice(nameIndex + 1, 0, ...toAdd);\n\n  return JSON.stringify(Object.fromEntries(entries), null, 2);\n}\n"],"names":["targetPaths","fs","InputError","getIsMonoRepo","PortableTemplater","resolvePath","isChildPath","dirname","ForwardedError"],"mappings":";;;;;;;;;;;;;AAyBA,eAAsB,qBAAA,CACpB,UACA,KAAA,EACgC;AAChC,EAAA,MAAM,SAAA,GAAYA,qBAAA,CAAY,WAAA,CAAY,KAAA,CAAM,WAAW,CAAA;AAE3D,EAAA,IAAI,MAAMC,mBAAA,CAAG,UAAA,CAAW,SAAS,CAAA,EAAG;AAClC,IAAA,MAAM,IAAIC,iBAAA,CAAW,CAAA,SAAA,EAAY,KAAA,CAAM,WAAW,CAAA,gBAAA,CAAkB,CAAA;AAAA,EACtE;AAEA,EAAA,IAAI;AACF,IAAA,MAAM,UAAA,GAAa,MAAMC,kBAAA,EAAc;AAEvC,IAAA,MAAM,EAAE,IAAA,EAAM,GAAG,UAAA,KAAe,KAAA,CAAM,UAAA;AAEtC,IAAA,MAAM,SAAA,GAAY,MAAMC,mCAAA,CAAkB,MAAA,CAAO;AAAA,MAC/C,MAAA,EAAQ;AAAA,QACN,GAAG,UAAA;AAAA,QACH,aAAa,KAAA,CAAM;AAAA,OACrB;AAAA,MACA,iBAAiB,QAAA,CAAS;AAAA,KAC3B,CAAA;AAED,IAAA,IAAI,CAAC,UAAA,EAAY;AACf,MAAA,MAAMH,mBAAA,CAAG,SAAA;AAAA,QACPI,YAAA,CAAY,WAAW,eAAe,CAAA;AAAA,QACtC;AAAA,UACE,OAAA,EAAS,qCAAA;AAAA,UACT,OAAA,EAAS,CAAC,KAAA,EAAO,KAAA,EAAO,YAAY,CAAA;AAAA,UACpC,OAAA,EAAS,CAAC,cAAc,CAAA;AAAA,UACxB,eAAA,EAAiB;AAAA,YACf,MAAA,EAAQ,YAAA;AAAA,YACR,OAAA,EAAS;AAAA;AACX,SACF;AAAA,QACA,EAAE,QAAQ,CAAA;AAAE,OACd;AAAA,IACF;AAEA,IAAA,KAAA,MAAW,IAAA,IAAQ,SAAS,KAAA,EAAO;AACjC,MAAA,MAAM,WAAWA,YAAA,CAAY,SAAA,EAAW,UAAU,QAAA,CAAS,IAAA,CAAK,IAAI,CAAC,CAAA;AACrE,MAAA,IAAI,CAACC,qBAAA,CAAY,SAAA,EAAW,QAAQ,CAAA,EAAG;AACrC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,KAAA,EAAQ,QAAQ,CAAA,gCAAA,EAAmC,SAAS,CAAA;AAAA,SAC9D;AAAA,MACF;AACA,MAAA,MAAML,mBAAA,CAAG,SAAA,CAAUM,YAAA,CAAQ,QAAQ,CAAC,CAAA;AAEpC,MAAA,IAAI,OAAA,GACF,KAAK,MAAA,KAAW,YAAA,GACZ,UAAU,QAAA,CAAS,IAAA,CAAK,OAAO,CAAA,GAC/B,IAAA,CAAK,OAAA;AAGX,MAAA,IAAI,IAAA,CAAK,SAAS,cAAA,EAAgB;AAChC,QAAA,IAAI;AACF,UAAA,OAAA,GAAU,sBAAA,CAAuB,OAAO,OAAO,CAAA;AAAA,QACjD,SAAS,KAAA,EAAO;AACd,UAAA,MAAM,IAAIC,qBAAA;AAAA,YACR,4CAAA;AAAA,YACA;AAAA,WACF;AAAA,QACF;AAAA,MACF;AAEA,MAAA,MAAMP,oBAAG,SAAA,CAAU,QAAA,EAAU,OAAO,CAAA,CAAE,MAAM,CAAA,KAAA,KAAS;AACnD,QAAA,MAAM,IAAIO,qBAAA,CAAe,CAAA,uBAAA,EAA0B,QAAQ,IAAI,KAAK,CAAA;AAAA,MACtE,CAAC,CAAA;AAAA,IACH;AAEA,IAAA,OAAO,EAAE,SAAA,EAAU;AAAA,EACrB,SAAS,KAAA,EAAO;AACd,IAAA,MAAMP,mBAAA,CAAG,EAAA,CAAG,SAAA,EAAW,EAAE,SAAA,EAAW,MAAM,KAAA,EAAO,IAAA,EAAM,UAAA,EAAY,EAAA,EAAI,CAAA;AACvE,IAAA,MAAM,KAAA;AAAA,EACR;AACF;AAEO,SAAS,sBAAA,CACd,OACA,OAAA,EACA;AACA,EAAA,MAAM,OAAA,GAAU,IAAA,CAAK,KAAA,CAAM,OAAO,CAAA;AAElC,EAAA,MAAM,KAAA,GAAQ,IAAI,KAAA,EAAsC;AAExD,EAAA,IAAI,QAAQ,OAAA,EAAS;AACnB,IAAA,OAAA,CAAQ,UAAU,KAAA,CAAM,OAAA;AAAA,EAC1B,CAAA,MAAO;AACL,IAAA,KAAA,CAAM,IAAA,CAAK,CAAC,SAAA,EAAW,KAAA,CAAM,OAAO,CAAC,CAAA;AAAA,EACvC;AACA,EAAA,IAAI,QAAQ,OAAA,EAAS;AACnB,IAAA,OAAA,CAAQ,UAAU,KAAA,CAAM,OAAA;AAAA,EAC1B,CAAA,MAAO;AACL,IAAA,KAAA,CAAM,IAAA,CAAK,CAAC,SAAA,EAAW,KAAA,CAAM,OAAO,CAAC,CAAA;AAAA,EACvC;AACA,EAAA,IAAI,MAAM,OAAA,EAAS;AACjB,IAAA,IAAI,OAAA,CAAQ,YAAY,KAAA,EAAO;AAC7B,MAAA,OAAA,CAAQ,OAAA,GAAU,IAAA;AAAA,IACpB,CAAA,MAAA,IAAW,CAAC,OAAA,CAAQ,OAAA,EAAS;AAC3B,MAAA,KAAA,CAAM,IAAA,CAAK,CAAC,SAAA,EAAW,IAAI,CAAC,CAAA;AAAA,IAC9B;AAAA,EACF,CAAA,MAAO;AACL,IAAA,OAAO,OAAA,CAAQ,OAAA;AAAA,EACjB;AAEA,EAAA,IAAI,MAAM,eAAA,EAAiB;AACzB,IAAA,IAAI,QAAQ,aAAA,EAAe;AACzB,MAAA,OAAA,CAAQ,aAAA,GAAgB;AAAA,QACtB,GAAG,OAAA,CAAQ,aAAA;AAAA,QACX,UAAU,KAAA,CAAM;AAAA,OAClB;AAAA,IACF,CAAA,MAAO;AACL,MAAA,KAAA,CAAM,IAAA,CAAK,CAAC,eAAA,EAAiB,EAAE,UAAU,KAAA,CAAM,eAAA,EAAiB,CAAC,CAAA;AAAA,IACnE;AAAA,EACF;AAEA,EAAA,MAAM,OAAA,GAAU,MAAA,CAAO,OAAA,CAAQ,OAAO,CAAA;AAEtC,EAAA,MAAM,SAAA,GAAY,QAAQ,SAAA,CAAU,CAAC,CAAC,IAAI,CAAA,KAAM,SAAS,MAAM,CAAA;AAC/D,EAAA,IAAI,cAAc,EAAA,EAAI;AACpB,IAAA,MAAM,IAAI,MAAM,sDAAsD,CAAA;AAAA,EACxE;AAEA,EAAA,OAAA,CAAQ,MAAA,CAAO,SAAA,GAAY,CAAA,EAAG,CAAA,EAAG,GAAG,KAAK,CAAA;AAEzC,EAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAAO,YAAY,OAAO,CAAA,EAAG,MAAM,CAAC,CAAA;AAC5D;;;;;"}

package/dist/lib/preparation/collectPortableTemplateInput.cjs.js

@@ -0,0 +1,157 @@
+'use strict';
+
+var inquirer = require('inquirer');
+var codeowners = require('../codeowners/codeowners.cjs.js');
+var cliCommon = require('@backstage/cli-common');
+var resolvePackageParams = require('./resolvePackageParams.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var inquirer__default = /*#__PURE__*/_interopDefaultCompat(inquirer);
+
+async function collectPortableTemplateInput(options) {
+  const { config, template, prefilledParams } = options;
+  const codeOwnersFilePath = await codeowners.getCodeownersFilePath(cliCommon.targetPaths.rootDir);
+  const prompts = getPromptsForRole(template.role);
+  if (codeOwnersFilePath) {
+    prompts.push(ownerPrompt());
+  }
+  const deprecatedParams = {};
+  if (config.isUsingDefaultTemplates && prefilledParams.id) {
+    console.warn(
+      `DEPRECATION WARNING: The 'id' parameter is deprecated, use 'pluginId' instead`
+    );
+    deprecatedParams.pluginId = prefilledParams.id;
+  }
+  const parameters = {
+    ...template.values,
+    ...prefilledParams,
+    ...deprecatedParams
+  };
+  const needsAnswer = [];
+  const prefilledAnswers = {};
+  for (const prompt of prompts) {
+    if (prompt.name && parameters[prompt.name] !== void 0) {
+      prefilledAnswers[prompt.name] = parameters[prompt.name];
+    } else {
+      needsAnswer.push(prompt);
+    }
+  }
+  const promptAnswers = await inquirer__default.default.prompt(
+    needsAnswer
+  );
+  const answers = {
+    ...prefilledAnswers,
+    ...promptAnswers
+  };
+  const roleParams = {
+    role: template.role,
+    name: answers.name,
+    pluginId: answers.pluginId,
+    moduleId: answers.moduleId
+  };
+  const packageParams = resolvePackageParams.resolvePackageParams({
+    roleParams,
+    packagePrefix: config.packageNamePrefix,
+    pluginInfix: config.packageNamePluginInfix
+  });
+  return {
+    roleParams,
+    owner: answers.owner,
+    license: config.license,
+    version: config.version,
+    private: config.private,
+    publishRegistry: config.publishRegistry,
+    packageName: packageParams.packageName,
+    packagePath: packageParams.packagePath
+  };
+}
+function namePrompt() {
+  return {
+    type: "input",
+    name: "name",
+    message: "Enter the name of the package, without scope [required]",
+    validate: (value) => {
+      if (!value) {
+        return "Please enter the name of the package";
+      } else if (!/^[a-z0-9]+(-[a-z0-9]+)*$/.test(value)) {
+        return "Package names must be lowercase and contain only letters, digits, and dashes.";
+      }
+      return true;
+    }
+  };
+}
+function pluginIdPrompt() {
+  return {
+    type: "input",
+    name: "pluginId",
+    message: "Enter the ID of the plugin [required]",
+    validate: (value) => {
+      if (!value) {
+        return "Please enter the ID of the plugin";
+      } else if (!/^[a-z0-9]+(-[a-z0-9]+)*$/.test(value)) {
+        return "Plugin IDs must be lowercase and contain only letters, digits, and dashes.";
+      }
+      return true;
+    }
+  };
+}
+function moduleIdIdPrompt() {
+  return {
+    type: "input",
+    name: "moduleId",
+    message: "Enter the ID of the module [required]",
+    validate: (value) => {
+      if (!value) {
+        return "Please enter the ID of the module";
+      } else if (!/^[a-z0-9]+(-[a-z0-9]+)*$/.test(value)) {
+        return "Module IDs must be lowercase and contain only letters, digits, and dashes.";
+      }
+      return true;
+    }
+  };
+}
+function getPromptsForRole(role) {
+  switch (role) {
+    case "web-library":
+    case "node-library":
+    case "common-library":
+      return [namePrompt()];
+    case "plugin-web-library":
+    case "plugin-node-library":
+    case "plugin-common-library":
+    case "frontend-plugin":
+    case "backend-plugin":
+      return [pluginIdPrompt()];
+    case "frontend-plugin-module":
+    case "backend-plugin-module":
+      return [pluginIdPrompt(), moduleIdIdPrompt()];
+    default:
+      return [];
+  }
+}
+function ownerPrompt() {
+  return {
+    type: "input",
+    name: "owner",
+    message: "Enter an owner to add to CODEOWNERS [optional]",
+    validate: (value) => {
+      if (!value) {
+        return true;
+      }
+      const ownerIds = codeowners.parseOwnerIds(value);
+      if (!ownerIds) {
+        return "The owner must be a space separated list of team names (e.g. @org/team-name), usernames (e.g. @username), or the email addresses (e.g. user@example.com).";
+      }
+      return true;
+    }
+  };
+}
+
+exports.collectPortableTemplateInput = collectPortableTemplateInput;
+exports.getPromptsForRole = getPromptsForRole;
+exports.moduleIdIdPrompt = moduleIdIdPrompt;
+exports.namePrompt = namePrompt;
+exports.ownerPrompt = ownerPrompt;
+exports.pluginIdPrompt = pluginIdPrompt;
+//# sourceMappingURL=collectPortableTemplateInput.cjs.js.map

package/dist/lib/preparation/collectPortableTemplateInput.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collectPortableTemplateInput.cjs.js","sources":["../../../src/lib/preparation/collectPortableTemplateInput.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport inquirer, { DistinctQuestion } from 'inquirer';\nimport { getCodeownersFilePath, parseOwnerIds } from '../codeowners';\nimport { targetPaths } from '@backstage/cli-common';\n\nimport {\n  PortableTemplateConfig,\n  PortableTemplateInput,\n  PortableTemplateInputRoleParams,\n  PortableTemplateParams,\n  PortableTemplateRole,\n} from '../types';\nimport { PortableTemplate } from '../types';\nimport { resolvePackageParams } from './resolvePackageParams';\n\ntype CollectTemplateParamsOptions = {\n  config: PortableTemplateConfig;\n  template: PortableTemplate;\n  prefilledParams: PortableTemplateParams;\n};\n\nexport async function collectPortableTemplateInput(\n  options: CollectTemplateParamsOptions,\n): Promise<PortableTemplateInput> {\n  const { config, template, prefilledParams } = options;\n\n  const codeOwnersFilePath = await getCodeownersFilePath(targetPaths.rootDir);\n\n  const prompts = getPromptsForRole(template.role);\n\n  if (codeOwnersFilePath) {\n    prompts.push(ownerPrompt());\n  }\n\n  const deprecatedParams: PortableTemplateParams = {};\n  if (config.isUsingDefaultTemplates && prefilledParams.id) {\n    console.warn(\n      `DEPRECATION WARNING: The 'id' parameter is deprecated, use 'pluginId' instead`,\n    );\n    deprecatedParams.pluginId = prefilledParams.id;\n  }\n\n  const parameters = {\n    ...template.values,\n    ...prefilledParams,\n    ...deprecatedParams,\n  };\n\n  const needsAnswer = [];\n  const prefilledAnswers = {} as PortableTemplateParams;\n  for (const prompt of prompts) {\n    if (prompt.name && parameters[prompt.name] !== undefined) {\n      prefilledAnswers[prompt.name] = parameters[prompt.name];\n    } else {\n      needsAnswer.push(prompt);\n    }\n  }\n\n  const promptAnswers = await inquirer.prompt<PortableTemplateParams>(\n    needsAnswer,\n  );\n\n  const answers = {\n    ...prefilledAnswers,\n    ...promptAnswers,\n  };\n\n  const roleParams = {\n    role: template.role,\n    name: answers.name,\n    pluginId: answers.pluginId,\n    moduleId: answers.moduleId,\n  } as PortableTemplateInputRoleParams;\n\n  const packageParams = resolvePackageParams({\n    roleParams,\n    packagePrefix: config.packageNamePrefix,\n    pluginInfix: config.packageNamePluginInfix,\n  });\n\n  return {\n    roleParams,\n    owner: answers.owner as string | undefined,\n    license: config.license,\n    version: config.version,\n    private: config.private,\n    publishRegistry: config.publishRegistry,\n    packageName: packageParams.packageName,\n    packagePath: packageParams.packagePath,\n  };\n}\n\nexport function namePrompt(): DistinctQuestion {\n  return {\n    type: 'input',\n    name: 'name',\n    message: 'Enter the name of the package, without scope [required]',\n    validate: (value: string) => {\n      if (!value) {\n        return 'Please enter the name of the package';\n      } else if (!/^[a-z0-9]+(-[a-z0-9]+)*$/.test(value)) {\n        return 'Package names must be lowercase and contain only letters, digits, and dashes.';\n      }\n      return true;\n    },\n  };\n}\n\nexport function pluginIdPrompt(): DistinctQuestion {\n  return {\n    type: 'input',\n    name: 'pluginId',\n    message: 'Enter the ID of the plugin [required]',\n    validate: (value: string) => {\n      if (!value) {\n        return 'Please enter the ID of the plugin';\n      } else if (!/^[a-z0-9]+(-[a-z0-9]+)*$/.test(value)) {\n        return 'Plugin IDs must be lowercase and contain only letters, digits, and dashes.';\n      }\n      return true;\n    },\n  };\n}\n\nexport function moduleIdIdPrompt(): DistinctQuestion {\n  return {\n    type: 'input',\n    name: 'moduleId',\n    message: 'Enter the ID of the module [required]',\n    validate: (value: string) => {\n      if (!value) {\n        return 'Please enter the ID of the module';\n      } else if (!/^[a-z0-9]+(-[a-z0-9]+)*$/.test(value)) {\n        return 'Module IDs must be lowercase and contain only letters, digits, and dashes.';\n      }\n      return true;\n    },\n  };\n}\n\nexport function getPromptsForRole(\n  role: PortableTemplateRole,\n): Array<DistinctQuestion> {\n  switch (role) {\n    case 'web-library':\n    case 'node-library':\n    case 'common-library':\n      return [namePrompt()];\n    case 'plugin-web-library':\n    case 'plugin-node-library':\n    case 'plugin-common-library':\n    case 'frontend-plugin':\n    case 'backend-plugin':\n      return [pluginIdPrompt()];\n    case 'frontend-plugin-module':\n    case 'backend-plugin-module':\n      return [pluginIdPrompt(), moduleIdIdPrompt()];\n    default:\n      return [];\n  }\n}\n\nexport function ownerPrompt(): DistinctQuestion {\n  return {\n    type: 'input',\n    name: 'owner',\n    message: 'Enter an owner to add to CODEOWNERS [optional]',\n    validate: (value: string) => {\n      if (!value) {\n        return true;\n      }\n\n      const ownerIds = parseOwnerIds(value);\n      if (!ownerIds) {\n        return 'The owner must be a space separated list of team names (e.g. @org/team-name), usernames (e.g. @username), or the email addresses (e.g. user@example.com).';\n      }\n\n      return true;\n    },\n  };\n}\n"],"names":["getCodeownersFilePath","targetPaths","inquirer","resolvePackageParams","parseOwnerIds"],"mappings":";;;;;;;;;;;AAoCA,eAAsB,6BACpB,OAAA,EACgC;AAChC,EAAA,MAAM,EAAE,MAAA,EAAQ,QAAA,EAAU,eAAA,EAAgB,GAAI,OAAA;AAE9C,EAAA,MAAM,kBAAA,GAAqB,MAAMA,gCAAA,CAAsBC,qBAAA,CAAY,OAAO,CAAA;AAE1E,EAAA,MAAM,OAAA,GAAU,iBAAA,CAAkB,QAAA,CAAS,IAAI,CAAA;AAE/C,EAAA,IAAI,kBAAA,EAAoB;AACtB,IAAA,OAAA,CAAQ,IAAA,CAAK,aAAa,CAAA;AAAA,EAC5B;AAEA,EAAA,MAAM,mBAA2C,EAAC;AAClD,EAAA,IAAI,MAAA,CAAO,uBAAA,IAA2B,eAAA,CAAgB,EAAA,EAAI;AACxD,IAAA,OAAA,CAAQ,IAAA;AAAA,MACN,CAAA,6EAAA;AAAA,KACF;AACA,IAAA,gBAAA,CAAiB,WAAW,eAAA,CAAgB,EAAA;AAAA,EAC9C;AAEA,EAAA,MAAM,UAAA,GAAa;AAAA,IACjB,GAAG,QAAA,CAAS,MAAA;AAAA,IACZ,GAAG,eAAA;AAAA,IACH,GAAG;AAAA,GACL;AAEA,EAAA,MAAM,cAAc,EAAC;AACrB,EAAA,MAAM,mBAAmB,EAAC;AAC1B,EAAA,KAAA,MAAW,UAAU,OAAA,EAAS;AAC5B,IAAA,IAAI,OAAO,IAAA,IAAQ,UAAA,CAAW,MAAA,CAAO,IAAI,MAAM,MAAA,EAAW;AACxD,MAAA,gBAAA,CAAiB,MAAA,CAAO,IAAI,CAAA,GAAI,UAAA,CAAW,OAAO,IAAI,CAAA;AAAA,IACxD,CAAA,MAAO;AACL,MAAA,WAAA,CAAY,KAAK,MAAM,CAAA;AAAA,IACzB;AAAA,EACF;AAEA,EAAA,MAAM,aAAA,GAAgB,MAAMC,yBAAA,CAAS,MAAA;AAAA,IACnC;AAAA,GACF;AAEA,EAAA,MAAM,OAAA,GAAU;AAAA,IACd,GAAG,gBAAA;AAAA,IACH,GAAG;AAAA,GACL;AAEA,EAAA,MAAM,UAAA,GAAa;AAAA,IACjB,MAAM,QAAA,CAAS,IAAA;AAAA,IACf,MAAM,OAAA,CAAQ,IAAA;AAAA,IACd,UAAU,OAAA,CAAQ,QAAA;AAAA,IAClB,UAAU,OAAA,CAAQ;AAAA,GACpB;AAEA,EAAA,MAAM,gBAAgBC,yCAAA,CAAqB;AAAA,IACzC,UAAA;AAAA,IACA,eAAe,MAAA,CAAO,iBAAA;AAAA,IACtB,aAAa,MAAA,CAAO;AAAA,GACrB,CAAA;AAED,EAAA,OAAO;AAAA,IACL,UAAA;AAAA,IACA,OAAO,OAAA,CAAQ,KAAA;AAAA,IACf,SAAS,MAAA,CAAO,OAAA;AAAA,IAChB,SAAS,MAAA,CAAO,OAAA;AAAA,IAChB,SAAS,MAAA,CAAO,OAAA;AAAA,IAChB,iBAAiB,MAAA,CAAO,eAAA;AAAA,IACxB,aAAa,aAAA,CAAc,WAAA;AAAA,IAC3B,aAAa,aAAA,CAAc;AAAA,GAC7B;AACF;AAEO,SAAS,UAAA,GAA+B;AAC7C,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,OAAA;AAAA,IACN,IAAA,EAAM,MAAA;AAAA,IACN,OAAA,EAAS,yDAAA;AAAA,IACT,QAAA,EAAU,CAAC,KAAA,KAAkB;AAC3B,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,OAAO,sCAAA;AAAA,MACT,CAAA,MAAA,IAAW,CAAC,0BAAA,CAA2B,IAAA,CAAK,KAAK,CAAA,EAAG;AAClD,QAAA,OAAO,+EAAA;AAAA,MACT;AACA,MAAA,OAAO,IAAA;AAAA,IACT;AAAA,GACF;AACF;AAEO,SAAS,cAAA,GAAmC;AACjD,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,OAAA;AAAA,IACN,IAAA,EAAM,UAAA;AAAA,IACN,OAAA,EAAS,uCAAA;AAAA,IACT,QAAA,EAAU,CAAC,KAAA,KAAkB;AAC3B,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,OAAO,mCAAA;AAAA,MACT,CAAA,MAAA,IAAW,CAAC,0BAAA,CAA2B,IAAA,CAAK,KAAK,CAAA,EAAG;AAClD,QAAA,OAAO,4EAAA;AAAA,MACT;AACA,MAAA,OAAO,IAAA;AAAA,IACT;AAAA,GACF;AACF;AAEO,SAAS,gBAAA,GAAqC;AACnD,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,OAAA;AAAA,IACN,IAAA,EAAM,UAAA;AAAA,IACN,OAAA,EAAS,uCAAA;AAAA,IACT,QAAA,EAAU,CAAC,KAAA,KAAkB;AAC3B,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,OAAO,mCAAA;AAAA,MACT,CAAA,MAAA,IAAW,CAAC,0BAAA,CAA2B,IAAA,CAAK,KAAK,CAAA,EAAG;AAClD,QAAA,OAAO,4EAAA;AAAA,MACT;AACA,MAAA,OAAO,IAAA;AAAA,IACT;AAAA,GACF;AACF;AAEO,SAAS,kBACd,IAAA,EACyB;AACzB,EAAA,QAAQ,IAAA;AAAM,IACZ,KAAK,aAAA;AAAA,IACL,KAAK,cAAA;AAAA,IACL,KAAK,gBAAA;AACH,MAAA,OAAO,CAAC,YAAY,CAAA;AAAA,IACtB,KAAK,oBAAA;AAAA,IACL,KAAK,qBAAA;AAAA,IACL,KAAK,uBAAA;AAAA,IACL,KAAK,iBAAA;AAAA,IACL,KAAK,gBAAA;AACH,MAAA,OAAO,CAAC,gBAAgB,CAAA;AAAA,IAC1B,KAAK,wBAAA;AAAA,IACL,KAAK,uBAAA;AACH,MAAA,OAAO,CAAC,cAAA,EAAe,EAAG,gBAAA,EAAkB,CAAA;AAAA,IAC9C;AACE,MAAA,OAAO,EAAC;AAAA;AAEd;AAEO,SAAS,WAAA,GAAgC;AAC9C,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,OAAA;AAAA,IACN,IAAA,EAAM,OAAA;AAAA,IACN,OAAA,EAAS,gDAAA;AAAA,IACT,QAAA,EAAU,CAAC,KAAA,KAAkB;AAC3B,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,OAAO,IAAA;AAAA,MACT;AAEA,MAAA,MAAM,QAAA,GAAWC,yBAAc,KAAK,CAAA;AACpC,MAAA,IAAI,CAAC,QAAA,EAAU;AACb,QAAA,OAAO,2JAAA;AAAA,MACT;AAEA,MAAA,OAAO,IAAA;AAAA,IACT;AAAA,GACF;AACF;;;;;;;;;"}

package/dist/lib/preparation/loadPortableTemplate.cjs.js

@@ -0,0 +1,81 @@
+'use strict';
+
+var zod = require('zod');
+var fs = require('fs-extra');
+var recursiveReaddir = require('recursive-readdir');
+var path = require('node:path');
+var yaml = require('yaml');
+var cliCommon = require('@backstage/cli-common');
+var types = require('../types.cjs.js');
+var errors = require('@backstage/errors');
+var v3 = require('zod-validation-error/v3');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+var recursiveReaddir__default = /*#__PURE__*/_interopDefaultCompat(recursiveReaddir);
+
+const templateDefinitionSchema = zod.z.object({
+  name: zod.z.string(),
+  role: zod.z.enum(types.TEMPLATE_ROLES),
+  description: zod.z.string().optional(),
+  values: zod.z.record(zod.z.string()).optional()
+}).strict();
+async function loadPortableTemplate(pointer) {
+  if (pointer.target.match(/https?:\/\//)) {
+    throw new Error("Remote templates are not supported yet");
+  }
+  const templateContent = await fs__default.default.readFile(cliCommon.targetPaths.resolveRoot(pointer.target), "utf-8").catch((error) => {
+    throw new errors.ForwardedError(
+      `Failed to load template definition from '${pointer.target}'`,
+      error
+    );
+  });
+  const rawTemplate = yaml.parse(templateContent);
+  const parsed = templateDefinitionSchema.safeParse(rawTemplate);
+  if (!parsed.success) {
+    throw new errors.ForwardedError(
+      `Invalid template definition at '${pointer.target}'`,
+      v3.fromZodError(parsed.error)
+    );
+  }
+  const { role, values = {} } = parsed.data;
+  const templatePath = path.resolve(path.dirname(pointer.target));
+  const filePaths = await recursiveReaddir__default.default(templatePath).catch((error) => {
+    throw new errors.ForwardedError(
+      `Failed to load template contents from '${templatePath}'`,
+      error
+    );
+  });
+  const loadedFiles = new Array();
+  for (const filePath of filePaths) {
+    const path$1 = path.relative(templatePath, filePath);
+    if (filePath === pointer.target) {
+      continue;
+    }
+    const content = await fs__default.default.readFile(filePath, "utf-8").catch((error) => {
+      throw new errors.ForwardedError(
+        `Failed to load file contents from '${path$1}'`,
+        error
+      );
+    });
+    if (path$1.endsWith(".hbs")) {
+      loadedFiles.push({
+        path: path$1.slice(0, -4),
+        content,
+        syntax: "handlebars"
+      });
+    } else {
+      loadedFiles.push({ path: path$1, content });
+    }
+  }
+  return {
+    name: pointer.name,
+    role,
+    files: loadedFiles,
+    values
+  };
+}
+
+exports.loadPortableTemplate = loadPortableTemplate;
+//# sourceMappingURL=loadPortableTemplate.cjs.js.map

package/dist/lib/preparation/loadPortableTemplate.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadPortableTemplate.cjs.js","sources":["../../../src/lib/preparation/loadPortableTemplate.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { z } from 'zod';\nimport fs from 'fs-extra';\nimport recursiveReaddir from 'recursive-readdir';\nimport { resolve as resolvePath, relative as relativePath } from 'node:path';\nimport { dirname } from 'node:path';\nimport { parse as parseYaml } from 'yaml';\nimport { targetPaths } from '@backstage/cli-common';\n\nimport {\n  PortableTemplateFile,\n  PortableTemplatePointer,\n  TEMPLATE_ROLES,\n} from '../types';\nimport { PortableTemplate } from '../types';\nimport { ForwardedError } from '@backstage/errors';\nimport { fromZodError } from 'zod-validation-error/v3';\n\nconst templateDefinitionSchema = z\n  .object({\n    name: z.string(),\n    role: z.enum(TEMPLATE_ROLES),\n    description: z.string().optional(),\n    values: z.record(z.string()).optional(),\n  })\n  .strict();\n\nexport async function loadPortableTemplate(\n  pointer: PortableTemplatePointer,\n): Promise<PortableTemplate> {\n  if (pointer.target.match(/https?:\\/\\//)) {\n    throw new Error('Remote templates are not supported yet');\n  }\n  const templateContent = await fs\n    .readFile(targetPaths.resolveRoot(pointer.target), 'utf-8')\n    .catch(error => {\n      throw new ForwardedError(\n        `Failed to load template definition from '${pointer.target}'`,\n        error,\n      );\n    });\n  const rawTemplate = parseYaml(templateContent);\n\n  const parsed = templateDefinitionSchema.safeParse(rawTemplate);\n  if (!parsed.success) {\n    throw new ForwardedError(\n      `Invalid template definition at '${pointer.target}'`,\n      fromZodError(parsed.error),\n    );\n  }\n\n  const { role, values = {} } = parsed.data;\n\n  const templatePath = resolvePath(dirname(pointer.target));\n  const filePaths = await recursiveReaddir(templatePath).catch(error => {\n    throw new ForwardedError(\n      `Failed to load template contents from '${templatePath}'`,\n      error,\n    );\n  });\n\n  const loadedFiles = new Array<PortableTemplateFile>();\n\n  for (const filePath of filePaths) {\n    const path = relativePath(templatePath, filePath);\n    if (filePath === pointer.target) {\n      continue;\n    }\n\n    const content = await fs.readFile(filePath, 'utf-8').catch(error => {\n      throw new ForwardedError(\n        `Failed to load file contents from '${path}'`,\n        error,\n      );\n    });\n\n    if (path.endsWith('.hbs')) {\n      loadedFiles.push({\n        path: path.slice(0, -4),\n        content,\n        syntax: 'handlebars',\n      });\n    } else {\n      loadedFiles.push({ path, content });\n    }\n  }\n\n  return {\n    name: pointer.name,\n    role,\n    files: loadedFiles,\n    values,\n  };\n}\n"],"names":["z","TEMPLATE_ROLES","fs","targetPaths","ForwardedError","parseYaml","fromZodError","resolvePath","dirname","recursiveReaddir","path","relativePath"],"mappings":";;;;;;;;;;;;;;;;;AAiCA,MAAM,wBAAA,GAA2BA,MAC9B,MAAA,CAAO;AAAA,EACN,IAAA,EAAMA,MAAE,MAAA,EAAO;AAAA,EACf,IAAA,EAAMA,KAAA,CAAE,IAAA,CAAKC,oBAAc,CAAA;AAAA,EAC3B,WAAA,EAAaD,KAAA,CAAE,MAAA,EAAO,CAAE,QAAA,EAAS;AAAA,EACjC,QAAQA,KAAA,CAAE,MAAA,CAAOA,MAAE,MAAA,EAAQ,EAAE,QAAA;AAC/B,CAAC,EACA,MAAA,EAAO;AAEV,eAAsB,qBACpB,OAAA,EAC2B;AAC3B,EAAA,IAAI,OAAA,CAAQ,MAAA,CAAO,KAAA,CAAM,aAAa,CAAA,EAAG;AACvC,IAAA,MAAM,IAAI,MAAM,wCAAwC,CAAA;AAAA,EAC1D;AACA,EAAA,MAAM,eAAA,GAAkB,MAAME,mBAAA,CAC3B,QAAA,CAASC,qBAAA,CAAY,WAAA,CAAY,OAAA,CAAQ,MAAM,CAAA,EAAG,OAAO,CAAA,CACzD,KAAA,CAAM,CAAA,KAAA,KAAS;AACd,IAAA,MAAM,IAAIC,qBAAA;AAAA,MACR,CAAA,yCAAA,EAA4C,QAAQ,MAAM,CAAA,CAAA,CAAA;AAAA,MAC1D;AAAA,KACF;AAAA,EACF,CAAC,CAAA;AACH,EAAA,MAAM,WAAA,GAAcC,WAAU,eAAe,CAAA;AAE7C,EAAA,MAAM,MAAA,GAAS,wBAAA,CAAyB,SAAA,CAAU,WAAW,CAAA;AAC7D,EAAA,IAAI,CAAC,OAAO,OAAA,EAAS;AACnB,IAAA,MAAM,IAAID,qBAAA;AAAA,MACR,CAAA,gCAAA,EAAmC,QAAQ,MAAM,CAAA,CAAA,CAAA;AAAA,MACjDE,eAAA,CAAa,OAAO,KAAK;AAAA,KAC3B;AAAA,EACF;AAEA,EAAA,MAAM,EAAE,IAAA,EAAM,MAAA,GAAS,EAAC,KAAM,MAAA,CAAO,IAAA;AAErC,EAAA,MAAM,YAAA,GAAeC,YAAA,CAAYC,YAAA,CAAQ,OAAA,CAAQ,MAAM,CAAC,CAAA;AACxD,EAAA,MAAM,YAAY,MAAMC,iCAAA,CAAiB,YAAY,CAAA,CAAE,MAAM,CAAA,KAAA,KAAS;AACpE,IAAA,MAAM,IAAIL,qBAAA;AAAA,MACR,0CAA0C,YAAY,CAAA,CAAA,CAAA;AAAA,MACtD;AAAA,KACF;AAAA,EACF,CAAC,CAAA;AAED,EAAA,MAAM,WAAA,GAAc,IAAI,KAAA,EAA4B;AAEpD,EAAA,KAAA,MAAW,YAAY,SAAA,EAAW;AAChC,IAAA,MAAMM,MAAA,GAAOC,aAAA,CAAa,YAAA,EAAc,QAAQ,CAAA;AAChD,IAAA,IAAI,QAAA,KAAa,QAAQ,MAAA,EAAQ;AAC/B,MAAA;AAAA,IACF;AAEA,IAAA,MAAM,OAAA,GAAU,MAAMT,mBAAA,CAAG,QAAA,CAAS,UAAU,OAAO,CAAA,CAAE,MAAM,CAAA,KAAA,KAAS;AAClE,MAAA,MAAM,IAAIE,qBAAA;AAAA,QACR,sCAAsCM,MAAI,CAAA,CAAA,CAAA;AAAA,QAC1C;AAAA,OACF;AAAA,IACF,CAAC,CAAA;AAED,IAAA,IAAIA,MAAA,CAAK,QAAA,CAAS,MAAM,CAAA,EAAG;AACzB,MAAA,WAAA,CAAY,IAAA,CAAK;AAAA,QACf,IAAA,EAAMA,MAAA,CAAK,KAAA,CAAM,CAAA,EAAG,EAAE,CAAA;AAAA,QACtB,OAAA;AAAA,QACA,MAAA,EAAQ;AAAA,OACT,CAAA;AAAA,IACH,CAAA,MAAO;AACL,MAAA,WAAA,CAAY,IAAA,CAAK,QAAEA,MAAA,EAAM,OAAA,EAAS,CAAA;AAAA,IACpC;AAAA,EACF;AAEA,EAAA,OAAO;AAAA,IACL,MAAM,OAAA,CAAQ,IAAA;AAAA,IACd,IAAA;AAAA,IACA,KAAA,EAAO,WAAA;AAAA,IACP;AAAA,GACF;AACF;;;;"}