Download next.js/examples/cms-sitecore-xmcloud/scripts/scaffold-component.ts from Devendra174/react-code-dataset: direct link, hf CLI and curl.
- Browser
- Download file 3.14 kB
-
https://huggingface.co/datasets/Devendra174/react-code-dataset/resolve/main/next.js/examples/cms-sitecore-xmcloud/scripts/scaffold-component.ts
- Command line
-
hf download hf://datasets/Devendra174/react-code-dataset/next.js/examples/cms-sitecore-xmcloud/scripts/scaffold-component.ts
-
curl -L -o scaffold-component.ts https://huggingface.co/datasets/Devendra174/react-code-dataset/resolve/main/next.js/examples/cms-sitecore-xmcloud/scripts/scaffold-component.ts
3.14 kB
| /* | |
| Component Scaffolding Script | |
| This is a script that enables scaffolding a new JSS component using `jss scaffold <ComponentName>`. | |
| The default convention is that component names must start with a capital letter, and can contain | |
| letters, number, underscores, or dashes. | |
| If the <ComponentName> parameter includes a path, it must be relative to the src/components folder. | |
| For example, `jss scaffold search/SearchBox` will create a component called `SearchBox` in | |
| `src/components/search/SearchBox.tsx`. Specifying a relative path is optional, and just providing | |
| the name is ok. | |
| Edit this script if you wish to use your own conventions for component storage in your JSS app. | |
| */ | |
| /* eslint-disable no-throw-literal,no-console */ | |
| import fs from "fs"; | |
| import path from "path"; | |
| import chalk from "chalk"; | |
| import generateComponentSrc from "./templates/component-src"; | |
| const componentRootPath = "src/components"; | |
| // Matches component names that start with a capital letter, and contain only letters, number, | |
| // underscores, or dashes. Optionally, the component name can be preceded by a relative path | |
| const nameParamFormat = new RegExp(/^((?:[\w-]+\/)*)([A-Z][\w-]+)$/); | |
| const componentArg = process.argv[2]; | |
| if (!componentArg) { | |
| throw "Component name was not passed. Usage: jss scaffold <ComponentName>"; | |
| } | |
| const regExResult = nameParamFormat.exec(componentArg); | |
| if (regExResult === null) { | |
| throw `Component name should start with an uppercase letter and contain only letters, numbers, | |
| dashes, or underscores. If specifying a path, it must be relative to src/components`; | |
| } | |
| const componentPath = regExResult[1]; | |
| const componentName = regExResult[2]; | |
| const filename = `${componentName}.tsx`; | |
| /** | |
| * Force to use `crlf` line endings, we are using `crlf` across the project. | |
| * Replace: `lf` (\n), `cr` (\r) | |
| * @param {string} content | |
| */ | |
| function editLineEndings(content: string) { | |
| return content.replace(/\r|\n/gm, "\r\n"); | |
| } | |
| /** | |
| * Creates a file relative to the specified path if the file doesn't exist. Creates directories as needed. | |
| * @param {string} rootPath - the root path | |
| * @param {string} fileContent - the file content | |
| * @param {string} filename - the filename | |
| * @returns the new file's filepath | |
| */ | |
| function scaffoldFile( | |
| rootPath: string, | |
| fileContent: string, | |
| filename: string, | |
| ): string | null { | |
| const outputDir = path.join(rootPath, componentPath); | |
| const outputFile = path.join(outputDir, filename); | |
| if (fs.existsSync(outputFile)) { | |
| console.log(chalk.red(`Skipping creating ${outputFile}; already exists.`)); | |
| return null; | |
| } | |
| fs.mkdirSync(outputDir, { recursive: true }); | |
| fs.writeFileSync(outputFile, editLineEndings(fileContent), "utf8"); | |
| console.log(chalk.green(`File ${outputFile} has been scaffolded.`)); | |
| return outputFile; | |
| } | |
| const componentOutputPath = scaffoldFile( | |
| componentRootPath, | |
| generateComponentSrc(componentName), | |
| filename, | |
| ); | |
| console.log( | |
| chalk.green(` | |
| Scaffolding of ${componentName} complete. | |
| Next steps:`), | |
| ); | |
| if (componentOutputPath) { | |
| console.log( | |
| `* Implement the React component in ${chalk.green(componentOutputPath)}`, | |
| ); | |
| } | |