File size: 3,141 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
/*
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)}`,
);
}
|