mushroom-cli 1.2.8 → 2.0.0-alpha.1

package/README.md

@@ -1,5 +1,9 @@
 # Mushroom CLI
 
+> In the examples below, `[...]` marks an optional argument and `|` separates alternatives. They are notation, not
+> characters to type. Quote any argument containing spaces, for example
+> `npx mushroom-cli config add "./my api/project.json"`.
+
 ## Init
 
 Init a mushroom json file
@@ -8,10 +12,10 @@ Init a mushroom json file
 npx mushroom-cli init json ./api/SampleProject.json [silent]
 ```
 
-Init a DotNet Core project which pre-install Mushroom Server
+Init a DotNet project
 
 ```bash
-npx mushroom-cli init netcore [projectName]
+npx mushroom-cli init netcore [projectName] [--version latest|alpha|0.2|0.3]
 ```
 
 ## Configure
@@ -31,19 +35,19 @@ npx mushroom-cli config gen projectName docs ./wwwroot/docs.html [alias aliasNam
 Config gen database docs
 
 ```bash
-npx mushroom-cli 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
 
 ```bash
-npx mushroom-cli 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]
 ```
 
 Config gen typescript driver
 
 ```bash
-npx mushroom-cli 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
@@ -58,36 +62,30 @@ Config gen entities for CSharp project which calls Mushroom API
 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
+## Generate
 
 Generate docs api (html format)
 
 ```bash
-npx mushroom-cli gen projectName[@aliasName] docs [v1] [tmp]
+npx mushroom-cli gen projectName[@aliasName] docs [tmp]
 ```
 
 Generate database docs (html format)
 
 ```bash
-npx mushroom-cli gen projectName[@aliasName] "db-docs" [tmp]
-```
-
-Generate npm package (tarball file)
-
-```bash
-npx mushroom-cli gen projectName[@aliasName] "js-driver-tarball"
+npx mushroom-cli gen projectName[@aliasName] db-docs [tmp]
 ```
 
 Generate javascript driver
 
 ```bash
-npx mushroom-cli gen projectName[@aliasName] "js-driver"
+npx mushroom-cli gen projectName[@aliasName] js-driver
 ```
 
 Generate typescript driver
 
 ```bash
-npx mushroom-cli gen projectName[@aliasName] "ts-driver"
+npx mushroom-cli gen projectName[@aliasName] ts-driver
 ```
 
 Generate entities for Mushroom project in CSharp and using MongoDb
@@ -113,13 +111,13 @@ npx mushroom-cli merge output-path.json
 Update ts code (configuration was stored in mushroom-config.json file)
 
 ```bash
-npx mushroom-cli update "ts-code"
+npx mushroom-cli update ts-code
 ```
 
 Update ts code (simple call)
 
 ```bash
-npx mushroom-cli update "ts-code" file-path.ts remote-ts-code-url
+npx mushroom-cli update ts-code file-path.ts remote-ts-code-url
 ```
 
 ## Other
@@ -132,6 +130,53 @@ npx mushroom-cli parameters --no-check-update
 
 ## Version
 
+### 2.0.0-alpha.1
+
+Bug fixes:
+
+- gen docs: fix trailing comma on the last field of each object in data specs and code snippet.
+- gen docs: copy buttons no longer copy extra text
+
+Improvement:
+
+- gen docs: add copy buttons to data specs
+
+### 2.0.0-alpha.0
+
+Breaking changes:
+
+- gen docs: remove the docs engine v1. The `v1` parameter is now ignored with a warning and the v1.2 engine is always
+  used
+- gen js-driver: remove the `js-driver-tarball` command, the `tarball tarballName` option of `config gen js-driver`
+  and the `jsDriver.alias.*.tarballName` field in mushroom-config.json
+- gen c#-mongo: generated code now requires Mushroom Server 0.3 or higher
+- require Node.js `>=14.13.1`
+
+New features:
+
+- init netcore: `npx mushroom-cli init netcore [--version 0.2|0.3|latest|alpha]` to select the template branch
+- init netcore: the `replace` step accepts wildcards in the file name, for example `./api/*.json` or
+  `./api/dulich-*.json`, and resolves them recursively including sub-folders
+- gen c#-mongo: support `routes` in the master file (`path`, `pathMode`, `caseInsensitive`, `httpMethod`, `grant`,
+  `deny`, `logRetentionMode`, `delegator`, `codeHint`)
+- gen c#-mongo: support `extensions` in the master file (`startup`, `config`, `ensureIndex`, `routes`) and generate
+  the matching extension event handlers
+- gen c#-mongo: new registration signatures `RegisterJob`, `RegisterBeforeEvent`, `RegisterAfterEvent`,
+  `RegisterCustomLoginAsyncHandler`, `RegisterGetAuthLogInfoAsyncHandler`, `RegisterLoginSuccessHandler`,
+  `RegisterSendCodeItemHandler`, `RegisterCustomVnTextBuilderMethod`
+
+Improvement/Changes:
+
+- gen docs: inline `bootstrap.min.css`, `bootstrap-theme.min.css`, `bootstrap.min.js` and `jquery.min.js` into the
+  html. The generated docs is now a single self-contained file and no static file is copied next to it
+- gen docs: build the whole document in memory and write it once, about 4 times faster
+- gen c#-mongo, gen c#-driver: escape descriptions for XML docs comments
+- init netcore: clone the template with `--depth 1`
+- replace `minify` with `html-minifier-terser` and use `open` 8: installing the CLI drops from 84 packages (75 MB) to
+  36 packages (20 MB) and works on Node.js 14 again
+- the `only-allow npm` check moved from `preinstall` to `prepare` so it no longer runs when the CLI is installed as a
+  dependency
+
 ### 1.2.8
 
 Improvement

package/dist/common.js

@@ -1,7 +1,6 @@
 import fs from 'fs';
 import path from 'path';
 import { fileURLToPath } from 'url';
-import readlineSync from 'readline-sync';
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 export function getPackageVersion() {
@@ -131,148 +130,6 @@ export function filterRoles(roleList, allowRoleList) {
     });
     return roles;
 }
-export 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) {
-    const commandName = command.command;
-    switch (commandName) {
-        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;
-        default:
-            throw new Error(`Unknown command: ${commandName}`);
-    }
-}
-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':
-            processSetNewGuidCommand(command.variable, variables);
-            break;
-        case 'New-RandomNumber':
-            processSetNewRandomNumberCommand(command.variable, variables, command.min, command.max);
-            break;
-        case 'New-RandomString':
-            processSetNewRandomStringCommand(command.variable, variables, command.length, command.characterPool);
-            break;
-        case 'ToLowerCase':
-            toLowerCommand(command.variable, variables, command.input);
-            break;
-        case 'ToUpperCase':
-            toUpperCaseCommand(command.variable, variables, command.input);
-            break;
-        case 'Trim':
-            trimCommand(command.variable, variables, command.input);
-            break;
-        case 'Replace':
-            replaceCommand(command.variable, variables, command.input, command.replacement, command.pattern, command.mode);
-            break;
-        default:
-            throw new Error(`Unknown set-command: ${command['function']}`);
-    }
-}
-function processSetNewGuidCommand(variable, variables) {
-    variables[variable] = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
-        .replace(/[xy]/g, (c) => {
-        const r = (Math.random() * 16) | 0;
-        const v = c == 'x' ? r : (r & 0x3) | 0x8;
-        return v.toString(16);
-    })
-        .toUpperCase();
-}
-function processSetNewRandomNumberCommand(variable, variables, min = 0, max = (1 << 30) * 4) {
-    variables[variable] = Math.floor(min + Math.random() * (max - min)).toString();
-}
-function processSetNewRandomStringCommand(variable, variables, length, characterPool = '1234567890qwertyuiopasdfghjklzxcvbnmQWERTYUIOPASDFGHJKLZXCVBNM') {
-    let result = '';
-    for (let i = 0; i < length; i++) {
-        result += characterPool.charAt(Math.floor(Math.random() * characterPool.length));
-    }
-    variables[variable] = result;
-}
-function toLowerCommand(variable, variables, input) {
-    variables[variable] = variables[input].toLowerCase();
-}
-function toUpperCaseCommand(variable, variables, input) {
-    variables[variable] = variables[input].toUpperCase();
-}
-function trimCommand(variable, variables, input) {
-    variables[variable] = variables[input].trim();
-}
-function replaceCommand(variable, variables, input, replacement, pattern, mode) {
-    const regex = new RegExp(pattern, mode);
-    variables[variable] = variables[input].replace(regex, replacement);
-}
-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.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 = path.join(basePath, replaceVariables(file, variables));
-        if (!fs.existsSync(filePath)) {
-            console.warn(`File ${file} does not exist, skipping...`);
-            return;
-        }
-        let content = fs.readFileSync(filePath).toString();
-        content = content.replace(pattern, () => replacement);
-        fs.writeFileSync(filePath, content);
-    });
-}
-function replaceVariables(str, variables) {
-    return str.replace(/\$\{(\w+)\}/g, (_, varName) => variables[varName] ?? '');
-}
 export function logInfo(message, ...parameters) {
     console.log(message, ...parameters);
 }

package/dist/config.js

@@ -170,13 +170,6 @@ function configGenJavascriptDriver(args, mushroomConfig, projectName) {
                     alias = strAlias;
                 break;
             }
-            case 'tarball': {
-                index++;
-                const strTarball = args[index];
-                if (strTarball)
-                    parameters.tarballName = strTarball;
-                break;
-            }
         }
         index++;
     }

package/dist/docs/docs.html

@@ -1310,8 +1310,8 @@
           // fieldName: value
       };
       try {
-          const newId = await mushroom.<span data-mt-attr='{"text": "$entityName"}'></span>.createAsync(<span data-mt-attr='{"text": "$entityName"}'></span>_object);
-          console.log("Thêm mới thành công, new id: %o", newId);
+          const response = await mushroom.<span data-mt-attr='{"text": "$entityName"}'></span>.createAsync(<span data-mt-attr='{"text": "$entityName"}'></span>_object);
+          console.log("Thêm mới thành công, new id: %o", response.result);
       } catch (error) {
           console.error("Có lỗi: %o", error);
       }</pre>

package/dist/docs/docs.v2.html

@@ -4845,9 +4845,9 @@ API.get{{EntityName}}().getViews().{{viewName}}Async(arg, result -> {
     <div>
         <h4>Dữ liệu trả về</h4>
         Trường hợp không có <code>$fields</code>, kết quả trả về có dạng:
-        <pre class="output-without-fields"></pre>
+        <pre class="output-without-fields" data-language="object-spec"></pre>
         Trường hợp <code class="separated-items">$fields=<span class="field-list"></span></code>, kết quả trả về có dạng:
-        <pre class="output-with-fields"></pre>    
+        <pre class="output-with-fields" data-language="object-spec"></pre>    
         <div class="filters">
             <h4>Lọc dữ liệu</h4>
             <div class="defaultFilters">
@@ -4900,9 +4900,9 @@ API.get{{EntityName}}().getViews().{{viewName}}Async(arg, result -> {
     <div>
         <h4>Dữ liệu trả về</h4>
         Trường hợp không có <code>$fields</code>, kết quả trả về có dạng:
-        <pre class="output-without-fields"></pre>
+        <pre class="output-without-fields" data-language="object-spec"></pre>
         Trường hợp <code class="separated-items">$fields=<span class="field-list"></span></code>, kết quả trả về có dạng:
-        <pre class="output-with-fields"></pre>
+        <pre class="output-with-fields" data-language="object-spec"></pre>
     </div>
     <div class="cache"></div>
     <div class="description">
@@ -4922,7 +4922,7 @@ API.get{{EntityName}}().getViews().{{viewName}}Async(arg, result -> {
     </div>
     <div>
         <h4>Dữ liệu gửi lên</h4>
-        <pre class="input-model"></pre>
+        <pre class="input-model" data-language="object-spec"></pre>
     </div>
     <div>
         <h4>Dữ liệu trả lại</h4>
@@ -4958,7 +4958,7 @@ API.get{{EntityName}}().getViews().{{viewName}}Async(arg, result -> {
         X-Mushroom-Create-Many: true
 
         <h4>Dữ liệu gửi lên: Mảng của các đối tượng</h4>
-        <pre class="input-model"></pre>
+        <pre class="input-model" data-language="object-spec"></pre>
     </div>
     <div>
         <h4>Dữ liệu trả lại</h4>
@@ -4985,7 +4985,7 @@ API.get{{EntityName}}().getViews().{{viewName}}Async(arg, result -> {
     </div>
     <div>
         <h4>Dữ liệu gửi lên: </h4>
-        <pre class="input-model"></pre>
+        <pre class="input-model" data-language="object-spec"></pre>
     </div>
     <div>
         <h4>Dữ liệu trả lại</h4>
@@ -5012,7 +5012,7 @@ API.get{{EntityName}}().getViews().{{viewName}}Async(arg, result -> {
     </div>
     <div>
         <h4>Dữ liệu gửi lên: Mảng của các đối tượng</h4>
-        <pre class="input-model"></pre>
+        <pre class="input-model" data-language="object-spec"></pre>
     </div>
     <div>
         <h4>Dữ liệu trả lại</h4>
@@ -5039,7 +5039,7 @@ API.get{{EntityName}}().getViews().{{viewName}}Async(arg, result -> {
     </div>
     <div>
         <h4>Dữ liệu gửi lên: </h4>
-        <pre class="input-model"></pre>
+        <pre class="input-model" data-language="object-spec"></pre>
         Lưu ý:
         <ul>
             <li>Chỉ những trường dữ liệu gửi lên mới được cập nhật</li>
@@ -5125,11 +5125,11 @@ API.get{{EntityName}}().getViews().{{viewName}}Async(arg, result -> {
     </div>
     <div class="request-body">
         <h4>Request body</h4>
-        <pre class="request-body-model"></pre>
+        <pre class="request-body-model" data-language="object-spec"></pre>
     </div>
     <div class="response-body">
         <h4>Response body</h4>
-        <pre class="response-body-model"></pre>
+        <pre class="response-body-model" data-language="object-spec"></pre>
     </div>
 </div>
 
@@ -5178,11 +5178,11 @@ API.get{{EntityName}}().getViews().{{viewName}}Async(arg, result -> {
         <h4>Dữ liệu trả về</h4>
         <div class="output-model">
             Mảng các object:
-            <pre>{{outputModel:html}}</pre>
+            <pre data-language="object-spec">{{outputModel:html}}</pre>
         </div>
         <div class="output-epmty-result">
             Nếu không có phần tử nào, mảng giá trị sau sẽ được trả về:
-            <pre>{{outputEmptyResult}}</pre>
+            <pre data-language="object-spec">{{outputEmptyResult}}</pre>
         </div>
     </div>
 </div>