@busy-web/cli - npm Package Compare versions

Comparing version 0.4.0 to 0.4.1

.vscode/launch.json

@@ -17,3 +17,3 @@ {
             "name": "Launch Program",
-            "program": "${workspaceFolder}/bin/busyweb",
+            "program": "${workspaceFolder}/bin/document",
             "args": [
@@ -20,0 +20,0 @@ "help"

package.json

 {
   "name": "@busy-web/cli",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Command line tools to enhance web dev tasks",
@@ -10,3 +10,4 @@ "main": "src/index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "doc": "./bin/document"
   },
@@ -13,0 +14,0 @@ "preferGlobal": true,

README.md

@@ -11,8 +11,56 @@ # cli
 
-## Usage
+## Docs
 
-#### docker config
+<!--START_DOCS-->
 
-```
-busyweb docker config <SITE_VAR:DOCKER_VAR> [<SITE_VAR:DOCKER_VAR>]
-```
+#### Usage: 
+##### busyweb &lsaquo;command&rsaquo; [options]
+
+#### Example:
+##### busyweb help =&rsaquo; print usage information
+
+#### Commands:
+##### deploy &lsaquo;build&rsaquo;
+    deploy build to server. ARGS build: [ docker | canary | alpha | beta | staging | prod | production ] ( not supported yet )
+    Alias: d
+    Options:
+
+##### docker config &lsaquo;EMBER_CONFIG.PATH:DOCKER_ENV&rsaquo; [...]
+    injects docker config into built ember app
+    Options:
+
+##### ember 
+    check ember-cli version
+    Alias: em
+    Options:
+      -g, --global use global ember install
+      -u, --update update ember if its out of date
+
+##### local &lsaquo;task&rsaquo;
+    util to help manage and maintain local dev environment. ARGS task: [ clean | update | install ]
+    Alias: l
+    Options:
+      -r, --rebuild removes the lockfile and generates a new lockfile based on current package.json only on &lsaquo;install&rsaquo;
+
+##### release &lsaquo;type&rsaquo;
+    tag a new version to be released with a git tag. ARGS type: [ patch | docker | canary | alpha | beta | prod ]
+    Alias: r
+    Options:
+      -l, --local prevents tag from pushing to upstream remote
+      -u, --upstream &lsaquo;name&rsaquo; upstream remote name to push release tags, default: origin
+
+##### template &lsaquo;type&rsaquo; &lsaquo;name&rsaquo;
+    creates a new template file. (not supported yet)
+    Alias: t
+    Options:
+      -d, --delete deletes a template file
+
+
+<!--END_DOCS-->
+
+## Contribute
+
+Contributions are welcome. 
+1. Fork the repo and make the desired changes. 
+2. `yarn run docs` to regenerate readme file.
+3. Then submit a PR request for review. 

src/commands/deploy.js

@@ -10,9 +10,7 @@ /**
 	name: 'deploy',
-	description: 'deploy build to server',
+	description: 'deploy build to server. ARGS build: [ docker | canary | alpha | beta | staging | prod | production ] ( not supported yet )',
 	alias: 'd',
-	args: ['<docker|canary|alpha|beta|staging|prod|production>'],
+	args: ['<build>'],
 	
-	options: [
-		//{ cmd: '--tag', short: '-t', desc: 'checkout a tag and deploy it to the build server' }
-	],
+	options: [],
 	
@@ -19,0 +17,0 @@ run(build) {

src/commands/docker.js

@@ -10,7 +10,5 @@ /**
 	description: 'injects docker config into built ember app',
-	args: ['<action>', '<ember-setting>:<docker-setting>', '...'],
+	args: ['config', '<EMBER_CONFIG.PATH:DOCKER_ENV>', '[...]'],
 	
-	options: [
-		//{ cmd: '--tag', short: '-t', desc: 'checkout a tag and deploy it to the build server' }
-	],
+	options: [],
 
@@ -17,0 +15,0 @@ run(action, ...args) {

src/commands/local.js

@@ -12,5 +12,5 @@ /**
 	name: 'local',
-	description: 'util to help manage and maintain local dev environment',
+	description: 'util to help manage and maintain local dev environment. ARGS task: [ clean | update | install ]',
 	alias: 'l',
-	args: ['<clean|update|install>'],
+	args: ['<task>'],
 	
@@ -17,0 +17,0 @@ options: [

src/commands/release.js

@@ -63,5 +63,5 @@ /**
 	name: 'release',
-	description: 'tag a new version to be released with a git tag',
+	description: 'tag a new version to be released with a git tag. ARGS type: [ patch | docker | canary | alpha | beta | prod ]',
 	alias: 'r',
-	args: ['<patch|docker|canary|alpha|beta|prod>'],
+	args: ['<type>'],
 	
@@ -68,0 +68,0 @@ options: [

src/commands/template.js

@@ -16,3 +16,3 @@ /**
 	name: 'template',
-	description: 'creates a new template file',
+	description: 'creates a new template file. (not supported yet)',
 	alias: 't',
@@ -19,0 +19,0 @@ args: ['<type>', '<name>'],

src/helpers/docker-config.js

@@ -33,5 +33,3 @@
 	const cwd = process.cwd();
-	const envPath = path.join(cwd, 'config/environment');
-	const __module = require(envPath)().modulePrefix;
-	const meta = `${__module}\/config\/environment`; // eslint-disable-line no-useless-escape
+	const meta = `config\/environment`; // eslint-disable-line no-useless-escape
 	const filePath = path.join(cwd, 'dist/index.html');
@@ -53,3 +51,3 @@
 					if (!get(json, em))	{
-						throw new Error(`Error: ${em} not found in ${envPath}`);
+						throw new Error(`Error: ${em} not found in application config`);
 					} else {
@@ -56,0 +54,0 @@ set(json, em, process.env[dm]);

src/utils/logger.js

@@ -31,3 +31,3 @@
 	log(...args) {
-		this.write(colors.grey(stringify(args)));
+		this.write(colors.white.dim(stringify(args)));
 	},
@@ -34,0 +34,0 @@

Fixed alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

27878

increased by11%

Number of lines in readme file

66

increased by266.67%

Number of low supply chain risk alerts

13

decreased by-7.14%

Worsened metrics

Lines of code

723

decreased by-1.23%

No dependency changes