rush-init-project-plugin
Version:
Rush plugin for initialize project in monorepo
473 lines • 23.8 kB
JavaScript
"use strict";
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __values = (this && this.__values) || function(o) {
var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
if (m) return m.call(o);
if (o && typeof o.length === "number") return {
next: function () {
if (o && i >= o.length) o = void 0;
return { value: o && o[i++], done: !o };
}
};
throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
};
var __read = (this && this.__read) || function (o, n) {
var m = typeof Symbol === "function" && o[Symbol.iterator];
if (!m) return o;
var i = m.call(o), r, ar = [], e;
try {
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
}
catch (error) { e = { error: error }; }
finally {
try {
if (r && !r.done && (m = i["return"])) m.call(i);
}
finally { if (e) throw e.error; }
}
return ar;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
var node_core_library_1 = require("@rushstack/node-core-library");
var lib_1 = __importDefault(require("handlebars-helpers/lib"));
var inquirer_autocomplete_prompt_1 = __importDefault(require("inquirer-autocomplete-prompt"));
var lodash_1 = require("lodash");
var path = __importStar(require("path"));
var validate_npm_package_name_1 = __importDefault(require("validate-npm-package-name"));
var addProjectToRushJson_1 = require("./actions/addProjectToRushJson");
var rushRushUpdate_1 = require("./actions/rushRushUpdate");
var sortPackageJson_1 = require("./actions/sortPackageJson");
var hooks_1 = require("./hooks");
var loadRushConfiguration_1 = require("./logic/loadRushConfiguration");
var TemplateConfiguration_1 = require("./logic/TemplateConfiguration");
var templateFolder_1 = require("./logic/templateFolder");
var GitConfig_1 = require("./logic/GitConfig");
var terminal_1 = require("./terminal");
var loadGlobalConfiguration_1 = require("./logic/loadGlobalConfiguration");
function default_1(plop, plopCfg) {
var _this = this;
var terminal = terminal_1.TerminalSingleton.getInstance();
var rushConfiguration = (0, loadRushConfiguration_1.loadRushConfiguration)();
var monorepoRoot = rushConfiguration.rushJsonFolder;
var hooks = (0, hooks_1.getHooks)();
var pluginContext = {
isDryRun: plopCfg.dryRun || Boolean(process.env.DRY_RUN),
cliAnswer: typeof plopCfg.answer === 'object' ? plopCfg.answer : {}
};
registerActions(plop);
registerHelpers(plop);
var defaultPrompts = [
{
type: 'input',
name: 'authorName',
message: 'What is your name? (used in package.json)',
default: function () {
return (0, GitConfig_1.getGitUserName)(monorepoRoot).trim();
},
validate: function (input) {
return Boolean(input);
}
},
{
name: 'packageName',
type: 'input',
message: "Input package name",
validate: function (input, answers) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
if (!input) {
return [2 /*return*/, 'package name is required'];
}
if (!(0, validate_npm_package_name_1.default)(input)) {
return [2 /*return*/, 'package name is invalid'];
}
return [2 /*return*/, true];
});
});
}
},
{
type: 'input',
message: 'Input package description',
name: 'description',
validate: function (input) {
if (!input) {
return 'description is required';
}
return true;
}
},
{
type: 'input',
message: 'Input a relative path to store this project',
name: 'projectFolder',
validate: function (input) {
if (!input) {
return 'project folder is required';
}
if (node_core_library_1.FileSystem.exists(path.join(monorepoRoot, input))) {
return 'project folder already exists, please delete it first';
}
return true;
}
},
{
type: 'confirm',
name: 'shouldRunRushUpdate',
message: 'Do you need run rush update after init?'
}
];
// get template config when invoke loadTemplateConfiguration
var templateConfiguration;
var loadTemplateConfiguration = function (promptQueue, template) { return __awaiter(_this, void 0, void 0, function () {
var _a, _b, prompt, _c, _d, plugin;
var e_1, _e, e_2, _f;
return __generator(this, function (_g) {
switch (_g.label) {
case 0: return [4 /*yield*/, TemplateConfiguration_1.TemplateConfiguration.loadFromTemplate(template)];
case 1:
templateConfiguration = _g.sent();
try {
for (_a = __values(templateConfiguration.prompts), _b = _a.next(); !_b.done; _b = _a.next()) {
prompt = _b.value;
promptQueue.push(prompt);
}
}
catch (e_1_1) { e_1 = { error: e_1_1 }; }
finally {
try {
if (_b && !_b.done && (_e = _a.return)) _e.call(_a);
}
finally { if (e_1) throw e_1.error; }
}
try {
for (_c = __values(templateConfiguration.plugins), _d = _c.next(); !_d.done; _d = _c.next()) {
plugin = _d.value;
plugin.apply(hooks, pluginContext);
}
}
catch (e_2_1) { e_2 = { error: e_2_1 }; }
finally {
try {
if (_d && !_d.done && (_f = _c.return)) _f.call(_c);
}
finally { if (e_2) throw e_2.error; }
}
hooks.plop.call(plop);
return [4 /*yield*/, hooks.prompts.promise({
promptQueue: promptQueue
})];
case 2:
_g.sent();
return [2 /*return*/];
}
});
}); };
var promptsFunc = function (inquirerPassed) { return __awaiter(_this, void 0, void 0, function () {
var inquirer, templateNameList, templateChoices, defaultPromptFunc, invokeUI, promptAnswers, error_1;
var _this = this;
var _a, _b;
return __generator(this, function (_c) {
switch (_c.label) {
case 0:
inquirer = inquirerPassed;
inquirer.registerPrompt('autocomplete', inquirer_autocomplete_prompt_1.default);
return [4 /*yield*/, (0, loadGlobalConfiguration_1.loadGlobalConfiguration)(hooks, pluginContext)];
case 1:
templateNameList = (_c.sent()).templateNameList;
return [4 /*yield*/, hooks.templates.promise({
templates: templateNameList
})];
case 2:
_c.sent();
templateChoices = templateNameList.map(function (x) { return ({
name: x.displayName ? x.displayName : x.templateFolder,
value: x.templateFolder
}); });
defaultPromptFunc = function () { return __awaiter(_this, void 0, void 0, function () {
var allAnswers, promptQueue, _loop_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
allAnswers = {};
defaultPrompts.unshift({
type: 'autocomplete',
name: 'template',
message: 'Please select a template',
source: function (ans, input) {
if (!input) {
return templateChoices;
}
return templateChoices.filter(function (x) { return x.name.includes(input) || x.value.includes(input); });
},
loop: false,
pageSize: 20
});
promptQueue = defaultPrompts.slice();
// choose selected template
if (pluginContext.cliAnswer.template) {
allAnswers.template = pluginContext.cliAnswer.template;
}
_loop_1 = function () {
var currentPrompt, hookForCurrentPrompt, hookResult, currentAnswers, promptQueueNames_1;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
currentPrompt = promptQueue.shift();
hookForCurrentPrompt = hooks.promptQuestion.get(currentPrompt.name);
if (hookForCurrentPrompt) {
hookResult = hookForCurrentPrompt.call(currentPrompt, allAnswers);
// hook can return null to skip the prompt
if (hookResult === null) {
return [2 /*return*/, "continue"];
}
}
return [4 /*yield*/, inquirer.prompt([currentPrompt], allAnswers)];
case 1:
currentAnswers = _b.sent();
if (!((currentPrompt === null || currentPrompt === void 0 ? void 0 : currentPrompt.name) === 'template')) return [3 /*break*/, 3];
return [4 /*yield*/, loadTemplateConfiguration(promptQueue, currentAnswers.template)];
case 2:
_b.sent();
promptQueueNames_1 = promptQueue.map(function (x) { return x.name; });
// apply cliAnswer
allAnswers = (0, lodash_1.pickBy)(pluginContext.cliAnswer, function (v, k) { return promptQueueNames_1.includes(k); });
_b.label = 3;
case 3:
// merge answers
allAnswers = __assign(__assign({}, allAnswers), currentAnswers);
return [2 /*return*/];
}
});
};
_a.label = 1;
case 1:
if (!(promptQueue.length > 0)) return [3 /*break*/, 3];
return [5 /*yield**/, _loop_1()];
case 2:
_a.sent();
return [3 /*break*/, 1];
case 3: return [2 /*return*/, allAnswers];
}
});
}); };
invokeUI = function () { return __awaiter(_this, void 0, void 0, function () {
var initBlessedForm;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, Promise.resolve().then(function () { return __importStar(require('./ui')); })];
case 1:
initBlessedForm = (_a.sent()).initBlessedForm;
return [4 /*yield*/, initBlessedForm(defaultPrompts, pluginContext, plop, plopCfg, loadTemplateConfiguration, templateChoices)];
case 2: return [2 /*return*/, _a.sent()];
}
});
}); };
if (!plopCfg.ui) return [3 /*break*/, 4];
return [4 /*yield*/, invokeUI()];
case 3:
promptAnswers = _c.sent();
return [3 /*break*/, 6];
case 4: return [4 /*yield*/, defaultPromptFunc()];
case 5:
promptAnswers = _c.sent();
_c.label = 6;
case 6:
// process answers
promptAnswers.unscopedPackageName = node_core_library_1.PackageName.getUnscopedName((_a = promptAnswers.packageName) !== null && _a !== void 0 ? _a : '');
_c.label = 7;
case 7:
_c.trys.push([7, 9, , 10]);
return [4 /*yield*/, hooks.answers.promise(promptAnswers)];
case 8:
_c.sent();
return [3 /*break*/, 10];
case 9:
error_1 = _c.sent();
terminal.writeErrorLine("Error in \"answers\" hook, please check your plugins");
terminal.writeErrorLine((_b = (error_1 !== null && error_1 !== void 0 ? error_1 : 'error')) === null || _b === void 0 ? void 0 : _b.toString());
process.exit(1);
return [3 /*break*/, 10];
case 10: return [2 /*return*/, promptAnswers];
}
});
}); };
plop.setGenerator('rush-init-project', {
description: 'Rush init project',
prompts: promptsFunc,
actions: function (answer) {
var _a = answer, template = _a.template, projectFolder = _a.projectFolder;
var defaultProjectConfiguration = (templateConfiguration === null || templateConfiguration === void 0 ? void 0 : templateConfiguration.defaultProjectConfiguration) || {};
hooks.defaultProjectConfiguration.call(defaultProjectConfiguration, answer);
var templatesFolder = (0, templateFolder_1.getTemplatesFolder)();
// glob result is always splitted by slash
var baseFolder = path.join(templatesFolder, template).replace(/\\/g, '/');
var actions = plopCfg.dryRun
? []
: [
{
type: 'addMany',
destination: path.resolve(monorepoRoot, projectFolder),
base: baseFolder,
templateFiles: ["**/*", '!init.config.ts', '!init.config.js'],
globOptions: {
cwd: baseFolder,
dot: true,
absolute: true
},
data: answer
},
{
type: 'sortPackageJson'
},
{
type: 'addProjectToRushJson',
data: {
defaultProjectConfiguration: defaultProjectConfiguration
}
},
{
type: 'runRushUpdate'
}
];
hooks.actions.call({ actions: actions });
return actions;
}
});
}
exports.default = default_1;
function registerActions(plop) {
plop.setActionType('addProjectToRushJson', function (ans, config) {
var _a;
var answers = ans;
var packageName = answers.packageName, projectFolder = answers.projectFolder;
var defaultProjectConfiguration = ((_a = config === null || config === void 0 ? void 0 : config.data) === null || _a === void 0 ? void 0 : _a.defaultProjectConfiguration) || {};
if (!packageName) {
throw new Error('packageName is required');
}
if (!projectFolder) {
throw new Error('projectFolder is required');
}
(0, addProjectToRushJson_1.addProjectToRushJson)({
packageName: packageName,
projectFolder: projectFolder,
defaultProjectConfiguration: defaultProjectConfiguration
});
return "Add ".concat(packageName, " to rush.json successfully");
});
plop.setActionType('runRushUpdate', function (ans) {
var shouldRunRushUpdate = ans.shouldRunRushUpdate;
if (!shouldRunRushUpdate) {
return 'Skip "rush update", please run it manually';
}
(0, rushRushUpdate_1.runRushUpdate)();
return 'Run rush update successfully';
});
plop.setActionType('sortPackageJson', function (ans) {
var projectFolder = ans.projectFolder;
(0, sortPackageJson_1.sortPackageJson)(projectFolder);
return 'Sort package.json successfully';
});
}
function registerHelpers(plop) {
var e_3, _a, e_4, _b;
try {
// See https://github.com/helpers/handlebars-helpers/blob/master/README.md#helpers
for (var _c = __values(Object.values(lib_1.default)), _d = _c.next(); !_d.done; _d = _c.next()) {
var helpers = _d.value;
try {
for (var _e = (e_4 = void 0, __values(Object.entries(helpers))), _f = _e.next(); !_f.done; _f = _e.next()) {
var _g = __read(_f.value, 2), helperName = _g[0], helperFunc = _g[1];
plop.setHelper(helperName, helperFunc);
}
}
catch (e_4_1) { e_4 = { error: e_4_1 }; }
finally {
try {
if (_f && !_f.done && (_b = _e.return)) _b.call(_e);
}
finally { if (e_4) throw e_4.error; }
}
}
}
catch (e_3_1) { e_3 = { error: e_3_1 }; }
finally {
try {
if (_d && !_d.done && (_a = _c.return)) _a.call(_c);
}
finally { if (e_3) throw e_3.error; }
}
}
//# sourceMappingURL=plopfile.js.map