@commercelayer/cli-dev - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

oclif.manifest.json

@@ -1,1 +0,1 @@
-{"version":"0.0.1","commands":{"manifest":{"id":"manifest","description":"generates plugin manifest json","strict":true,"pluginName":"@commercelayer/cli-dev","pluginAlias":"@commercelayer/cli-dev","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"path","description":"path to plugin","default":"."}]},"readme":{"id":"readme","description":"adds commands to README.md in current directory\nThe readme must have any of the following tags inside of it for it to be replaced or else it will do nothing:\n## Usage\n<!-- usage -->\n## Commands\n<!-- commands -->\n\nCustomize the code URL prefix by setting oclif.repositoryPrefix in package.json.\n","strict":true,"pluginName":"@commercelayer/cli-dev","pluginAlias":"@commercelayer/cli-dev","pluginType":"core","aliases":[],"flags":{"dir":{"name":"dir","type":"option","description":"output directory for multi docs","required":true,"multiple":false,"default":"docs"},"multi":{"name":"multi","type":"boolean","description":"create a different markdown page for each topic","allowNo":false},"plugin":{"name":"plugin","type":"boolean","description":"create a plugin readme doc","allowNo":false},"bin":{"name":"bin","type":"option","description":"optional main cli command","multiple":false,"dependsOn":["plugin"]}},"args":[]}}}
+{"version":"0.1.0","commands":{"readme":{"id":"readme","description":"adds commands to README.md in current directory\nThe readme must have any of the following tags inside of it for it to be replaced or else it will do nothing:\n## Usage\n<!-- usage -->\n## Commands\n<!-- commands -->\n\nCustomize the code URL prefix by setting oclif.repositoryPrefix in package.json.\n","strict":true,"pluginName":"@commercelayer/cli-dev","pluginAlias":"@commercelayer/cli-dev","pluginType":"core","aliases":[],"flags":{"dir":{"name":"dir","type":"option","description":"output directory for multi docs","required":true,"multiple":false,"default":"docs"},"multi":{"name":"multi","type":"boolean","description":"create a different markdown page for each topic","allowNo":false},"plugin":{"name":"plugin","type":"boolean","description":"create a plugin readme doc","allowNo":false},"bin":{"name":"bin","type":"option","description":"optional main cli command","multiple":false,"dependsOn":["plugin"]}},"args":[]}}}

package.json

 {
   "name": "@commercelayer/cli-dev",
   "description": "Commerce Layer CLI development tools and helpers",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "author": "Pierluigi Viti <[e-mail]>",
@@ -66,5 +66,5 @@ "bugs": "https://github.com/commercelayer/commercelayer-cli-dev/issues",
     "posttest": "npx lint",
-    "prepack": "npm run build && node ./bin/run manifest",
+    "prepack": "npm run build && oclif manifest",
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
-    "version": "npm run changelog && node ./bin/run readme && git add README.md",
+    "version": "npm run changelog && oclif readme && git add README.md",
     "pretest": "npm run build --noEmit && echo 'Skipping test dir compile check in CI for now (3rd party type error) but you should compile it locally'",
@@ -71,0 +71,0 @@ "build": "rm -rf lib && tsc"

README.md

@@ -22,9 +22,9 @@ @oclif/dev-cli
 $ npm install -g @commercelayer/cli-dev
-$ cl-dev COMMAND
+$ cl-cli-dev COMMAND
 running command...
-$ cl-dev (--version)
-@commercelayer/cli-dev/0.0.1 darwin-x64 node-v16.13.2
-$ cl-dev --help [COMMAND]
+$ cl-cli-dev (--version)
+@commercelayer/cli-dev/0.1.0 darwin-x64 node-v16.13.2
+$ cl-cli-dev --help [COMMAND]
 USAGE
-  $ cl-dev COMMAND
+  $ cl-cli-dev COMMAND
 ...
@@ -35,5 +35,5 @@ ```
 <!-- commands -->
-* [`cl-dev readme`](#cl-dev-readme)
+* [`cl-cli-dev readme`](#cl-cli-dev-readme)
 
-## `cl-dev readme`
+## `cl-cli-dev readme`
 
@@ -44,7 +44,9 @@ adds commands to README.md in current directory
 USAGE
-  $ cl-dev readme --dir <value> [--multi]
+  $ cl-cli-dev readme --dir <value> [--multi] [--bin <value> --plugin]
 
 FLAGS
+  --bin=<value>  optional main cli command
   --dir=<value>  (required) [default: docs] output directory for multi docs
   --multi        create a different markdown page for each topic
+  --plugin       create a plugin readme doc
 
@@ -56,7 +58,7 @@ DESCRIPTION
 
-  # Usage
+  ## Usage
 
   <!-- usage -->
 
-  # Commands
+  ## Commands
 
@@ -63,0 +65,0 @@ <!-- commands -->

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

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

Number of lines in readme file

68

increased by3.03%

Number of low supply chain risk alerts

4

decreased by-50%

Worsened metrics

Total package byte prevSize

23459

decreased by-7.57%

Number of package files

14

decreased by-12.5%

Lines of code

398

decreased by-10.56%

No dependency changes