@backstage/cli-module-new 0.1.3 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/bin/backstage-cli-module-new +2 -2
- package/dist/commands/new.cjs.js +1 -1
- package/dist/commands/new.cjs.js.map +1 -1
- package/dist/lib/defaultTemplates.cjs.js +2 -1
- package/dist/lib/defaultTemplates.cjs.js.map +1 -1
- package/dist/packages/backend-defaults/package.json.cjs.js +1 -1
- package/dist/packages/backend-plugin-api/package.json.cjs.js +1 -1
- package/dist/packages/backend-test-utils/package.json.cjs.js +1 -1
- package/dist/packages/catalog-client/package.json.cjs.js +1 -1
- package/dist/packages/cli/package.json.cjs.js +1 -1
- package/dist/packages/cli-module-new/package.json.cjs.js +2 -2
- package/dist/packages/core-app-api/package.json.cjs.js +1 -1
- package/dist/packages/core-components/package.json.cjs.js +1 -1
- package/dist/packages/core-plugin-api/package.json.cjs.js +1 -1
- package/dist/packages/dev-utils/package.json.cjs.js +1 -1
- package/dist/packages/frontend-defaults/package.json.cjs.js +1 -1
- package/dist/packages/frontend-dev-utils/package.json.cjs.js +1 -1
- package/dist/packages/frontend-plugin-api/package.json.cjs.js +1 -1
- package/dist/packages/frontend-test-utils/package.json.cjs.js +1 -1
- package/dist/packages/test-utils/package.json.cjs.js +1 -1
- package/dist/packages/ui/package.json.cjs.js +1 -1
- package/dist/plugins/auth-backend/package.json.cjs.js +1 -1
- package/dist/plugins/auth-backend-module-guest-provider/package.json.cjs.js +1 -1
- package/dist/plugins/catalog-node/package.json.cjs.js +1 -1
- package/dist/plugins/scaffolder-node/package.json.cjs.js +1 -1
- package/dist/plugins/scaffolder-node-test-utils/package.json.cjs.js +1 -1
- package/package.json +7 -7
- package/templates/cli-module/bin/{{binName}} +2 -2
- package/templates/cli-module/package.json.hbs +1 -1
- package/templates/cli-module/src/commands/example.ts +1 -1
- package/templates/scaffolder-field-extension-module/.eslintrc.js.hbs +1 -0
- package/templates/scaffolder-field-extension-module/README.md.hbs +17 -0
- package/templates/scaffolder-field-extension-module/package.json.hbs +43 -0
- package/templates/scaffolder-field-extension-module/portable-template.yaml +8 -0
- package/templates/scaffolder-field-extension-module/src/extensions/{{extensionName}}.test.tsx.hbs +23 -0
- package/templates/scaffolder-field-extension-module/src/extensions/{{extensionName}}.tsx.hbs +43 -0
- package/templates/scaffolder-field-extension-module/src/index.ts.hbs +1 -0
- package/templates/scaffolder-field-extension-module/src/module.tsx.hbs +7 -0
- package/templates/scaffolder-field-extension-module/src/setupTests.ts +1 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# @backstage/cli-module-new
|
|
2
2
|
|
|
3
|
+
## 0.1.4
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 4014819: Added a new `scaffolder-field-extension-module` template for scaffolding custom Scaffolder form field extensions via `backstage-cli new`.
|
|
8
|
+
- 696c78c: The `--help` output for commands now shows a generated usage line that lists the available flags and any positional arguments the command accepts.
|
|
9
|
+
- 2e6ffe6: Updated the standalone CLI executable to use the new CLI module runner.
|
|
10
|
+
- Updated dependencies
|
|
11
|
+
- @backstage/cli-node@0.3.3
|
|
12
|
+
|
|
13
|
+
## 0.1.4-next.0
|
|
14
|
+
|
|
15
|
+
### Patch Changes
|
|
16
|
+
|
|
17
|
+
- 4014819: Added a new `scaffolder-field-extension-module` template for scaffolding custom Scaffolder form field extensions via `backstage-cli new`.
|
|
18
|
+
|
|
3
19
|
## 0.1.3
|
|
4
20
|
|
|
5
21
|
### Patch Changes
|
|
@@ -26,7 +26,7 @@ if (isLocal) {
|
|
|
26
26
|
require('@backstage/cli-node/config/nodeTransform.cjs');
|
|
27
27
|
}
|
|
28
28
|
|
|
29
|
-
const {
|
|
29
|
+
const { runCli } = require('@backstage/cli-node');
|
|
30
30
|
const cliModule = require(isLocal ? '../src/index' : '..').default;
|
|
31
31
|
const pkg = require('../package.json');
|
|
32
|
-
|
|
32
|
+
runCli({ modules: [cliModule], name: pkg.name, version: pkg.version });
|
package/dist/commands/new.cjs.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"new.cjs.js","sources":["../../src/commands/new.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { cli } from 'cleye';\nimport { createNewPackage } from '../lib/createNewPackage';\nimport type { CliCommandContext } from '@backstage/cli-node';\n\nexport default async ({ args, info }: CliCommandContext) => {\n for (const flag of ['skipInstall', 'npmRegistry', 'baseVersion']) {\n if (args.some(a => a === `--${flag}` || a.startsWith(`--${flag}=`))) {\n process.stderr.write(\n `DEPRECATION WARNING: --${flag} is deprecated, use the kebab-case form instead\\n`,\n );\n }\n }\n\n const {\n flags: {\n select,\n option: rawArgOptions,\n skipInstall,\n scope,\n npmRegistry,\n baseVersion,\n license,\n private: isPrivate,\n },\n } = cli(\n {\n
|
|
1
|
+
{"version":3,"file":"new.cjs.js","sources":["../../src/commands/new.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { cli } from 'cleye';\nimport { createNewPackage } from '../lib/createNewPackage';\nimport type { CliCommandContext } from '@backstage/cli-node';\n\nexport default async ({ args, info }: CliCommandContext) => {\n for (const flag of ['skipInstall', 'npmRegistry', 'baseVersion']) {\n if (args.some(a => a === `--${flag}` || a.startsWith(`--${flag}=`))) {\n process.stderr.write(\n `DEPRECATION WARNING: --${flag} is deprecated, use the kebab-case form instead\\n`,\n );\n }\n }\n\n const {\n flags: {\n select,\n option: rawArgOptions,\n skipInstall,\n scope,\n npmRegistry,\n baseVersion,\n license,\n private: isPrivate,\n },\n } = cli(\n {\n name: info.usage,\n booleanFlagNegation: true,\n flags: {\n select: {\n type: String,\n description: 'Select the thing you want to be creating upfront',\n },\n option: {\n type: [String] as const,\n description: 'Pre-fill options for the creation process',\n default: [] as string[],\n },\n skipInstall: {\n type: Boolean,\n description: `Skips running 'yarn install' and 'yarn lint --fix'`,\n },\n scope: {\n type: String,\n description: 'The scope to use for new packages',\n },\n npmRegistry: {\n type: String,\n description: 'The package registry to use for new packages',\n },\n baseVersion: {\n type: String,\n description:\n 'The version to use for any new packages (default: 0.1.0)',\n },\n license: {\n type: String,\n description:\n 'The license to use for any new packages (default: Apache-2.0)',\n },\n private: {\n type: Boolean,\n description: 'Mark new packages as private',\n default: true,\n },\n },\n },\n undefined,\n args,\n );\n\n const prefilledParams = parseParams(rawArgOptions);\n\n let pluginInfix: string | undefined = undefined;\n let packagePrefix: string | undefined = undefined;\n if (scope) {\n const normalizedScope = scope.startsWith('@') ? scope : `@${scope}`;\n packagePrefix = normalizedScope.includes('/')\n ? normalizedScope\n : `${normalizedScope}/`;\n pluginInfix = scope.includes('backstage') ? 'plugin-' : 'backstage-plugin-';\n }\n\n if (\n isPrivate === false ||\n [npmRegistry, baseVersion, license].filter(Boolean).length !== 0\n ) {\n console.warn(\n `Global template configuration via CLI flags is deprecated, see https://backstage.io/docs/cli/new for information on how to configure package templating`,\n );\n }\n\n await createNewPackage({\n prefilledParams,\n preselectedTemplateId: select,\n configOverrides: {\n license,\n version: baseVersion,\n private: isPrivate,\n publishRegistry: npmRegistry,\n packageNamePrefix: packagePrefix,\n packageNamePluginInfix: pluginInfix,\n },\n skipInstall: Boolean(skipInstall),\n });\n};\n\nfunction parseParams(optionStrings: string[]): Record<string, string> {\n const options: Record<string, string> = {};\n\n for (const str of optionStrings) {\n const [key] = str.split('=', 1);\n const value = str.slice(key.length + 1);\n if (!key || str[key.length] !== '=') {\n throw new Error(\n `Invalid option '${str}', must be of the format <key>=<value>`,\n );\n }\n options[key] = value;\n }\n\n return options;\n}\n"],"names":["cli","createNewPackage"],"mappings":";;;;;;;AAoBA,WAAe,OAAO,EAAE,IAAA,EAAM,IAAA,EAAK,KAAyB;AAC1D,EAAA,KAAA,MAAW,IAAA,IAAQ,CAAC,aAAA,EAAe,aAAA,EAAe,aAAa,CAAA,EAAG;AAChE,IAAA,IAAI,IAAA,CAAK,IAAA,CAAK,CAAA,CAAA,KAAK,CAAA,KAAM,CAAA,EAAA,EAAK,IAAI,CAAA,CAAA,IAAM,CAAA,CAAE,UAAA,CAAW,CAAA,EAAA,EAAK,IAAI,CAAA,CAAA,CAAG,CAAC,CAAA,EAAG;AACnE,MAAA,OAAA,CAAQ,MAAA,CAAO,KAAA;AAAA,QACb,0BAA0B,IAAI,CAAA;AAAA;AAAA,OAChC;AAAA,IACF;AAAA,EACF;AAEA,EAAA,MAAM;AAAA,IACJ,KAAA,EAAO;AAAA,MACL,MAAA;AAAA,MACA,MAAA,EAAQ,aAAA;AAAA,MACR,WAAA;AAAA,MACA,KAAA;AAAA,MACA,WAAA;AAAA,MACA,WAAA;AAAA,MACA,OAAA;AAAA,MACA,OAAA,EAAS;AAAA;AACX,GACF,GAAIA,SAAA;AAAA,IACF;AAAA,MACE,MAAM,IAAA,CAAK,KAAA;AAAA,MACX,mBAAA,EAAqB,IAAA;AAAA,MACrB,KAAA,EAAO;AAAA,QACL,MAAA,EAAQ;AAAA,UACN,IAAA,EAAM,MAAA;AAAA,UACN,WAAA,EAAa;AAAA,SACf;AAAA,QACA,MAAA,EAAQ;AAAA,UACN,IAAA,EAAM,CAAC,MAAM,CAAA;AAAA,UACb,WAAA,EAAa,2CAAA;AAAA,UACb,SAAS;AAAC,SACZ;AAAA,QACA,WAAA,EAAa;AAAA,UACX,IAAA,EAAM,OAAA;AAAA,UACN,WAAA,EAAa,CAAA,kDAAA;AAAA,SACf;AAAA,QACA,KAAA,EAAO;AAAA,UACL,IAAA,EAAM,MAAA;AAAA,UACN,WAAA,EAAa;AAAA,SACf;AAAA,QACA,WAAA,EAAa;AAAA,UACX,IAAA,EAAM,MAAA;AAAA,UACN,WAAA,EAAa;AAAA,SACf;AAAA,QACA,WAAA,EAAa;AAAA,UACX,IAAA,EAAM,MAAA;AAAA,UACN,WAAA,EACE;AAAA,SACJ;AAAA,QACA,OAAA,EAAS;AAAA,UACP,IAAA,EAAM,MAAA;AAAA,UACN,WAAA,EACE;AAAA,SACJ;AAAA,QACA,OAAA,EAAS;AAAA,UACP,IAAA,EAAM,OAAA;AAAA,UACN,WAAA,EAAa,8BAAA;AAAA,UACb,OAAA,EAAS;AAAA;AACX;AACF,KACF;AAAA,IACA,MAAA;AAAA,IACA;AAAA,GACF;AAEA,EAAA,MAAM,eAAA,GAAkB,YAAY,aAAa,CAAA;AAEjD,EAAA,IAAI,WAAA,GAAkC,MAAA;AACtC,EAAA,IAAI,aAAA,GAAoC,MAAA;AACxC,EAAA,IAAI,KAAA,EAAO;AACT,IAAA,MAAM,kBAAkB,KAAA,CAAM,UAAA,CAAW,GAAG,CAAA,GAAI,KAAA,GAAQ,IAAI,KAAK,CAAA,CAAA;AACjE,IAAA,aAAA,GAAgB,gBAAgB,QAAA,CAAS,GAAG,CAAA,GACxC,eAAA,GACA,GAAG,eAAe,CAAA,CAAA,CAAA;AACtB,IAAA,WAAA,GAAc,KAAA,CAAM,QAAA,CAAS,WAAW,CAAA,GAAI,SAAA,GAAY,mBAAA;AAAA,EAC1D;AAEA,EAAA,IACE,SAAA,KAAc,KAAA,IACd,CAAC,WAAA,EAAa,WAAA,EAAa,OAAO,CAAA,CAAE,MAAA,CAAO,OAAO,CAAA,CAAE,MAAA,KAAW,CAAA,EAC/D;AACA,IAAA,OAAA,CAAQ,IAAA;AAAA,MACN,CAAA,uJAAA;AAAA,KACF;AAAA,EACF;AAEA,EAAA,MAAMC,iCAAA,CAAiB;AAAA,IACrB,eAAA;AAAA,IACA,qBAAA,EAAuB,MAAA;AAAA,IACvB,eAAA,EAAiB;AAAA,MACf,OAAA;AAAA,MACA,OAAA,EAAS,WAAA;AAAA,MACT,OAAA,EAAS,SAAA;AAAA,MACT,eAAA,EAAiB,WAAA;AAAA,MACjB,iBAAA,EAAmB,aAAA;AAAA,MACnB,sBAAA,EAAwB;AAAA,KAC1B;AAAA,IACA,WAAA,EAAa,QAAQ,WAAW;AAAA,GACjC,CAAA;AACH,CAAA;AAEA,SAAS,YAAY,aAAA,EAAiD;AACpE,EAAA,MAAM,UAAkC,EAAC;AAEzC,EAAA,KAAA,MAAW,OAAO,aAAA,EAAe;AAC/B,IAAA,MAAM,CAAC,GAAG,CAAA,GAAI,GAAA,CAAI,KAAA,CAAM,KAAK,CAAC,CAAA;AAC9B,IAAA,MAAM,KAAA,GAAQ,GAAA,CAAI,KAAA,CAAM,GAAA,CAAI,SAAS,CAAC,CAAA;AACtC,IAAA,IAAI,CAAC,GAAA,IAAO,GAAA,CAAI,GAAA,CAAI,MAAM,MAAM,GAAA,EAAK;AACnC,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,mBAAmB,GAAG,CAAA,sCAAA;AAAA,OACxB;AAAA,IACF;AACA,IAAA,OAAA,CAAQ,GAAG,CAAA,GAAI,KAAA;AAAA,EACjB;AAEA,EAAA,OAAO,OAAA;AACT;;;;"}
|
|
@@ -13,7 +13,8 @@ const defaultTemplates = [
|
|
|
13
13
|
"@backstage/cli-module-new/templates/node-library",
|
|
14
14
|
"@backstage/cli-module-new/templates/cli-module",
|
|
15
15
|
"@backstage/cli-module-new/templates/catalog-provider-module",
|
|
16
|
-
"@backstage/cli-module-new/templates/scaffolder-backend-module"
|
|
16
|
+
"@backstage/cli-module-new/templates/scaffolder-backend-module",
|
|
17
|
+
"@backstage/cli-module-new/templates/scaffolder-field-extension-module"
|
|
17
18
|
];
|
|
18
19
|
|
|
19
20
|
exports.defaultTemplates = defaultTemplates;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"defaultTemplates.cjs.js","sources":["../../src/lib/defaultTemplates.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\nexport const defaultTemplates = [\n '@backstage/cli-module-new/templates/frontend-plugin',\n '@backstage/cli-module-new/templates/frontend-plugin-module',\n '@backstage/cli-module-new/templates/legacy-frontend-plugin',\n '@backstage/cli-module-new/templates/backend-plugin',\n '@backstage/cli-module-new/templates/backend-plugin-module',\n '@backstage/cli-module-new/templates/plugin-web-library',\n '@backstage/cli-module-new/templates/plugin-node-library',\n '@backstage/cli-module-new/templates/plugin-common-library',\n '@backstage/cli-module-new/templates/web-library',\n '@backstage/cli-module-new/templates/node-library',\n '@backstage/cli-module-new/templates/cli-module',\n '@backstage/cli-module-new/templates/catalog-provider-module',\n '@backstage/cli-module-new/templates/scaffolder-backend-module',\n];\n"],"names":[],"mappings":";;AAgBO,MAAM,gBAAA,GAAmB;AAAA,EAC9B,qDAAA;AAAA,EACA,4DAAA;AAAA,EACA,4DAAA;AAAA,EACA,oDAAA;AAAA,EACA,2DAAA;AAAA,EACA,wDAAA;AAAA,EACA,yDAAA;AAAA,EACA,2DAAA;AAAA,EACA,iDAAA;AAAA,EACA,kDAAA;AAAA,EACA,gDAAA;AAAA,EACA,6DAAA;AAAA,EACA;AACF;;;;"}
|
|
1
|
+
{"version":3,"file":"defaultTemplates.cjs.js","sources":["../../src/lib/defaultTemplates.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\nexport const defaultTemplates = [\n '@backstage/cli-module-new/templates/frontend-plugin',\n '@backstage/cli-module-new/templates/frontend-plugin-module',\n '@backstage/cli-module-new/templates/legacy-frontend-plugin',\n '@backstage/cli-module-new/templates/backend-plugin',\n '@backstage/cli-module-new/templates/backend-plugin-module',\n '@backstage/cli-module-new/templates/plugin-web-library',\n '@backstage/cli-module-new/templates/plugin-node-library',\n '@backstage/cli-module-new/templates/plugin-common-library',\n '@backstage/cli-module-new/templates/web-library',\n '@backstage/cli-module-new/templates/node-library',\n '@backstage/cli-module-new/templates/cli-module',\n '@backstage/cli-module-new/templates/catalog-provider-module',\n '@backstage/cli-module-new/templates/scaffolder-backend-module',\n '@backstage/cli-module-new/templates/scaffolder-field-extension-module',\n];\n"],"names":[],"mappings":";;AAgBO,MAAM,gBAAA,GAAmB;AAAA,EAC9B,qDAAA;AAAA,EACA,4DAAA;AAAA,EACA,4DAAA;AAAA,EACA,oDAAA;AAAA,EACA,2DAAA;AAAA,EACA,wDAAA;AAAA,EACA,yDAAA;AAAA,EACA,2DAAA;AAAA,EACA,iDAAA;AAAA,EACA,kDAAA;AAAA,EACA,gDAAA;AAAA,EACA,6DAAA;AAAA,EACA,+DAAA;AAAA,EACA;AACF;;;;"}
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
4
|
|
|
5
5
|
var name = "@backstage/cli-module-new";
|
|
6
|
-
var version = "0.1.
|
|
6
|
+
var version = "0.1.4";
|
|
7
7
|
var description = "CLI module for Backstage CLI";
|
|
8
8
|
var backstage = {
|
|
9
9
|
role: "cli-module"
|
|
@@ -41,7 +41,7 @@ var dependencies = {
|
|
|
41
41
|
"@backstage/cli-node": "workspace:^",
|
|
42
42
|
"@backstage/errors": "workspace:^",
|
|
43
43
|
chalk: "^4.0.0",
|
|
44
|
-
cleye: "^2.
|
|
44
|
+
cleye: "^2.6.0",
|
|
45
45
|
"fs-extra": "^11.2.0",
|
|
46
46
|
handlebars: "^4.7.3",
|
|
47
47
|
inquirer: "^8.2.0",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/cli-module-new",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.4",
|
|
4
4
|
"description": "CLI module for Backstage CLI",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "cli-module"
|
|
@@ -35,10 +35,10 @@
|
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
37
|
"@backstage/cli-common": "^0.2.2",
|
|
38
|
-
"@backstage/cli-node": "^0.3.
|
|
38
|
+
"@backstage/cli-node": "^0.3.3",
|
|
39
39
|
"@backstage/errors": "^1.3.1",
|
|
40
40
|
"chalk": "^4.0.0",
|
|
41
|
-
"cleye": "^2.
|
|
41
|
+
"cleye": "^2.6.0",
|
|
42
42
|
"fs-extra": "^11.2.0",
|
|
43
43
|
"handlebars": "^4.7.3",
|
|
44
44
|
"inquirer": "^8.2.0",
|
|
@@ -51,10 +51,10 @@
|
|
|
51
51
|
"zod-validation-error": "^4.0.2"
|
|
52
52
|
},
|
|
53
53
|
"devDependencies": {
|
|
54
|
-
"@backstage/backend-test-utils": "^1.11.
|
|
55
|
-
"@backstage/cli": "^0.36.
|
|
56
|
-
"@backstage/core-plugin-api": "^1.12.
|
|
57
|
-
"@backstage/test-utils": "^1.7.
|
|
54
|
+
"@backstage/backend-test-utils": "^1.11.4",
|
|
55
|
+
"@backstage/cli": "^0.36.3",
|
|
56
|
+
"@backstage/core-plugin-api": "^1.12.7",
|
|
57
|
+
"@backstage/test-utils": "^1.7.19",
|
|
58
58
|
"@types/fs-extra": "^11.0.0",
|
|
59
59
|
"@types/inquirer": "^8.1.3",
|
|
60
60
|
"@types/lodash": "^4.14.151",
|
|
@@ -26,7 +26,7 @@ if (isLocal) {
|
|
|
26
26
|
require('@backstage/cli-node/config/nodeTransform.cjs');
|
|
27
27
|
}
|
|
28
28
|
|
|
29
|
-
const {
|
|
29
|
+
const { runCli } = require('@backstage/cli-node');
|
|
30
30
|
const cliModule = require(isLocal ? '../src/index' : '..').default;
|
|
31
31
|
const pkg = require('../package.json');
|
|
32
|
-
|
|
32
|
+
runCli({ modules: [cliModule], name: pkg.name, version: pkg.version });
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
"dependencies": {
|
|
23
23
|
"@backstage/cli-common": "{{versionQuery '@backstage/cli-common'}}",
|
|
24
24
|
"@backstage/cli-node": "{{versionQuery '@backstage/cli-node'}}",
|
|
25
|
-
"cleye": "^2.
|
|
25
|
+
"cleye": "^2.6.0"
|
|
26
26
|
},
|
|
27
27
|
"devDependencies": {
|
|
28
28
|
"@backstage/cli": "{{versionQuery '@backstage/cli'}}"
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# {{packageName}}
|
|
2
|
+
|
|
3
|
+
The {{moduleId}} field extension module for the Backstage Scaffolder.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
To use this field in a Scaffolder template, reference it in the template spec:
|
|
8
|
+
|
|
9
|
+
```yaml
|
|
10
|
+
properties:
|
|
11
|
+
myField:
|
|
12
|
+
title: My Field
|
|
13
|
+
type: string
|
|
14
|
+
ui:field: {{kebabCase moduleId}}
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
_This plugin was created through the Backstage CLI_
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "{{packageName}}",
|
|
3
|
+
"description": "The {{moduleId}} field extension module for the Backstage Scaffolder.",
|
|
4
|
+
"main": "src/index.ts",
|
|
5
|
+
"types": "src/index.ts",
|
|
6
|
+
"publishConfig": {
|
|
7
|
+
"access": "public",
|
|
8
|
+
"main": "dist/index.cjs.js",
|
|
9
|
+
"module": "dist/index.esm.js",
|
|
10
|
+
"types": "dist/index.d.ts"
|
|
11
|
+
},
|
|
12
|
+
"backstage": {
|
|
13
|
+
"role": "frontend-plugin-module",
|
|
14
|
+
"pluginId": "{{pluginId}}",
|
|
15
|
+
"pluginPackage": "{{pluginPackage}}"
|
|
16
|
+
},
|
|
17
|
+
"sideEffects": false,
|
|
18
|
+
"scripts": {
|
|
19
|
+
"build": "backstage-cli package build",
|
|
20
|
+
"lint": "backstage-cli package lint",
|
|
21
|
+
"test": "backstage-cli package test",
|
|
22
|
+
"clean": "backstage-cli package clean",
|
|
23
|
+
"prepack": "backstage-cli package prepack",
|
|
24
|
+
"postpack": "backstage-cli package postpack"
|
|
25
|
+
},
|
|
26
|
+
"dependencies": {
|
|
27
|
+
"@backstage/frontend-plugin-api": "{{versionQuery '@backstage/frontend-plugin-api'}}",
|
|
28
|
+
"@backstage/plugin-scaffolder-react": "{{versionQuery '@backstage/plugin-scaffolder-react'}}"
|
|
29
|
+
},
|
|
30
|
+
"devDependencies": {
|
|
31
|
+
"@backstage/cli": "{{versionQuery '@backstage/cli'}}",
|
|
32
|
+
"@testing-library/jest-dom": "{{versionQuery '@testing-library/jest-dom' '6.0.0'}}",
|
|
33
|
+
"@testing-library/react": "{{versionQuery '@testing-library/react' '16.0.0'}}",
|
|
34
|
+
"@testing-library/user-event": "{{versionQuery '@testing-library/user-event' '14.0.0'}}",
|
|
35
|
+
"react": "{{versionQuery 'react' '18.0.0'}}"
|
|
36
|
+
},
|
|
37
|
+
"peerDependencies": {
|
|
38
|
+
"react": "^17.0.0 || ^18.0.0"
|
|
39
|
+
},
|
|
40
|
+
"files": [
|
|
41
|
+
"dist"
|
|
42
|
+
]
|
|
43
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
name: scaffolder-field-extension-module
|
|
2
|
+
role: frontend-plugin-module
|
|
3
|
+
description: A custom field extension for the Backstage Scaffolder
|
|
4
|
+
values:
|
|
5
|
+
pluginId: scaffolder
|
|
6
|
+
moduleVar: '{{ camelCase pluginId }}Module{{ upperFirst ( camelCase moduleId ) }}'
|
|
7
|
+
extensionName: '{{ upperFirst ( camelCase moduleId ) }}FieldExtension'
|
|
8
|
+
extensionComponent: '{{ upperFirst ( camelCase moduleId ) }}Field'
|
package/templates/scaffolder-field-extension-module/src/extensions/{{extensionName}}.test.tsx.hbs
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { render, screen } from '@testing-library/react';
|
|
2
|
+
import userEvent from '@testing-library/user-event';
|
|
3
|
+
import { {{ extensionComponent }} } from './{{ extensionName }}';
|
|
4
|
+
|
|
5
|
+
describe('{{ extensionComponent }}', () => {
|
|
6
|
+
it('should render the field and handle changes', async () => {
|
|
7
|
+
const onChange = jest.fn();
|
|
8
|
+
|
|
9
|
+
render(
|
|
10
|
+
<{{ extensionComponent }}
|
|
11
|
+
onChange={onChange}
|
|
12
|
+
rawErrors={[]}
|
|
13
|
+
required={false}
|
|
14
|
+
formData=""
|
|
15
|
+
/>,
|
|
16
|
+
);
|
|
17
|
+
|
|
18
|
+
const input = screen.getByRole('textbox');
|
|
19
|
+
await userEvent.type(input, 'test');
|
|
20
|
+
|
|
21
|
+
expect(onChange).toHaveBeenCalled();
|
|
22
|
+
});
|
|
23
|
+
});
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import {
|
|
2
|
+
FormFieldBlueprint,
|
|
3
|
+
createFormField,
|
|
4
|
+
} from '@backstage/plugin-scaffolder-react/alpha';
|
|
5
|
+
import {
|
|
6
|
+
FieldExtensionComponentProps,
|
|
7
|
+
makeFieldSchema,
|
|
8
|
+
} from '@backstage/plugin-scaffolder-react';
|
|
9
|
+
|
|
10
|
+
export const {{ extensionComponent }} = ({
|
|
11
|
+
onChange,
|
|
12
|
+
required,
|
|
13
|
+
formData,
|
|
14
|
+
}: FieldExtensionComponentProps<string>) => {
|
|
15
|
+
// TODO: Replace with your custom field component
|
|
16
|
+
return (
|
|
17
|
+
<input
|
|
18
|
+
type="text"
|
|
19
|
+
onChange={e => onChange(e.target.value)}
|
|
20
|
+
value={formData ?? ''}
|
|
21
|
+
required={required}
|
|
22
|
+
/>
|
|
23
|
+
);
|
|
24
|
+
};
|
|
25
|
+
|
|
26
|
+
export const {{ extensionName }} = FormFieldBlueprint.make({
|
|
27
|
+
name: '{{ kebabCase moduleId }}',
|
|
28
|
+
params: {
|
|
29
|
+
field: async () =>
|
|
30
|
+
createFormField({
|
|
31
|
+
name: '{{ extensionComponent }}',
|
|
32
|
+
component: {{ extensionComponent }},
|
|
33
|
+
// Uncomment to add validation:
|
|
34
|
+
// validation: async (value, validation, { apiHolder }) => {
|
|
35
|
+
// if (!value) validation.addError('Field is required');
|
|
36
|
+
// },
|
|
37
|
+
// Uncomment to define schema for the Custom Field Explorer preview:
|
|
38
|
+
// schema: makeFieldSchema({
|
|
39
|
+
// output: z => z.string(),
|
|
40
|
+
// }),
|
|
41
|
+
}),
|
|
42
|
+
},
|
|
43
|
+
});
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { {{ moduleVar }} as default } from './module';
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { createFrontendModule } from '@backstage/frontend-plugin-api';
|
|
2
|
+
import { {{ extensionName }} } from './extensions/{{ extensionName }}';
|
|
3
|
+
|
|
4
|
+
export const {{ moduleVar }} = createFrontendModule({
|
|
5
|
+
pluginId: '{{ pluginId }}',
|
|
6
|
+
extensions: [{{ extensionName }}],
|
|
7
|
+
});
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import '@testing-library/jest-dom';
|