mushroom-cli 1.1.0-alpha.9 → 1.1.0

package/README.md

@@ -1,75 +1,91 @@
-# Init
+# Mushroom CLI
+
+## Init
 
 Init a mushroom json file
 
-    npx mr init json ./api/SampleProject.json [silent]
+    npx mushroom-cli init json ./api/SampleProject.json [silent]
 
-Init a dotnet core project which pre-install Mushroom Server
+Init a DotNet Core project which pre-install Mushroom Server
 
-    npx mr init netcore projectName [features file,auth,mail]
+    npx mushroom-cli init netcore [projectName]
 
-# Configure
+## Configure
 
 Add the mushroom json file into mushroom-config.json
 
-    npx mr config add ./api/yourProjectName.json
+    npx mushroom-cli config add ./api/yourProjectName.json
 
 Config gen docs api
 
-    npx mr config gen projectName docs ./wwwroot/docs.html [alias aliasName] [features file,auth,mail,driver] [roles Admin,User-Contributor]
+    npx mushroom-cli config gen projectName docs ./wwwroot/docs.html [alias aliasName] [features file,auth,mail,driver] [roles Admin,User-Contributor]
 
 Config gen database docs
 
-    npx mr config gen projectName db-docs ./wwwroot/db-docs.html [alias aliasName] [features file,auth,mail]
+    npx mushroom-cli config gen projectName db-docs ./wwwroot/db-docs.html [alias aliasName] [features file,auth,mail]
 
 Config gen javascript driver
 
-    npx mr config gen projectName js-driver ./src/api/mushroom.api.js [alias aliasName] [roles Admin,User-Contributor] [tarball tarballName]
+    npx mushroom-cli config gen projectName js-driver ./src/api/mushroom.api.js [alias aliasName] [roles Admin,User-Contributor] [tarball tarballName]
 
 Config gen typescript driver
 
-    npx mr config gen projectName ts-driver ./src/api/mushroom.api.ts [alias aliasName] [roles Admin,User-Contributor]
+    npx mushroom-cli config gen projectName ts-driver ./src/api/mushroom.api.ts [alias aliasName] [roles Admin,User-Contributor]
 
 Config gen entities for Mushroom project in CSharp and using MongoDb
 
-    npx mr config gen projectName c#-mongo ./API/Generated.cs [alias aliasName]
+    npx mushroom-cli config gen projectName c#-mongo ./API/Generated.cs [alias aliasName]
 
 Config gen entities for CSharp project which calls Mushroom API
 
-    npx mr config gen projectName c#-driver ./API/Generated.cs [roles Admin,User-Contributor] [alias aliasName] [access-modifier public] [features file,auth,mail]
+    npx mushroom-cli config gen projectName c#-driver ./API/Generated.cs [roles Admin,User-Contributor] [alias aliasName] [access-modifier public] [features file,auth,mail]
 
-# Genarate
+## Genarate
 
 Generate docs api (html format)
 
-    npx mr gen projectName[@aliasName] docs [tmp]
+    npx mushroom-cli gen projectName[@aliasName] docs [tmp]
 
 Generate database docs (html format)
 
-    npx mr gen projectName[@aliasName] db-docs [tmp]
+    npx mushroom-cli gen projectName[@aliasName] db-docs [tmp]
 
 Generate npm package (tarball file)
 
-    npx mr gen projectName[@aliasName] js-driver-tarball
+    npx mushroom-cli gen projectName[@aliasName] js-driver-tarball
 
 Generate javascript driver
 
-    npx mr gen projectName[@aliasName] js-driver
+    npx mushroom-cli gen projectName[@aliasName] js-driver
 
 Generate typescript driver
 
-    npx mr gen projectName[@aliasName] ts-driver
+    npx mushroom-cli gen projectName[@aliasName] ts-driver
 
 Generate entities for Mushroom project in CSharp and using MongoDb
 
-    npx mr gen projectName[@aliasName] c#-mongo
+    npx mushroom-cli gen projectName[@aliasName] c#-mongo
 
 Generate entities for CSharp project which calls Mushroom API
 
-    npx mr gen projectName[@aliasName] c#-driver
+    npx mushroom-cli gen projectName[@aliasName] c#-driver
+
+## Update
+
+Update ts code
+
+    npx mushroom-cli update ts-code [file-path.ts] [remote-ts-code-url]
 
-# Other
+## Other
 
 Disable checking for update:
 
-    npx mr parameters --no-check-update
+    npx mushroom-cli parameters --no-check-update
+
+## Version
+
+### 1.1.0
+
+Support MushroomServer 0.2.25.4 or later
+
+Support mushroomjs 1.1.0 or later

package/common.js

@@ -1,11 +1,13 @@
 const fs = require("fs");
+const path = require('path');
+const readlineSync = require("readline-sync");
 
-function ensureFolder(path) {
+function ensureFolder(path, isFolder) {
     const index = path.lastIndexOf("/");
-    if (index <= 0){
+    if (!isFolder && index <= 0){
         return;
     }
-    path = path.substr(0, index);
+    if (!isFolder) path = path.substring(0, index);
     if (path === "." || path === "..")
         return;
 
@@ -125,8 +127,110 @@ function getEntities(projectApiConfiguration, roles, getAll) {
     return entities;
 }
 
+function processTemplate(basePath, templatePath) {
+    const templateJsonContent = fs.readFileSync(path.join(basePath, templatePath)).toString();
+    const template = JSON.parse(templateJsonContent);
+    if (template && typeof template !== "object") {
+        throw new TypeError(`Invalid template file ${templatePath}`);
+    }
+    const commands = template.steps;
+    if (!Array.isArray(commands)) {
+        throw new TypeError(`Invalid template file ${templatePath}`);
+    }
+
+    const variables = {};
+    commands.forEach(command => processCommand(command, basePath, variables));
+    return variables;
+}
+
+function processCommand(command, basePath, variables) {
+    switch (command.command) {
+        case "input":
+            processInputCommand(command, variables);
+            return;
+        case "set":
+            processSetCommand(command, variables);
+            return;
+        case "rename":
+            processRenameCommand(command, basePath, variables);
+            return;
+        case "delete":
+            processDeleteCommand(command, basePath, variables);
+            return;
+        case "replace":
+            processReplaceCommand(command, basePath, variables);
+            return;
+    }
+}
+
+function processInputCommand(command, variables) {
+    const value = readlineSync.question(command.message ?? "");
+    if (command.validation) {
+        if (command.validation.required) {
+            if (value === "") throw new TypeError(`${command.variable} is required`);
+        }
+        if (command.validation.pattern) {
+            if (!new RegExp(command.validation.pattern).test(value)) throw new Error(`${value} is not valid`);
+        }
+    }
+    variables[command.variable] = value;
+}
+
+function processSetCommand(command, variables) {
+    switch (command["function"]) {
+        case "New-GUID":
+            processSetGuidCommand(command.variable, variables);
+            break;
+    }
+}
+
+function processSetGuidCommand(variable, variables) {
+    variables[variable] = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, c => {
+        var r = Math.random() * 16 | 0, v = c == 'x' ? r : (r & 0x3 | 0x8);
+        return v.toString(16);
+    }).toUpperCase();
+}
+
+function processRenameCommand(command, basePath, variables) {
+    const input = replaceVariables(command.input, variables);
+    const output = replaceVariables(command.output, variables);
+
+    fs.renameSync(path.join(basePath, input), path.join(basePath, output));
+}
+
+function processDeleteCommand(command, basePath, variables) {
+    const input = replaceVariables(command.input, variables);
+
+    const deletedPath = path.join(basePath, input);
+    if (fs.lstatSync(deletedPath).isDirectory()) {
+        // fs.rmdirSync(deletedPath, {recursive: true, force: true});
+        fs.rmSync(deletedPath, {recursive: true, force: true});
+    }
+    else {
+        fs.rmSync(deletedPath, {force: true});
+    }
+}
+
+function processReplaceCommand(command, basePath, variables) {
+    const files = command.input;
+    const pattern = new RegExp(command.pattern, "g");
+    const replacement = replaceVariables(command.replacement, variables);
+
+    files.forEach(file => {
+        const filePath = replaceVariables(file, variables);
+        let content = fs.readFileSync(path.join(basePath, filePath)).toString();
+        content = content.replace(pattern, () => replacement);
+        fs.writeFileSync(path.join(basePath, filePath), content);
+    });
+}
+
+function replaceVariables(str, variables) {
+    return str.replace(/\$\{(\w+)\}/g, (_, varName) => variables[varName] ?? "");
+}
+
 module.exports = {
     ensureFolder: ensureFolder,
-    getRootUrl : getRootUrl,
-    getEntities : getEntities
+    getRootUrl: getRootUrl,
+    getEntities: getEntities,
+    processTemplate: processTemplate
 };

package/config.js

@@ -75,8 +75,8 @@ function configGenDocs(args, mushroomConfig, projectName){
                 const strRoles = args[index];
                 if (strRoles) {
                     const minusIndex = strRoles.indexOf("-");
-                    let grantedRoles = minusIndex == -1 ? strRoles : strRoles.substr(0, minusIndex);
-                    const deniedRoles = minusIndex == -1 ? "" : strRoles.substr(minusIndex + 1);
+                    let grantedRoles = minusIndex == -1 ? strRoles : strRoles.substring(0, minusIndex);
+                    const deniedRoles = minusIndex == -1 ? "" : strRoles.substring(minusIndex + 1);
                     if (!grantedRoles)
                         grantedRoles = "*";
                     parameters.allowRoles = grantedRoles.split(",");
@@ -173,8 +173,8 @@ function configGenJavascriptDriver(args, mushroomConfig, projectName){
                 const strRoles = args[index];
                 if (strRoles) {
                     const minusIndex = strRoles.indexOf("-");
-                    let grantedRoles = minusIndex == -1 ? strRoles : strRoles.substr(0, minusIndex);
-                    const deniedRoles = minusIndex == -1 ? "" : strRoles.substr(minusIndex + 1);
+                    let grantedRoles = minusIndex == -1 ? strRoles : strRoles.substring(0, minusIndex);
+                    const deniedRoles = minusIndex == -1 ? "" : strRoles.substring(minusIndex + 1);
                     if (!grantedRoles)
                         grantedRoles = "*";
                     parameters.allowRoles = grantedRoles.split(",");
@@ -233,8 +233,8 @@ function configGenTypescriptDriver(args, mushroomConfig, projectName){
                 const strRoles = args[index];
                 if (strRoles) {
                     const minusIndex = strRoles.indexOf("-");
-                    let grantedRoles = minusIndex == -1 ? strRoles : strRoles.substr(0, minusIndex);
-                    const deniedRoles = minusIndex == -1 ? "" : strRoles.substr(minusIndex + 1);
+                    let grantedRoles = minusIndex == -1 ? strRoles : strRoles.substring(0, minusIndex);
+                    const deniedRoles = minusIndex == -1 ? "" : strRoles.substring(minusIndex + 1);
                     if (!grantedRoles)
                         grantedRoles = "*";
                     parameters.allowRoles = grantedRoles.split(",");
@@ -325,8 +325,8 @@ function configGenCSharpDriver(args, mushroomConfig, projectName){
                 const strRoles = args[index];
                 if (strRoles) {
                     const minusIndex = strRoles.indexOf("-");
-                    let grantedRoles = minusIndex == -1 ? strRoles : strRoles.substr(0, minusIndex);
-                    const deniedRoles = minusIndex == -1 ? "" : strRoles.substr(minusIndex + 1);
+                    let grantedRoles = minusIndex == -1 ? strRoles : strRoles.substring(0, minusIndex);
+                    const deniedRoles = minusIndex == -1 ? "" : strRoles.substring(minusIndex + 1);
                     if (!grantedRoles)
                         grantedRoles = "*";
                     parameters.allowRoles = grantedRoles.split(",");