|
| 1 | +const kebabCase = require('lodash.kebabcase'); |
| 2 | +const startCase = require('lodash.startcase'); |
| 3 | +const config = require('./config.json'); |
| 4 | +const packageJson = require('./package.json'); |
| 5 | + |
| 6 | +module.exports = { |
| 7 | + description: 'Scaffolding out a new ods component.', |
| 8 | + templateDir: 'template', |
| 9 | + transformerOptions: { |
| 10 | + context: { |
| 11 | + kebabCase, |
| 12 | + startCase, |
| 13 | + }, |
| 14 | + }, |
| 15 | + prompts() { |
| 16 | + return [ |
| 17 | + { |
| 18 | + name: 'name', |
| 19 | + message: 'Component name ?', |
| 20 | + default: 'My Awesome Component', |
| 21 | + }, |
| 22 | + { |
| 23 | + name: 'packageDescription', |
| 24 | + message: 'Component description ?', |
| 25 | + default: 'Component to do awesome things', |
| 26 | + } |
| 27 | + ]; |
| 28 | + }, |
| 29 | + actions() { |
| 30 | + const templateData = { |
| 31 | + name: kebabCase(this.answers.name), |
| 32 | + packageVersion: packageJson.version, |
| 33 | + componentName: startCase(this.answers.name).replace(/\s/gmi, ''), |
| 34 | + componentFolderName: `${kebabCase(this.answers.name)}`, |
| 35 | + componentFileNamePrefix: `${config.corePrefix}-${kebabCase(this.answers.name)}`, |
| 36 | + stencilPrefix: config.stencilPrefix |
| 37 | + }; |
| 38 | + return [ |
| 39 | + // Add all template files |
| 40 | + { |
| 41 | + type: 'add', |
| 42 | + files: '**', |
| 43 | + templateData |
| 44 | + }, |
| 45 | + |
| 46 | + // Move Core files |
| 47 | + { |
| 48 | + type: 'move', |
| 49 | + patterns: { |
| 50 | + 'core/component.ts': `${config.outDir}/${config.odsCorePath}/${templateData.componentFolderName}/${templateData.componentFileNamePrefix}.ts`, |
| 51 | + 'core/component-attributes.ts': `${config.outDir}/${config.odsCorePath}/${templateData.componentFolderName}/${templateData.componentFileNamePrefix}-attributes.ts`, |
| 52 | + 'core/component-controller.ts': `${config.outDir}/${config.odsCorePath}/${templateData.componentFolderName}/${templateData.componentFileNamePrefix}-controller.ts`, |
| 53 | + 'core/component-default-attributes.ts': `${config.outDir}/${config.odsCorePath}/${templateData.componentFolderName}/${templateData.componentFileNamePrefix}-default-attributes.ts`, |
| 54 | + 'core/component-events.ts': `${config.outDir}/${config.odsCorePath}/${templateData.componentFolderName}/${templateData.componentFileNamePrefix}-events.ts`, |
| 55 | + 'core/component-methods.ts': `${config.outDir}/${config.odsCorePath}/${templateData.componentFolderName}/${templateData.componentFileNamePrefix}-methods.ts`, |
| 56 | + 'core/public-api.ts': `${config.outDir}/${config.odsCorePath}/${templateData.componentFolderName}/public-api.ts`, |
| 57 | + } |
| 58 | + }, |
| 59 | + { |
| 60 | + type: 'modify', |
| 61 | + files: `${config.outDir}/${config.odsCorePath}/public-api.ts`, |
| 62 | + handler(data) { |
| 63 | + return data + `export * from './${templateData.componentFolderName}/public-api';` |
| 64 | + } |
| 65 | + }, |
| 66 | + |
| 67 | + // Move Specifications files |
| 68 | + { |
| 69 | + type: 'move', |
| 70 | + patterns: { |
| 71 | + 'specifications/specifications-component.mdx': `${config.outDir}/${config.odsSpecificationsPath}/${templateData.name}/specifications-${templateData.name}.mdx`, |
| 72 | + 'specifications/specifications-component-contents.mdx': `${config.outDir}/${config.odsSpecificationsPath}/${templateData.name}/specifications-${templateData.name}-contents.mdx`, |
| 73 | + 'specifications/specifications-component-events.mdx': `${config.outDir}/${config.odsSpecificationsPath}/${templateData.name}/specifications-${templateData.name}-events.mdx`, |
| 74 | + 'specifications/specifications-component-methods.mdx': `${config.outDir}/${config.odsSpecificationsPath}/${templateData.name}/specifications-${templateData.name}-methods.mdx`, |
| 75 | + 'specifications/specifications-component-properties.mdx': `${config.outDir}/${config.odsSpecificationsPath}/${templateData.name}/specifications-${templateData.name}-properties.mdx`, |
| 76 | + 'specifications/specifications-component-tests.mdx': `${config.outDir}/${config.odsSpecificationsPath}/${templateData.name}/specifications-${templateData.name}-tests.mdx`, |
| 77 | + } |
| 78 | + }, |
| 79 | + |
| 80 | + // Move Storybook files |
| 81 | + { |
| 82 | + type: 'move', |
| 83 | + patterns: { |
| 84 | + 'storybook/component.design.stories.mdx': `${config.outDir}/${config.odsStorybookPath}/${templateData.name}/${templateData.name}.design.stories.mdx`, |
| 85 | + 'storybook/component.specifications.stories.mdx': `${config.outDir}/${config.odsStorybookPath}/${templateData.name}/${templateData.name}.specifications.stories.mdx`, |
| 86 | + 'storybook/component.web-component.stories.page.mdx': `${config.outDir}/${config.odsStorybookPath}/${templateData.name}/${templateData.name}.web-component.stories.page.mdx`, |
| 87 | + 'storybook/component.web-components.stories.ts': `${config.outDir}/${config.odsStorybookPath}/${templateData.name}/${templateData.name}.web-components.stories.ts`, |
| 88 | + } |
| 89 | + }, |
| 90 | + |
| 91 | + // Move Stencil files |
| 92 | + { |
| 93 | + type: 'move', |
| 94 | + patterns: { |
| 95 | + // Root |
| 96 | + 'stencil/.gitignore': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/.gitignore`, |
| 97 | + 'stencil/.npmignore': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/.npmignore`, |
| 98 | + 'stencil/CHANGELOG.md': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/CHANGELOG.md`, |
| 99 | + 'stencil/jest.config.ts': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/jest.config.ts`, |
| 100 | + 'stencil/package.json': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/package.json`, |
| 101 | + 'stencil/stencil.config.ts': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/stencil.config.ts`, |
| 102 | + 'stencil/THIRD-PARTY-LICENCES': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/THIRD-PARTY-LICENCES`, |
| 103 | + 'stencil/tsconfig.dev.json': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/tsconfig.dev.json`, |
| 104 | + 'stencil/tsconfig.json': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/tsconfig.json`, |
| 105 | + 'stencil/tsconfig.prod.json': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/tsconfig.prod.json`, |
| 106 | + 'stencil/typedoc.json': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/typedoc.json`, |
| 107 | + // Sources |
| 108 | + 'stencil/src/global.dev.ts': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/src/global.dev.ts`, |
| 109 | + 'stencil/src/global.prod.ts': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/src/global.prod.ts`, |
| 110 | + 'stencil/src/global.ts': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/src/global.ts`, |
| 111 | + 'stencil/src/index.html': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/src/index.html`, |
| 112 | + 'stencil/src/index.ts': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/src/index.ts`, |
| 113 | + 'stencil/src/components/osds-component/osds-component.e2e.screenshot.ts': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/src/components/${config.stencilPrefix}-${templateData.name}/${config.stencilPrefix}-${templateData.name}.e2e.screenshot.ts`, |
| 114 | + 'stencil/src/components/osds-component/osds-component.e2e.ts': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/src/components/${config.stencilPrefix}-${templateData.name}/${config.stencilPrefix}-${templateData.name}.e2e.ts`, |
| 115 | + 'stencil/src/components/osds-component/osds-component.scss': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/src/components/${config.stencilPrefix}-${templateData.name}/${config.stencilPrefix}-${templateData.name}.scss`, |
| 116 | + 'stencil/src/components/osds-component/osds-component.spec.ts': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/src/components/${config.stencilPrefix}-${templateData.name}/${config.stencilPrefix}-${templateData.name}.spec.ts`, |
| 117 | + 'stencil/src/components/osds-component/osds-component.tsx': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/src/components/${config.stencilPrefix}-${templateData.name}/${config.stencilPrefix}-${templateData.name}.tsx`, |
| 118 | + 'stencil/src/components/osds-component/public-api.ts': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/src/components/${config.stencilPrefix}-${templateData.name}/public-api.ts`, |
| 119 | + 'stencil/src/components/osds-component/styles/osds-component.color.scss': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/src/components/${config.stencilPrefix}-${templateData.name}/styles/${config.stencilPrefix}-${templateData.name}.color.scss`, |
| 120 | + 'stencil/src/components/osds-component/styles/osds-component.mixins.scss': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/src/components/${config.stencilPrefix}-${templateData.name}/styles/${config.stencilPrefix}-${templateData.name}.mixins.scss`, |
| 121 | + 'stencil/src/components/osds-component/styles/osds-component.size.scss': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/src/components/${config.stencilPrefix}-${templateData.name}/styles/${config.stencilPrefix}-${templateData.name}.size.scss`, |
| 122 | + 'stencil/src/components/osds-component/styles/osds-component.typography.scss': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/src/components/${config.stencilPrefix}-${templateData.name}/styles/${config.stencilPrefix}-${templateData.name}.typography.scss`, |
| 123 | + 'stencil/src/docs/osds-component/usage.mdx': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/src/docs/${config.stencilPrefix}-${templateData.name}/usage.mdx`, |
| 124 | + // React adapter |
| 125 | + 'stencil/react/.gitignore': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/react/.gitignore`, |
| 126 | + 'stencil/react/.npmignore': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/react/.npmignore`, |
| 127 | + 'stencil/react/CHANGELOG.md': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/react/CHANGELOG.md`, |
| 128 | + 'stencil/react/package.json': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/react/package.json`, |
| 129 | + 'stencil/react/tsconfig.cjs.json': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/react/tsconfig.cjs.json`, |
| 130 | + 'stencil/react/tsconfig.json': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/react/tsconfig.json`, |
| 131 | + // Vue adapter |
| 132 | + 'stencil/vue/.gitignore': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/vue/.gitignore`, |
| 133 | + 'stencil/vue/.npmignore': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/vue/.npmignore`, |
| 134 | + 'stencil/vue/CHANGELOG.md': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/vue/CHANGELOG.md`, |
| 135 | + 'stencil/vue/package.json': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/vue/package.json`, |
| 136 | + 'stencil/vue/tsconfig.cjs.json': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/vue/tsconfig.cjs.json`, |
| 137 | + 'stencil/vue/tsconfig.json': `${config.outDir}/${config.odsStencilPath}/${templateData.name}/vue/tsconfig.json`, |
| 138 | + } |
| 139 | + }, |
| 140 | + { |
| 141 | + type: 'modify', |
| 142 | + files: `${config.outDir}/${config.odsThemingPath}/ods-size-definitions.scss`, |
| 143 | + handler(data) { |
| 144 | + return data + `@import './${config.corePrefix}-theming-size.${templateData.name}.scss';` |
| 145 | + } |
| 146 | + }, |
| 147 | + |
| 148 | + // Move Testing files |
| 149 | + { |
| 150 | + type: 'move', |
| 151 | + patterns: { |
| 152 | + 'testing/component-base-attributes.ts': `${config.outDir}/${config.odsTestingPath}/${templateData.componentFolderName}/${templateData.componentFileNamePrefix}-base-attributes.ts`, |
| 153 | + 'testing/public-api.ts': `${config.outDir}/${config.odsTestingPath}/${templateData.componentFolderName}/public-api.ts`, |
| 154 | + } |
| 155 | + }, |
| 156 | + { |
| 157 | + type: 'modify', |
| 158 | + files: `${config.outDir}/${config.odsTestingPath}/public-api.ts`, |
| 159 | + handler(data) { |
| 160 | + return data + `export * from './${templateData.componentFolderName}/public-api';` |
| 161 | + } |
| 162 | + }, |
| 163 | + |
| 164 | + // Move Theming files |
| 165 | + { |
| 166 | + type: 'move', |
| 167 | + patterns: { |
| 168 | + 'theming/component-theming-size.scss': `${config.outDir}/${config.odsThemingPath}/${config.corePrefix}-theming-size.${templateData.name}.scss`, |
| 169 | + } |
| 170 | + }, |
| 171 | + { |
| 172 | + type: 'modify', |
| 173 | + files: `${config.outDir}/${config.odsThemingPath}/ods-size-definitions.scss`, |
| 174 | + handler(data) { |
| 175 | + return data + `@import './${config.corePrefix}-theming-size.${templateData.name}.scss';` |
| 176 | + } |
| 177 | + } |
| 178 | + ]; |
| 179 | + }, |
| 180 | + async completed() { |
| 181 | + this.showProjectTips(); |
| 182 | + }, |
| 183 | +}; |
0 commit comments