js-waku-examples/create-waku-app/createApp.js

149 lines
4.3 KiB
JavaScript
Raw Normal View History

const path = require("path");
2022-12-06 21:24:44 +00:00
const fs = require("fs-extra");
2022-12-21 21:21:39 +00:00
const enquirer = require("enquirer");
2022-12-06 21:24:44 +00:00
const execSync = require("child_process").execSync;
const { Command } = require("commander");
const validateProjectName = require("validate-npm-package-name");
const supportedExamplesDir = path.resolve(__dirname, "./examples");
const supportedExamples = readDirNames(supportedExamplesDir);
const init = async (name, description, version) => {
let appName;
let template;
2022-12-21 21:21:39 +00:00
const options = new Command()
.name(name)
.description(description)
.version(version, "-v, --version", "output the version number")
.arguments("<project-directory>", "Project directory to initialize Waku app")
.action(_appName => {
appName = _appName;
})
.option(
"-t, --template <path-to-template>",
2022-12-22 17:51:19 +00:00
"specify a template for the created project or you can use the wizard."
)
.allowUnknownOption()
2022-12-21 21:21:39 +00:00
.parse()
.opts();
template = options.template;
2022-12-21 21:21:39 +00:00
if (!template) {
const templatePrompt = new enquirer.Select({
name: "template",
message: "Select template",
choices: Object.keys(supportedExamples),
});
try {
template = await templatePrompt.run();
} catch (e) {
console.error(`Failed at selecting a template: ${e.message}`);
process.exit(1);
}
}
if (!supportedExamples[template]) {
const supportedExamplesMessage = Object.keys(supportedExamples).reduce((acc, v) => {
acc += `\t${v}\n`;
return acc;
}, "");
console.error(`Unknown template: ${template}`);
console.error(`We support only following templates:\n${supportedExamplesMessage}`)
process.exit(1);
}
createApp(appName, template);
};
function createApp(name, template) {
const appRoot = path.resolve(name);
const appName = path.basename(appRoot);
const templateDir = path.resolve(supportedExamplesDir, template);
terminateIfAppExists(appName);
terminateIfProjectNameInvalid(appName);
console.log(`Initializing ${appName} from ${template} template.`);
fs.ensureDirSync(appName);
fs.copySync(templateDir, appRoot);
2022-12-06 21:24:44 +00:00
runNpmInApp(appRoot);
runGitInit(appRoot);
}
function runNpmInApp(root) {
const packageJsonPath = path.resolve(root, "package.json");
if (!fs.existsSync(packageJsonPath)) {
return;
}
console.log("Installing npm packages.");
2022-12-06 21:24:44 +00:00
try {
execSync(`npm install --prefix ${root}`, { stdio: "ignore" });
console.log("Successfully installed npm dependencies.");
} catch (e) {
console.warn("Failed to install npm dependencies", e);
}
}
function runGitInit(root) {
if (isInGitRepository()) {
return;
}
console.log("Initiating git repository.");
2022-12-06 21:24:44 +00:00
try {
execSync(`git init ${root}`, { stdio: "ignore" });
console.log("Successfully initialized git repo.");
} catch (e) {
console.warn("Git repo not initialized", e);
}
}
function isInGitRepository() {
try {
execSync("git rev-parse --is-inside-work-tree", { stdio: "ignore" });
return true;
} catch (e) {
return false;
}
}
function terminateIfProjectNameInvalid(name) {
const validationResult = validateProjectName(name);
if (!validationResult.validForNewPackages) {
console.error(`Cannot create a project named ${name} because of npm naming restrictions:\n`);
[...(validationResult.errors || []), ...(validationResult.warnings || [])]
.forEach(error => console.error(` * ${error}`));
console.error("\nPlease choose a different project name.");
process.exit(1);
}
}
function terminateIfAppExists(appRoot) {
if (fs.existsSync(appRoot)) {
console.error(`Cannot create a project because it already exists by the name: ${appRoot}`);
process.exit(1);
}
}
function readDirNames(target) {
return fs.readdirSync(target, { withFileTypes: true })
.filter(dir => dir.isDirectory())
.map(dir => dir.name)
.reduce((acc, name) => {
acc[name] = path.resolve(target, name);
return acc;
}, {});
}
module.exports = { init };