mushroom-cli 1.2.0-alpha.10 → 1.2.0-alpha.12

package/README.md

@@ -1,211 +1,233 @@
-# Mushroom CLI
-
-## Init
-
-Init a mushroom json file
-
-```bash
-npx mushroom-cli init json ./api/SampleProject.json [silent]
-```
-
-Init a DotNet Core project which pre-install Mushroom Server
-
-```bash
-npx mushroom-cli init netcore [projectName]
-```
-
-## Configure
-
-Add the mushroom json file into mushroom-config.json
-
-```bash
-npx mushroom-cli config add ./api/yourProjectName.json
-```
-
-Config gen docs api
-
-```bash
-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
-
-```bash
-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]
-```
-
-Config gen typescript driver
-
-```bash
-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
-
-```bash
-npx mushroom-cli config gen projectName "c#-mongo" ./API/Generated.cs [alias aliasName]
-```
-
-Config gen entities for CSharp project which calls Mushroom API
-
-```bash
-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 docs api (html format)
-
-```bash
-npx mushroom-cli gen projectName[@aliasName] docs [v1] [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"
-```
-
-Generate javascript driver
-
-```bash
-npx mushroom-cli gen projectName[@aliasName] "js-driver"
-```
-
-Generate typescript driver
-
-```bash
-npx mushroom-cli gen projectName[@aliasName] "ts-driver"
-```
-
-Generate entities for Mushroom project in CSharp and using MongoDb
-
-```bash
-npx mushroom-cli gen projectName[@aliasName] "c#-mongo"
-```
-
-Generate entities for CSharp project which calls Mushroom API
-
-```bash
-npx mushroom-cli gen projectName[@aliasName] "c#-driver"
-```
-
-## Merge
-
-```bash
-npx mushroom-cli merge output-path.json
-```
-
-## Update
-
-Update ts code (configuration was stored in mushroom-config.json file)
-
-```bash
-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
-```
-
-## Other
-
-Disable checking for update:
-
-```bash
-npx mushroom-cli parameters --no-check-update
-```
-
-## Version
-
-### 1.2.0-alpha.10
-
-Improvement:
-
-* gen-docs: add default-value information of fields
-
-### 1.2.0-alpha.9
-
-Improvement:
-
-* gen-docs
-  * v1.2: minify, fix bug (some fields are not excluded)
-
-### 1.2.0-alpha.8
-
-Improvement:
-
-* gen-docs
-  * v1.2: deal with very big api docs
-  * v1: prerender all docs html (need more RAM, less performance)
-
-### 1.2.0-alpha.7
-
-New features:
-
-* init netcore: Support some new set-functions: `ToLowerCase`, `ToUpperCase`, `Trim`, `Replace`
-
-Changes:
-
-* init netcore: Operating fail if unknown command or set-function found
-
-### 1.2.0-alpha.6
-
-New features:
-
-* gen-ts-driver: Support offline mode
-
-Changes:
-
-* gen-api-docs: Improve generating api-docs
-* gen-csharp: Generate resource classes with `partial`
-
-### 1.2.0-alpha.5
-
-New features:
-
-* Improve documentation generation: view, custom action.
-
-### 1.2.0-alpha.4
-
-Fixed bugs:
-
-* Generate api docs: doesn't exclude fields of object in an array
-
-### 1.2.0-alpha.3
-
-Fixed bugs:
-
-* Generate wrong required field for view parameter
-
-### 1.2.0-alpha.2
-
-New features:
-
-* Support merge command
-
-### 1.2.0-alpha.1
-
-New features:
-
-* Support type for View result
-
-### 1.1.0
-
-Support MushroomServer 0.2.25.4 or later
-
-Support mushroomjs 1.1.0 or later
+# Mushroom CLI
+
+## Init
+
+Init a mushroom json file
+
+```bash
+npx mushroom-cli init json ./api/SampleProject.json [silent]
+```
+
+Init a DotNet Core project which pre-install Mushroom Server
+
+```bash
+npx mushroom-cli init netcore [projectName]
+```
+
+## Configure
+
+Add the mushroom json file into mushroom-config.json
+
+```bash
+npx mushroom-cli config add ./api/yourProjectName.json
+```
+
+Config gen docs api
+
+```bash
+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
+
+```bash
+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]
+```
+
+Config gen typescript driver
+
+```bash
+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
+
+```bash
+npx mushroom-cli config gen projectName "c#-mongo" ./API/Generated.cs [alias aliasName]
+```
+
+Config gen entities for CSharp project which calls Mushroom API
+
+```bash
+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 docs api (html format)
+
+```bash
+npx mushroom-cli gen projectName[@aliasName] docs [v1] [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"
+```
+
+Generate javascript driver
+
+```bash
+npx mushroom-cli gen projectName[@aliasName] "js-driver"
+```
+
+Generate typescript driver
+
+```bash
+npx mushroom-cli gen projectName[@aliasName] "ts-driver"
+```
+
+Generate entities for Mushroom project in CSharp and using MongoDb
+
+```bash
+npx mushroom-cli gen projectName[@aliasName] "c#-mongo"
+```
+
+Generate entities for CSharp project which calls Mushroom API
+
+```bash
+npx mushroom-cli gen projectName[@aliasName] "c#-driver"
+```
+
+## Merge
+
+```bash
+npx mushroom-cli merge output-path.json
+```
+
+## Update
+
+Update ts code (configuration was stored in mushroom-config.json file)
+
+```bash
+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
+```
+
+## Other
+
+Disable checking for update:
+
+```bash
+npx mushroom-cli parameters --no-check-update
+```
+
+## Version
+
+### 1.2.0-alpha.12
+
+New:
+
+- init netcore:
+  - Support new set-functions: `New-RandomNumber`, `New-RandomString`
+
+### 1.2.0-alpha.11
+
+New:
+
+- gen-ts:
+  - export type for object fields
+
+Improvement:
+
+- gen-docs:
+  - allow user add and change API root url
+  - filter role list
+  - format cURL to easy to copy and paste to Postman
+  - lighten font on MacOS
+
+### 1.2.0-alpha.10
+
+Improvement:
+
+- gen-docs: add default-value information of fields
+
+### 1.2.0-alpha.9
+
+Improvement:
+
+- gen-docs
+  - v1.2: minify, fix bug (some fields are not excluded)
+
+### 1.2.0-alpha.8
+
+Improvement:
+
+- gen-docs
+  - v1.2: deal with very big api docs
+  - v1: prerender all docs html (need more RAM, less performance)
+
+### 1.2.0-alpha.7
+
+New features:
+
+- init netcore: Support some new set-functions: `ToLowerCase`, `ToUpperCase`, `Trim`, `Replace`
+
+Changes:
+
+- init netcore: Operating fail if unknown command or set-function found
+
+### 1.2.0-alpha.6
+
+New features:
+
+- gen-ts-driver: Support offline mode
+
+Changes:
+
+- gen-api-docs: Improve generating api-docs
+- gen-csharp: Generate resource classes with `partial`
+
+### 1.2.0-alpha.5
+
+New features:
+
+- Improve documentation generation: view, custom action.
+
+### 1.2.0-alpha.4
+
+Fixed bugs:
+
+- Generate api docs: doesn't exclude fields of object in an array
+
+### 1.2.0-alpha.3
+
+Fixed bugs:
+
+- Generate wrong required field for view parameter
+
+### 1.2.0-alpha.2
+
+New features:
+
+- Support merge command
+
+### 1.2.0-alpha.1
+
+New features:
+
+- Support type for View result
+
+### 1.1.0
+
+Support MushroomServer 0.2.25.4 or later
+
+Support mushroomjs 1.1.0 or later

package/dist/check-update.js

@@ -0,0 +1,5 @@
+import fetch from 'node-fetch';
+export default async function checkUpdate() {
+    const res = await fetch('https://registry.npmjs.org/mushroom-cli/');
+    return await res.json();
+}