From 5108226057c62aa0a66dc9f8bb0b7a9ebb258a9c Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Mon, 10 Feb 2025 17:24:44 +0100 Subject: [PATCH] cli/templates: match definitions to new design in docs Signed-off-by: Patrik Oldsberg --- packages/cli/src/lib/new/defaultTemplates.ts | 12 ------------ .../.eslintrc.js.hbs | 0 .../README.md.hbs | 0 .../package.json.hbs | 0 .../src/index.ts.hbs | 0 .../src/module.ts.hbs | 0 .../template.yaml} | 3 ++- .../tsconfig.json | 0 .../.eslintrc.js.hbs | 0 .../README.md.hbs | 0 .../dev/index.ts.hbs | 0 .../package.json.hbs | 0 .../src/index.ts.hbs | 0 .../src/plugin.test.ts.hbs | 0 .../src/plugin.ts.hbs | 0 .../src/router.test.ts | 0 .../src/router.ts | 0 .../TodoListService/createTodoListService.ts | 0 .../src/services/TodoListService/index.ts | 0 .../src/services/TodoListService/types.ts | 0 .../src/setupTests.ts | 0 .../template.yaml} | 3 ++- .../tsconfig.json | 0 .../cli/templates/default-common-plugin-package.yaml | 2 -- .../cli/templates/default-node-plugin-package.yaml | 2 -- .../cli/templates/default-react-plugin-package.yaml | 2 -- .../.eslintrc.js.hbs | 0 .../README.md.hbs | 0 .../dev/index.tsx.hbs | 0 .../package.json.hbs | 0 .../ExampleComponent/ExampleComponent.test.tsx.hbs | 0 .../ExampleComponent/ExampleComponent.tsx.hbs | 0 .../src/components/ExampleComponent/index.ts | 0 .../ExampleFetchComponent.test.tsx.hbs | 0 .../ExampleFetchComponent.tsx.hbs | 0 .../src/components/ExampleFetchComponent/index.ts | 0 .../src/index.ts.hbs | 0 .../src/plugin.test.ts.hbs | 0 .../src/plugin.ts.hbs | 0 .../src/routes.ts.hbs | 0 .../src/setupTests.ts | 0 .../template.yaml} | 3 ++- .../tsconfig.json | 0 packages/cli/templates/node-library-package.yaml | 2 -- .../.eslintrc.js.hbs | 0 .../README.md.hbs | 0 .../package.json.hbs | 0 .../src/index.ts.hbs | 0 .../src/setupTests.ts | 0 packages/cli/templates/node-library/template.yaml | 3 +++ .../tsconfig.json | 0 .../.eslintrc.js.hbs | 0 .../README.md.hbs | 0 .../package.json.hbs | 0 .../src/index.ts.hbs | 0 .../src/setupTests.ts | 0 .../templates/plugin-common-library/template.yaml | 3 +++ .../tsconfig.json | 0 .../.eslintrc.js.hbs | 0 .../README.md.hbs | 0 .../package.json.hbs | 0 .../src/index.ts.hbs | 0 .../src/setupTests.ts | 0 .../cli/templates/plugin-node-library/template.yaml | 3 +++ .../tsconfig.json | 0 .../.eslintrc.js.hbs | 0 .../README.md.hbs | 0 .../package.json.hbs | 0 .../ExampleComponent/ExampleComponent.test.tsx | 0 .../components/ExampleComponent/ExampleComponent.tsx | 0 .../src/components/ExampleComponent/index.ts | 0 .../src/components/index.ts | 0 .../src/hooks/index.ts | 0 .../src/hooks/useExample/index.ts | 0 .../src/hooks/useExample/useExample.ts | 0 .../src/index.ts.hbs | 0 .../src/setupTests.ts | 0 .../cli/templates/plugin-web-library/template.yaml | 3 +++ .../tsconfig.json | 0 .../.eslintrc.js.hbs | 0 .../README.md.hbs | 0 .../package.json.hbs | 0 .../src/actions/example.test.ts | 0 .../src/actions/example.ts | 0 .../src/index.ts.hbs | 0 .../src/module.ts | 0 .../template.yaml} | 3 ++- .../tsconfig.json | 0 packages/cli/templates/web-library-package.yaml | 2 -- .../.eslintrc.js.hbs | 0 .../README.md.hbs | 0 .../package.json.hbs | 0 .../src/index.ts.hbs | 0 .../src/setupTests.ts | 0 packages/cli/templates/web-library/template.yaml | 3 +++ .../tsconfig.json | 0 96 files changed, 23 insertions(+), 26 deletions(-) rename packages/cli/templates/{default-backend-module => backend-plugin-module}/.eslintrc.js.hbs (100%) rename packages/cli/templates/{default-backend-module => backend-plugin-module}/README.md.hbs (100%) rename packages/cli/templates/{default-backend-module => backend-plugin-module}/package.json.hbs (100%) rename packages/cli/templates/{default-backend-module => backend-plugin-module}/src/index.ts.hbs (100%) rename packages/cli/templates/{default-backend-module => backend-plugin-module}/src/module.ts.hbs (100%) rename packages/cli/templates/{default-backend-module.yaml => backend-plugin-module/template.yaml} (55%) rename packages/cli/templates/{default-backend-module => backend-plugin-module}/tsconfig.json (100%) rename packages/cli/templates/{default-backend-plugin => backend-plugin}/.eslintrc.js.hbs (100%) rename packages/cli/templates/{default-backend-plugin => backend-plugin}/README.md.hbs (100%) rename packages/cli/templates/{default-backend-plugin => backend-plugin}/dev/index.ts.hbs (100%) rename packages/cli/templates/{default-backend-plugin => backend-plugin}/package.json.hbs (100%) rename packages/cli/templates/{default-backend-plugin => backend-plugin}/src/index.ts.hbs (100%) rename packages/cli/templates/{default-backend-plugin => backend-plugin}/src/plugin.test.ts.hbs (100%) rename packages/cli/templates/{default-backend-plugin => backend-plugin}/src/plugin.ts.hbs (100%) rename packages/cli/templates/{default-backend-plugin => backend-plugin}/src/router.test.ts (100%) rename packages/cli/templates/{default-backend-plugin => backend-plugin}/src/router.ts (100%) rename packages/cli/templates/{default-backend-plugin => backend-plugin}/src/services/TodoListService/createTodoListService.ts (100%) rename packages/cli/templates/{default-backend-plugin => backend-plugin}/src/services/TodoListService/index.ts (100%) rename packages/cli/templates/{default-backend-plugin => backend-plugin}/src/services/TodoListService/types.ts (100%) rename packages/cli/templates/{default-backend-plugin => backend-plugin}/src/setupTests.ts (100%) rename packages/cli/templates/{default-backend-plugin.yaml => backend-plugin/template.yaml} (60%) rename packages/cli/templates/{default-backend-plugin => backend-plugin}/tsconfig.json (100%) delete mode 100644 packages/cli/templates/default-common-plugin-package.yaml delete mode 100644 packages/cli/templates/default-node-plugin-package.yaml delete mode 100644 packages/cli/templates/default-react-plugin-package.yaml rename packages/cli/templates/{default-common-plugin-package => frontend-plugin}/.eslintrc.js.hbs (100%) rename packages/cli/templates/{default-plugin => frontend-plugin}/README.md.hbs (100%) rename packages/cli/templates/{default-plugin => frontend-plugin}/dev/index.tsx.hbs (100%) rename packages/cli/templates/{default-plugin => frontend-plugin}/package.json.hbs (100%) rename packages/cli/templates/{default-plugin => frontend-plugin}/src/components/ExampleComponent/ExampleComponent.test.tsx.hbs (100%) rename packages/cli/templates/{default-plugin => frontend-plugin}/src/components/ExampleComponent/ExampleComponent.tsx.hbs (100%) rename packages/cli/templates/{default-plugin => frontend-plugin}/src/components/ExampleComponent/index.ts (100%) rename packages/cli/templates/{default-plugin => frontend-plugin}/src/components/ExampleFetchComponent/ExampleFetchComponent.test.tsx.hbs (100%) rename packages/cli/templates/{default-plugin => frontend-plugin}/src/components/ExampleFetchComponent/ExampleFetchComponent.tsx.hbs (100%) rename packages/cli/templates/{default-plugin => frontend-plugin}/src/components/ExampleFetchComponent/index.ts (100%) rename packages/cli/templates/{default-plugin => frontend-plugin}/src/index.ts.hbs (100%) rename packages/cli/templates/{default-plugin => frontend-plugin}/src/plugin.test.ts.hbs (100%) rename packages/cli/templates/{default-plugin => frontend-plugin}/src/plugin.ts.hbs (100%) rename packages/cli/templates/{default-plugin => frontend-plugin}/src/routes.ts.hbs (100%) rename packages/cli/templates/{default-plugin => frontend-plugin}/src/setupTests.ts (100%) rename packages/cli/templates/{default-plugin.yaml => frontend-plugin/template.yaml} (72%) rename packages/cli/templates/{default-plugin => frontend-plugin}/tsconfig.json (100%) delete mode 100644 packages/cli/templates/node-library-package.yaml rename packages/cli/templates/{default-node-plugin-package => node-library}/.eslintrc.js.hbs (100%) rename packages/cli/templates/{node-library-package => node-library}/README.md.hbs (100%) rename packages/cli/templates/{node-library-package => node-library}/package.json.hbs (100%) rename packages/cli/templates/{node-library-package => node-library}/src/index.ts.hbs (100%) rename packages/cli/templates/{default-common-plugin-package => node-library}/src/setupTests.ts (100%) create mode 100644 packages/cli/templates/node-library/template.yaml rename packages/cli/templates/{default-react-plugin-package => node-library}/tsconfig.json (100%) rename packages/cli/templates/{default-plugin => plugin-common-library}/.eslintrc.js.hbs (100%) rename packages/cli/templates/{default-common-plugin-package => plugin-common-library}/README.md.hbs (100%) rename packages/cli/templates/{default-common-plugin-package => plugin-common-library}/package.json.hbs (100%) rename packages/cli/templates/{default-common-plugin-package => plugin-common-library}/src/index.ts.hbs (100%) rename packages/cli/templates/{default-node-plugin-package => plugin-common-library}/src/setupTests.ts (100%) create mode 100644 packages/cli/templates/plugin-common-library/template.yaml rename packages/cli/templates/{default-common-plugin-package => plugin-common-library}/tsconfig.json (100%) rename packages/cli/templates/{default-react-plugin-package => plugin-node-library}/.eslintrc.js.hbs (100%) rename packages/cli/templates/{default-node-plugin-package => plugin-node-library}/README.md.hbs (100%) rename packages/cli/templates/{default-node-plugin-package => plugin-node-library}/package.json.hbs (100%) rename packages/cli/templates/{default-node-plugin-package => plugin-node-library}/src/index.ts.hbs (100%) rename packages/cli/templates/{node-library-package => plugin-node-library}/src/setupTests.ts (100%) create mode 100644 packages/cli/templates/plugin-node-library/template.yaml rename packages/cli/templates/{default-node-plugin-package => plugin-node-library}/tsconfig.json (100%) rename packages/cli/templates/{node-library-package => plugin-web-library}/.eslintrc.js.hbs (100%) rename packages/cli/templates/{default-react-plugin-package => plugin-web-library}/README.md.hbs (100%) rename packages/cli/templates/{default-react-plugin-package => plugin-web-library}/package.json.hbs (100%) rename packages/cli/templates/{default-react-plugin-package => plugin-web-library}/src/components/ExampleComponent/ExampleComponent.test.tsx (100%) rename packages/cli/templates/{default-react-plugin-package => plugin-web-library}/src/components/ExampleComponent/ExampleComponent.tsx (100%) rename packages/cli/templates/{default-react-plugin-package => plugin-web-library}/src/components/ExampleComponent/index.ts (100%) rename packages/cli/templates/{default-react-plugin-package => plugin-web-library}/src/components/index.ts (100%) rename packages/cli/templates/{default-react-plugin-package => plugin-web-library}/src/hooks/index.ts (100%) rename packages/cli/templates/{default-react-plugin-package => plugin-web-library}/src/hooks/useExample/index.ts (100%) rename packages/cli/templates/{default-react-plugin-package => plugin-web-library}/src/hooks/useExample/useExample.ts (100%) rename packages/cli/templates/{default-react-plugin-package => plugin-web-library}/src/index.ts.hbs (100%) rename packages/cli/templates/{default-react-plugin-package => plugin-web-library}/src/setupTests.ts (100%) create mode 100644 packages/cli/templates/plugin-web-library/template.yaml rename packages/cli/templates/{node-library-package => plugin-web-library}/tsconfig.json (100%) rename packages/cli/templates/{scaffolder-module => scaffolder-backend-module}/.eslintrc.js.hbs (100%) rename packages/cli/templates/{scaffolder-module => scaffolder-backend-module}/README.md.hbs (100%) rename packages/cli/templates/{scaffolder-module => scaffolder-backend-module}/package.json.hbs (100%) rename packages/cli/templates/{scaffolder-module => scaffolder-backend-module}/src/actions/example.test.ts (100%) rename packages/cli/templates/{scaffolder-module => scaffolder-backend-module}/src/actions/example.ts (100%) rename packages/cli/templates/{scaffolder-module => scaffolder-backend-module}/src/index.ts.hbs (100%) rename packages/cli/templates/{scaffolder-module => scaffolder-backend-module}/src/module.ts (100%) rename packages/cli/templates/{scaffolder-module.yaml => scaffolder-backend-module/template.yaml} (57%) rename packages/cli/templates/{scaffolder-module => scaffolder-backend-module}/tsconfig.json (100%) delete mode 100644 packages/cli/templates/web-library-package.yaml rename packages/cli/templates/{web-library-package => web-library}/.eslintrc.js.hbs (100%) rename packages/cli/templates/{web-library-package => web-library}/README.md.hbs (100%) rename packages/cli/templates/{web-library-package => web-library}/package.json.hbs (100%) rename packages/cli/templates/{web-library-package => web-library}/src/index.ts.hbs (100%) rename packages/cli/templates/{web-library-package => web-library}/src/setupTests.ts (100%) create mode 100644 packages/cli/templates/web-library/template.yaml rename packages/cli/templates/{web-library-package => web-library}/tsconfig.json (100%) diff --git a/packages/cli/src/lib/new/defaultTemplates.ts b/packages/cli/src/lib/new/defaultTemplates.ts index e0c820f486..7784e046bd 100644 --- a/packages/cli/src/lib/new/defaultTemplates.ts +++ b/packages/cli/src/lib/new/defaultTemplates.ts @@ -17,64 +17,52 @@ export const defaultTemplates = [ { id: 'backend-module', - description: 'A new backend module that extends an existing backend plugin', target: require.resolve( '@backstage/cli/templates/default-backend-module.yaml', ), }, { id: 'backend-plugin', - description: 'A new backend plugin', target: require.resolve( '@backstage/cli/templates/default-backend-plugin.yaml', ), }, { id: 'plugin-common', - description: 'A new isomorphic common plugin package', target: require.resolve( '@backstage/cli/templates/default-common-plugin-package.yaml', ), }, { id: 'plugin-node', - description: 'A new Node.js library plugin package', target: require.resolve( '@backstage/cli/templates/default-node-plugin-package.yaml', ), }, { id: 'frontend-plugin', - description: 'A new frontend plugin', target: require.resolve('@backstage/cli/templates/default-plugin.yaml'), }, { id: 'plugin-react', - description: 'A new web library plugin package', target: require.resolve( '@backstage/cli/templates/default-react-plugin-package.yaml', ), }, { id: 'node-library', - description: - 'A library package, exporting shared functionality for Node.js environments', target: require.resolve( '@backstage/cli/templates/node-library-package.yaml', ), }, { id: 'web-library', - description: - 'A library package, exporting shared functionality for web environments', target: require.resolve( '@backstage/cli/templates/web-library-package.yaml', ), }, { id: 'scaffolder-module', - description: - 'A module exporting custom actions for @backstage/plugin-scaffolder-backend', target: require.resolve('@backstage/cli/templates/scaffolder-module.yaml'), }, ]; diff --git a/packages/cli/templates/default-backend-module/.eslintrc.js.hbs b/packages/cli/templates/backend-plugin-module/.eslintrc.js.hbs similarity index 100% rename from packages/cli/templates/default-backend-module/.eslintrc.js.hbs rename to packages/cli/templates/backend-plugin-module/.eslintrc.js.hbs diff --git a/packages/cli/templates/default-backend-module/README.md.hbs b/packages/cli/templates/backend-plugin-module/README.md.hbs similarity index 100% rename from packages/cli/templates/default-backend-module/README.md.hbs rename to packages/cli/templates/backend-plugin-module/README.md.hbs diff --git a/packages/cli/templates/default-backend-module/package.json.hbs b/packages/cli/templates/backend-plugin-module/package.json.hbs similarity index 100% rename from packages/cli/templates/default-backend-module/package.json.hbs rename to packages/cli/templates/backend-plugin-module/package.json.hbs diff --git a/packages/cli/templates/default-backend-module/src/index.ts.hbs b/packages/cli/templates/backend-plugin-module/src/index.ts.hbs similarity index 100% rename from packages/cli/templates/default-backend-module/src/index.ts.hbs rename to packages/cli/templates/backend-plugin-module/src/index.ts.hbs diff --git a/packages/cli/templates/default-backend-module/src/module.ts.hbs b/packages/cli/templates/backend-plugin-module/src/module.ts.hbs similarity index 100% rename from packages/cli/templates/default-backend-module/src/module.ts.hbs rename to packages/cli/templates/backend-plugin-module/src/module.ts.hbs diff --git a/packages/cli/templates/default-backend-module.yaml b/packages/cli/templates/backend-plugin-module/template.yaml similarity index 55% rename from packages/cli/templates/default-backend-module.yaml rename to packages/cli/templates/backend-plugin-module/template.yaml index 00aeb199c9..db424be55f 100644 --- a/packages/cli/templates/default-backend-module.yaml +++ b/packages/cli/templates/backend-plugin-module/template.yaml @@ -1,4 +1,5 @@ +name: backend-plugin-module role: backend-plugin-module -template: ./default-backend-module +description: A new backend module that extends an existing backend plugin templateValues: moduleVar: '{{ camelCase pluginId }}Module{{ upperFirst ( camelCase moduleId ) }}' diff --git a/packages/cli/templates/default-backend-module/tsconfig.json b/packages/cli/templates/backend-plugin-module/tsconfig.json similarity index 100% rename from packages/cli/templates/default-backend-module/tsconfig.json rename to packages/cli/templates/backend-plugin-module/tsconfig.json diff --git a/packages/cli/templates/default-backend-plugin/.eslintrc.js.hbs b/packages/cli/templates/backend-plugin/.eslintrc.js.hbs similarity index 100% rename from packages/cli/templates/default-backend-plugin/.eslintrc.js.hbs rename to packages/cli/templates/backend-plugin/.eslintrc.js.hbs diff --git a/packages/cli/templates/default-backend-plugin/README.md.hbs b/packages/cli/templates/backend-plugin/README.md.hbs similarity index 100% rename from packages/cli/templates/default-backend-plugin/README.md.hbs rename to packages/cli/templates/backend-plugin/README.md.hbs diff --git a/packages/cli/templates/default-backend-plugin/dev/index.ts.hbs b/packages/cli/templates/backend-plugin/dev/index.ts.hbs similarity index 100% rename from packages/cli/templates/default-backend-plugin/dev/index.ts.hbs rename to packages/cli/templates/backend-plugin/dev/index.ts.hbs diff --git a/packages/cli/templates/default-backend-plugin/package.json.hbs b/packages/cli/templates/backend-plugin/package.json.hbs similarity index 100% rename from packages/cli/templates/default-backend-plugin/package.json.hbs rename to packages/cli/templates/backend-plugin/package.json.hbs diff --git a/packages/cli/templates/default-backend-plugin/src/index.ts.hbs b/packages/cli/templates/backend-plugin/src/index.ts.hbs similarity index 100% rename from packages/cli/templates/default-backend-plugin/src/index.ts.hbs rename to packages/cli/templates/backend-plugin/src/index.ts.hbs diff --git a/packages/cli/templates/default-backend-plugin/src/plugin.test.ts.hbs b/packages/cli/templates/backend-plugin/src/plugin.test.ts.hbs similarity index 100% rename from packages/cli/templates/default-backend-plugin/src/plugin.test.ts.hbs rename to packages/cli/templates/backend-plugin/src/plugin.test.ts.hbs diff --git a/packages/cli/templates/default-backend-plugin/src/plugin.ts.hbs b/packages/cli/templates/backend-plugin/src/plugin.ts.hbs similarity index 100% rename from packages/cli/templates/default-backend-plugin/src/plugin.ts.hbs rename to packages/cli/templates/backend-plugin/src/plugin.ts.hbs diff --git a/packages/cli/templates/default-backend-plugin/src/router.test.ts b/packages/cli/templates/backend-plugin/src/router.test.ts similarity index 100% rename from packages/cli/templates/default-backend-plugin/src/router.test.ts rename to packages/cli/templates/backend-plugin/src/router.test.ts diff --git a/packages/cli/templates/default-backend-plugin/src/router.ts b/packages/cli/templates/backend-plugin/src/router.ts similarity index 100% rename from packages/cli/templates/default-backend-plugin/src/router.ts rename to packages/cli/templates/backend-plugin/src/router.ts diff --git a/packages/cli/templates/default-backend-plugin/src/services/TodoListService/createTodoListService.ts b/packages/cli/templates/backend-plugin/src/services/TodoListService/createTodoListService.ts similarity index 100% rename from packages/cli/templates/default-backend-plugin/src/services/TodoListService/createTodoListService.ts rename to packages/cli/templates/backend-plugin/src/services/TodoListService/createTodoListService.ts diff --git a/packages/cli/templates/default-backend-plugin/src/services/TodoListService/index.ts b/packages/cli/templates/backend-plugin/src/services/TodoListService/index.ts similarity index 100% rename from packages/cli/templates/default-backend-plugin/src/services/TodoListService/index.ts rename to packages/cli/templates/backend-plugin/src/services/TodoListService/index.ts diff --git a/packages/cli/templates/default-backend-plugin/src/services/TodoListService/types.ts b/packages/cli/templates/backend-plugin/src/services/TodoListService/types.ts similarity index 100% rename from packages/cli/templates/default-backend-plugin/src/services/TodoListService/types.ts rename to packages/cli/templates/backend-plugin/src/services/TodoListService/types.ts diff --git a/packages/cli/templates/default-backend-plugin/src/setupTests.ts b/packages/cli/templates/backend-plugin/src/setupTests.ts similarity index 100% rename from packages/cli/templates/default-backend-plugin/src/setupTests.ts rename to packages/cli/templates/backend-plugin/src/setupTests.ts diff --git a/packages/cli/templates/default-backend-plugin.yaml b/packages/cli/templates/backend-plugin/template.yaml similarity index 60% rename from packages/cli/templates/default-backend-plugin.yaml rename to packages/cli/templates/backend-plugin/template.yaml index 17387fbec8..dd7d7386e7 100644 --- a/packages/cli/templates/default-backend-plugin.yaml +++ b/packages/cli/templates/backend-plugin/template.yaml @@ -1,4 +1,5 @@ +name: backend-plugin role: backend-plugin -template: ./default-backend-plugin +description: A new backend plugin templateValues: pluginVar: '{{ camelCase pluginId }}Plugin' diff --git a/packages/cli/templates/default-backend-plugin/tsconfig.json b/packages/cli/templates/backend-plugin/tsconfig.json similarity index 100% rename from packages/cli/templates/default-backend-plugin/tsconfig.json rename to packages/cli/templates/backend-plugin/tsconfig.json diff --git a/packages/cli/templates/default-common-plugin-package.yaml b/packages/cli/templates/default-common-plugin-package.yaml deleted file mode 100644 index f187f15423..0000000000 --- a/packages/cli/templates/default-common-plugin-package.yaml +++ /dev/null @@ -1,2 +0,0 @@ -role: plugin-common-library -template: ./default-common-plugin-package diff --git a/packages/cli/templates/default-node-plugin-package.yaml b/packages/cli/templates/default-node-plugin-package.yaml deleted file mode 100644 index 02a4e18f2a..0000000000 --- a/packages/cli/templates/default-node-plugin-package.yaml +++ /dev/null @@ -1,2 +0,0 @@ -role: plugin-node-library -template: ./default-node-plugin-package diff --git a/packages/cli/templates/default-react-plugin-package.yaml b/packages/cli/templates/default-react-plugin-package.yaml deleted file mode 100644 index 8d9d234c83..0000000000 --- a/packages/cli/templates/default-react-plugin-package.yaml +++ /dev/null @@ -1,2 +0,0 @@ -role: plugin-web-library -template: ./default-react-plugin-package diff --git a/packages/cli/templates/default-common-plugin-package/.eslintrc.js.hbs b/packages/cli/templates/frontend-plugin/.eslintrc.js.hbs similarity index 100% rename from packages/cli/templates/default-common-plugin-package/.eslintrc.js.hbs rename to packages/cli/templates/frontend-plugin/.eslintrc.js.hbs diff --git a/packages/cli/templates/default-plugin/README.md.hbs b/packages/cli/templates/frontend-plugin/README.md.hbs similarity index 100% rename from packages/cli/templates/default-plugin/README.md.hbs rename to packages/cli/templates/frontend-plugin/README.md.hbs diff --git a/packages/cli/templates/default-plugin/dev/index.tsx.hbs b/packages/cli/templates/frontend-plugin/dev/index.tsx.hbs similarity index 100% rename from packages/cli/templates/default-plugin/dev/index.tsx.hbs rename to packages/cli/templates/frontend-plugin/dev/index.tsx.hbs diff --git a/packages/cli/templates/default-plugin/package.json.hbs b/packages/cli/templates/frontend-plugin/package.json.hbs similarity index 100% rename from packages/cli/templates/default-plugin/package.json.hbs rename to packages/cli/templates/frontend-plugin/package.json.hbs diff --git a/packages/cli/templates/default-plugin/src/components/ExampleComponent/ExampleComponent.test.tsx.hbs b/packages/cli/templates/frontend-plugin/src/components/ExampleComponent/ExampleComponent.test.tsx.hbs similarity index 100% rename from packages/cli/templates/default-plugin/src/components/ExampleComponent/ExampleComponent.test.tsx.hbs rename to packages/cli/templates/frontend-plugin/src/components/ExampleComponent/ExampleComponent.test.tsx.hbs diff --git a/packages/cli/templates/default-plugin/src/components/ExampleComponent/ExampleComponent.tsx.hbs b/packages/cli/templates/frontend-plugin/src/components/ExampleComponent/ExampleComponent.tsx.hbs similarity index 100% rename from packages/cli/templates/default-plugin/src/components/ExampleComponent/ExampleComponent.tsx.hbs rename to packages/cli/templates/frontend-plugin/src/components/ExampleComponent/ExampleComponent.tsx.hbs diff --git a/packages/cli/templates/default-plugin/src/components/ExampleComponent/index.ts b/packages/cli/templates/frontend-plugin/src/components/ExampleComponent/index.ts similarity index 100% rename from packages/cli/templates/default-plugin/src/components/ExampleComponent/index.ts rename to packages/cli/templates/frontend-plugin/src/components/ExampleComponent/index.ts diff --git a/packages/cli/templates/default-plugin/src/components/ExampleFetchComponent/ExampleFetchComponent.test.tsx.hbs b/packages/cli/templates/frontend-plugin/src/components/ExampleFetchComponent/ExampleFetchComponent.test.tsx.hbs similarity index 100% rename from packages/cli/templates/default-plugin/src/components/ExampleFetchComponent/ExampleFetchComponent.test.tsx.hbs rename to packages/cli/templates/frontend-plugin/src/components/ExampleFetchComponent/ExampleFetchComponent.test.tsx.hbs diff --git a/packages/cli/templates/default-plugin/src/components/ExampleFetchComponent/ExampleFetchComponent.tsx.hbs b/packages/cli/templates/frontend-plugin/src/components/ExampleFetchComponent/ExampleFetchComponent.tsx.hbs similarity index 100% rename from packages/cli/templates/default-plugin/src/components/ExampleFetchComponent/ExampleFetchComponent.tsx.hbs rename to packages/cli/templates/frontend-plugin/src/components/ExampleFetchComponent/ExampleFetchComponent.tsx.hbs diff --git a/packages/cli/templates/default-plugin/src/components/ExampleFetchComponent/index.ts b/packages/cli/templates/frontend-plugin/src/components/ExampleFetchComponent/index.ts similarity index 100% rename from packages/cli/templates/default-plugin/src/components/ExampleFetchComponent/index.ts rename to packages/cli/templates/frontend-plugin/src/components/ExampleFetchComponent/index.ts diff --git a/packages/cli/templates/default-plugin/src/index.ts.hbs b/packages/cli/templates/frontend-plugin/src/index.ts.hbs similarity index 100% rename from packages/cli/templates/default-plugin/src/index.ts.hbs rename to packages/cli/templates/frontend-plugin/src/index.ts.hbs diff --git a/packages/cli/templates/default-plugin/src/plugin.test.ts.hbs b/packages/cli/templates/frontend-plugin/src/plugin.test.ts.hbs similarity index 100% rename from packages/cli/templates/default-plugin/src/plugin.test.ts.hbs rename to packages/cli/templates/frontend-plugin/src/plugin.test.ts.hbs diff --git a/packages/cli/templates/default-plugin/src/plugin.ts.hbs b/packages/cli/templates/frontend-plugin/src/plugin.ts.hbs similarity index 100% rename from packages/cli/templates/default-plugin/src/plugin.ts.hbs rename to packages/cli/templates/frontend-plugin/src/plugin.ts.hbs diff --git a/packages/cli/templates/default-plugin/src/routes.ts.hbs b/packages/cli/templates/frontend-plugin/src/routes.ts.hbs similarity index 100% rename from packages/cli/templates/default-plugin/src/routes.ts.hbs rename to packages/cli/templates/frontend-plugin/src/routes.ts.hbs diff --git a/packages/cli/templates/default-plugin/src/setupTests.ts b/packages/cli/templates/frontend-plugin/src/setupTests.ts similarity index 100% rename from packages/cli/templates/default-plugin/src/setupTests.ts rename to packages/cli/templates/frontend-plugin/src/setupTests.ts diff --git a/packages/cli/templates/default-plugin.yaml b/packages/cli/templates/frontend-plugin/template.yaml similarity index 72% rename from packages/cli/templates/default-plugin.yaml rename to packages/cli/templates/frontend-plugin/template.yaml index c4f5aa4d40..454079c117 100644 --- a/packages/cli/templates/default-plugin.yaml +++ b/packages/cli/templates/frontend-plugin/template.yaml @@ -1,5 +1,6 @@ +name: frontend-plugin role: frontend-plugin -template: ./default-plugin +description: A new frontend plugin templateValues: pluginVar: '{{ camelCase pluginId }}Plugin' extensionName: '{{ upperFirst ( camelCase pluginId ) }}Page' diff --git a/packages/cli/templates/default-plugin/tsconfig.json b/packages/cli/templates/frontend-plugin/tsconfig.json similarity index 100% rename from packages/cli/templates/default-plugin/tsconfig.json rename to packages/cli/templates/frontend-plugin/tsconfig.json diff --git a/packages/cli/templates/node-library-package.yaml b/packages/cli/templates/node-library-package.yaml deleted file mode 100644 index 4f715f97d1..0000000000 --- a/packages/cli/templates/node-library-package.yaml +++ /dev/null @@ -1,2 +0,0 @@ -role: node-library -template: ./node-library-package diff --git a/packages/cli/templates/default-node-plugin-package/.eslintrc.js.hbs b/packages/cli/templates/node-library/.eslintrc.js.hbs similarity index 100% rename from packages/cli/templates/default-node-plugin-package/.eslintrc.js.hbs rename to packages/cli/templates/node-library/.eslintrc.js.hbs diff --git a/packages/cli/templates/node-library-package/README.md.hbs b/packages/cli/templates/node-library/README.md.hbs similarity index 100% rename from packages/cli/templates/node-library-package/README.md.hbs rename to packages/cli/templates/node-library/README.md.hbs diff --git a/packages/cli/templates/node-library-package/package.json.hbs b/packages/cli/templates/node-library/package.json.hbs similarity index 100% rename from packages/cli/templates/node-library-package/package.json.hbs rename to packages/cli/templates/node-library/package.json.hbs diff --git a/packages/cli/templates/node-library-package/src/index.ts.hbs b/packages/cli/templates/node-library/src/index.ts.hbs similarity index 100% rename from packages/cli/templates/node-library-package/src/index.ts.hbs rename to packages/cli/templates/node-library/src/index.ts.hbs diff --git a/packages/cli/templates/default-common-plugin-package/src/setupTests.ts b/packages/cli/templates/node-library/src/setupTests.ts similarity index 100% rename from packages/cli/templates/default-common-plugin-package/src/setupTests.ts rename to packages/cli/templates/node-library/src/setupTests.ts diff --git a/packages/cli/templates/node-library/template.yaml b/packages/cli/templates/node-library/template.yaml new file mode 100644 index 0000000000..a49f31043d --- /dev/null +++ b/packages/cli/templates/node-library/template.yaml @@ -0,0 +1,3 @@ +name: node-library +role: node-library +description: A library package, exporting shared functionality for Node.js environments diff --git a/packages/cli/templates/default-react-plugin-package/tsconfig.json b/packages/cli/templates/node-library/tsconfig.json similarity index 100% rename from packages/cli/templates/default-react-plugin-package/tsconfig.json rename to packages/cli/templates/node-library/tsconfig.json diff --git a/packages/cli/templates/default-plugin/.eslintrc.js.hbs b/packages/cli/templates/plugin-common-library/.eslintrc.js.hbs similarity index 100% rename from packages/cli/templates/default-plugin/.eslintrc.js.hbs rename to packages/cli/templates/plugin-common-library/.eslintrc.js.hbs diff --git a/packages/cli/templates/default-common-plugin-package/README.md.hbs b/packages/cli/templates/plugin-common-library/README.md.hbs similarity index 100% rename from packages/cli/templates/default-common-plugin-package/README.md.hbs rename to packages/cli/templates/plugin-common-library/README.md.hbs diff --git a/packages/cli/templates/default-common-plugin-package/package.json.hbs b/packages/cli/templates/plugin-common-library/package.json.hbs similarity index 100% rename from packages/cli/templates/default-common-plugin-package/package.json.hbs rename to packages/cli/templates/plugin-common-library/package.json.hbs diff --git a/packages/cli/templates/default-common-plugin-package/src/index.ts.hbs b/packages/cli/templates/plugin-common-library/src/index.ts.hbs similarity index 100% rename from packages/cli/templates/default-common-plugin-package/src/index.ts.hbs rename to packages/cli/templates/plugin-common-library/src/index.ts.hbs diff --git a/packages/cli/templates/default-node-plugin-package/src/setupTests.ts b/packages/cli/templates/plugin-common-library/src/setupTests.ts similarity index 100% rename from packages/cli/templates/default-node-plugin-package/src/setupTests.ts rename to packages/cli/templates/plugin-common-library/src/setupTests.ts diff --git a/packages/cli/templates/plugin-common-library/template.yaml b/packages/cli/templates/plugin-common-library/template.yaml new file mode 100644 index 0000000000..34414bd10c --- /dev/null +++ b/packages/cli/templates/plugin-common-library/template.yaml @@ -0,0 +1,3 @@ +name: plugin-common-library +role: plugin-common-library +description: A new isomorphic common plugin package diff --git a/packages/cli/templates/default-common-plugin-package/tsconfig.json b/packages/cli/templates/plugin-common-library/tsconfig.json similarity index 100% rename from packages/cli/templates/default-common-plugin-package/tsconfig.json rename to packages/cli/templates/plugin-common-library/tsconfig.json diff --git a/packages/cli/templates/default-react-plugin-package/.eslintrc.js.hbs b/packages/cli/templates/plugin-node-library/.eslintrc.js.hbs similarity index 100% rename from packages/cli/templates/default-react-plugin-package/.eslintrc.js.hbs rename to packages/cli/templates/plugin-node-library/.eslintrc.js.hbs diff --git a/packages/cli/templates/default-node-plugin-package/README.md.hbs b/packages/cli/templates/plugin-node-library/README.md.hbs similarity index 100% rename from packages/cli/templates/default-node-plugin-package/README.md.hbs rename to packages/cli/templates/plugin-node-library/README.md.hbs diff --git a/packages/cli/templates/default-node-plugin-package/package.json.hbs b/packages/cli/templates/plugin-node-library/package.json.hbs similarity index 100% rename from packages/cli/templates/default-node-plugin-package/package.json.hbs rename to packages/cli/templates/plugin-node-library/package.json.hbs diff --git a/packages/cli/templates/default-node-plugin-package/src/index.ts.hbs b/packages/cli/templates/plugin-node-library/src/index.ts.hbs similarity index 100% rename from packages/cli/templates/default-node-plugin-package/src/index.ts.hbs rename to packages/cli/templates/plugin-node-library/src/index.ts.hbs diff --git a/packages/cli/templates/node-library-package/src/setupTests.ts b/packages/cli/templates/plugin-node-library/src/setupTests.ts similarity index 100% rename from packages/cli/templates/node-library-package/src/setupTests.ts rename to packages/cli/templates/plugin-node-library/src/setupTests.ts diff --git a/packages/cli/templates/plugin-node-library/template.yaml b/packages/cli/templates/plugin-node-library/template.yaml new file mode 100644 index 0000000000..e71a55d40a --- /dev/null +++ b/packages/cli/templates/plugin-node-library/template.yaml @@ -0,0 +1,3 @@ +name: plugin-node-library +role: plugin-node-library +description: A new Node.js library plugin package diff --git a/packages/cli/templates/default-node-plugin-package/tsconfig.json b/packages/cli/templates/plugin-node-library/tsconfig.json similarity index 100% rename from packages/cli/templates/default-node-plugin-package/tsconfig.json rename to packages/cli/templates/plugin-node-library/tsconfig.json diff --git a/packages/cli/templates/node-library-package/.eslintrc.js.hbs b/packages/cli/templates/plugin-web-library/.eslintrc.js.hbs similarity index 100% rename from packages/cli/templates/node-library-package/.eslintrc.js.hbs rename to packages/cli/templates/plugin-web-library/.eslintrc.js.hbs diff --git a/packages/cli/templates/default-react-plugin-package/README.md.hbs b/packages/cli/templates/plugin-web-library/README.md.hbs similarity index 100% rename from packages/cli/templates/default-react-plugin-package/README.md.hbs rename to packages/cli/templates/plugin-web-library/README.md.hbs diff --git a/packages/cli/templates/default-react-plugin-package/package.json.hbs b/packages/cli/templates/plugin-web-library/package.json.hbs similarity index 100% rename from packages/cli/templates/default-react-plugin-package/package.json.hbs rename to packages/cli/templates/plugin-web-library/package.json.hbs diff --git a/packages/cli/templates/default-react-plugin-package/src/components/ExampleComponent/ExampleComponent.test.tsx b/packages/cli/templates/plugin-web-library/src/components/ExampleComponent/ExampleComponent.test.tsx similarity index 100% rename from packages/cli/templates/default-react-plugin-package/src/components/ExampleComponent/ExampleComponent.test.tsx rename to packages/cli/templates/plugin-web-library/src/components/ExampleComponent/ExampleComponent.test.tsx diff --git a/packages/cli/templates/default-react-plugin-package/src/components/ExampleComponent/ExampleComponent.tsx b/packages/cli/templates/plugin-web-library/src/components/ExampleComponent/ExampleComponent.tsx similarity index 100% rename from packages/cli/templates/default-react-plugin-package/src/components/ExampleComponent/ExampleComponent.tsx rename to packages/cli/templates/plugin-web-library/src/components/ExampleComponent/ExampleComponent.tsx diff --git a/packages/cli/templates/default-react-plugin-package/src/components/ExampleComponent/index.ts b/packages/cli/templates/plugin-web-library/src/components/ExampleComponent/index.ts similarity index 100% rename from packages/cli/templates/default-react-plugin-package/src/components/ExampleComponent/index.ts rename to packages/cli/templates/plugin-web-library/src/components/ExampleComponent/index.ts diff --git a/packages/cli/templates/default-react-plugin-package/src/components/index.ts b/packages/cli/templates/plugin-web-library/src/components/index.ts similarity index 100% rename from packages/cli/templates/default-react-plugin-package/src/components/index.ts rename to packages/cli/templates/plugin-web-library/src/components/index.ts diff --git a/packages/cli/templates/default-react-plugin-package/src/hooks/index.ts b/packages/cli/templates/plugin-web-library/src/hooks/index.ts similarity index 100% rename from packages/cli/templates/default-react-plugin-package/src/hooks/index.ts rename to packages/cli/templates/plugin-web-library/src/hooks/index.ts diff --git a/packages/cli/templates/default-react-plugin-package/src/hooks/useExample/index.ts b/packages/cli/templates/plugin-web-library/src/hooks/useExample/index.ts similarity index 100% rename from packages/cli/templates/default-react-plugin-package/src/hooks/useExample/index.ts rename to packages/cli/templates/plugin-web-library/src/hooks/useExample/index.ts diff --git a/packages/cli/templates/default-react-plugin-package/src/hooks/useExample/useExample.ts b/packages/cli/templates/plugin-web-library/src/hooks/useExample/useExample.ts similarity index 100% rename from packages/cli/templates/default-react-plugin-package/src/hooks/useExample/useExample.ts rename to packages/cli/templates/plugin-web-library/src/hooks/useExample/useExample.ts diff --git a/packages/cli/templates/default-react-plugin-package/src/index.ts.hbs b/packages/cli/templates/plugin-web-library/src/index.ts.hbs similarity index 100% rename from packages/cli/templates/default-react-plugin-package/src/index.ts.hbs rename to packages/cli/templates/plugin-web-library/src/index.ts.hbs diff --git a/packages/cli/templates/default-react-plugin-package/src/setupTests.ts b/packages/cli/templates/plugin-web-library/src/setupTests.ts similarity index 100% rename from packages/cli/templates/default-react-plugin-package/src/setupTests.ts rename to packages/cli/templates/plugin-web-library/src/setupTests.ts diff --git a/packages/cli/templates/plugin-web-library/template.yaml b/packages/cli/templates/plugin-web-library/template.yaml new file mode 100644 index 0000000000..19be5e79a3 --- /dev/null +++ b/packages/cli/templates/plugin-web-library/template.yaml @@ -0,0 +1,3 @@ +name: plugin-web-library +role: plugin-web-library +description: A new web library plugin package diff --git a/packages/cli/templates/node-library-package/tsconfig.json b/packages/cli/templates/plugin-web-library/tsconfig.json similarity index 100% rename from packages/cli/templates/node-library-package/tsconfig.json rename to packages/cli/templates/plugin-web-library/tsconfig.json diff --git a/packages/cli/templates/scaffolder-module/.eslintrc.js.hbs b/packages/cli/templates/scaffolder-backend-module/.eslintrc.js.hbs similarity index 100% rename from packages/cli/templates/scaffolder-module/.eslintrc.js.hbs rename to packages/cli/templates/scaffolder-backend-module/.eslintrc.js.hbs diff --git a/packages/cli/templates/scaffolder-module/README.md.hbs b/packages/cli/templates/scaffolder-backend-module/README.md.hbs similarity index 100% rename from packages/cli/templates/scaffolder-module/README.md.hbs rename to packages/cli/templates/scaffolder-backend-module/README.md.hbs diff --git a/packages/cli/templates/scaffolder-module/package.json.hbs b/packages/cli/templates/scaffolder-backend-module/package.json.hbs similarity index 100% rename from packages/cli/templates/scaffolder-module/package.json.hbs rename to packages/cli/templates/scaffolder-backend-module/package.json.hbs diff --git a/packages/cli/templates/scaffolder-module/src/actions/example.test.ts b/packages/cli/templates/scaffolder-backend-module/src/actions/example.test.ts similarity index 100% rename from packages/cli/templates/scaffolder-module/src/actions/example.test.ts rename to packages/cli/templates/scaffolder-backend-module/src/actions/example.test.ts diff --git a/packages/cli/templates/scaffolder-module/src/actions/example.ts b/packages/cli/templates/scaffolder-backend-module/src/actions/example.ts similarity index 100% rename from packages/cli/templates/scaffolder-module/src/actions/example.ts rename to packages/cli/templates/scaffolder-backend-module/src/actions/example.ts diff --git a/packages/cli/templates/scaffolder-module/src/index.ts.hbs b/packages/cli/templates/scaffolder-backend-module/src/index.ts.hbs similarity index 100% rename from packages/cli/templates/scaffolder-module/src/index.ts.hbs rename to packages/cli/templates/scaffolder-backend-module/src/index.ts.hbs diff --git a/packages/cli/templates/scaffolder-module/src/module.ts b/packages/cli/templates/scaffolder-backend-module/src/module.ts similarity index 100% rename from packages/cli/templates/scaffolder-module/src/module.ts rename to packages/cli/templates/scaffolder-backend-module/src/module.ts diff --git a/packages/cli/templates/scaffolder-module.yaml b/packages/cli/templates/scaffolder-backend-module/template.yaml similarity index 57% rename from packages/cli/templates/scaffolder-module.yaml rename to packages/cli/templates/scaffolder-backend-module/template.yaml index fb43ee7c5c..f223686a7b 100644 --- a/packages/cli/templates/scaffolder-module.yaml +++ b/packages/cli/templates/scaffolder-backend-module/template.yaml @@ -1,5 +1,6 @@ +name: scaffolder-backend-module role: backend-plugin-module -template: ./scaffolder-module +description: A module exporting custom actions for @backstage/plugin-scaffolder-backend parameters: pluginId: scaffolder templateValues: diff --git a/packages/cli/templates/scaffolder-module/tsconfig.json b/packages/cli/templates/scaffolder-backend-module/tsconfig.json similarity index 100% rename from packages/cli/templates/scaffolder-module/tsconfig.json rename to packages/cli/templates/scaffolder-backend-module/tsconfig.json diff --git a/packages/cli/templates/web-library-package.yaml b/packages/cli/templates/web-library-package.yaml deleted file mode 100644 index dccdea49cb..0000000000 --- a/packages/cli/templates/web-library-package.yaml +++ /dev/null @@ -1,2 +0,0 @@ -role: web-library -template: ./web-library-package diff --git a/packages/cli/templates/web-library-package/.eslintrc.js.hbs b/packages/cli/templates/web-library/.eslintrc.js.hbs similarity index 100% rename from packages/cli/templates/web-library-package/.eslintrc.js.hbs rename to packages/cli/templates/web-library/.eslintrc.js.hbs diff --git a/packages/cli/templates/web-library-package/README.md.hbs b/packages/cli/templates/web-library/README.md.hbs similarity index 100% rename from packages/cli/templates/web-library-package/README.md.hbs rename to packages/cli/templates/web-library/README.md.hbs diff --git a/packages/cli/templates/web-library-package/package.json.hbs b/packages/cli/templates/web-library/package.json.hbs similarity index 100% rename from packages/cli/templates/web-library-package/package.json.hbs rename to packages/cli/templates/web-library/package.json.hbs diff --git a/packages/cli/templates/web-library-package/src/index.ts.hbs b/packages/cli/templates/web-library/src/index.ts.hbs similarity index 100% rename from packages/cli/templates/web-library-package/src/index.ts.hbs rename to packages/cli/templates/web-library/src/index.ts.hbs diff --git a/packages/cli/templates/web-library-package/src/setupTests.ts b/packages/cli/templates/web-library/src/setupTests.ts similarity index 100% rename from packages/cli/templates/web-library-package/src/setupTests.ts rename to packages/cli/templates/web-library/src/setupTests.ts diff --git a/packages/cli/templates/web-library/template.yaml b/packages/cli/templates/web-library/template.yaml new file mode 100644 index 0000000000..595fc13616 --- /dev/null +++ b/packages/cli/templates/web-library/template.yaml @@ -0,0 +1,3 @@ +name: web-library +role: web-library +description: A library package, exporting shared functionality for web environments diff --git a/packages/cli/templates/web-library-package/tsconfig.json b/packages/cli/templates/web-library/tsconfig.json similarity index 100% rename from packages/cli/templates/web-library-package/tsconfig.json rename to packages/cli/templates/web-library/tsconfig.json