@commercelayer/cli-dev - npm Package Compare versions

Comparing version 0.1.2 to 0.1.3

lib/commands/readme.js

@@ -64,3 +64,3 @@ "use strict";
         return readme.split('\n').filter(l => l.startsWith('## ') && !l.includes('Table of contents') && !l.includes('What is Commerce Layer'))
-            .map(l => l.trim().slice(2))
+            .map(l => l.slice(2).trim())
             .map(l => `* [${l}](#${slugify.slug(l)})`)
@@ -70,5 +70,6 @@ .join('\n');
     usage(config) {
-        var _a;
-        const versionFlags = ['--version', ...((_a = config.pjson.oclif.additionalVersionFlags) !== null && _a !== void 0 ? _a : []).sort()];
-        const versionFlagsString = `(${versionFlags.join('|')})`;
+        /*
+        const versionFlags = ['--version', ...(config.pjson.oclif.additionalVersionFlags ?? []).sort()]
+        const versionFlagsString = `(${versionFlags.join('|')})`
+        */
         return [
@@ -138,3 +139,3 @@ `\`\`\`sh-session
                 title,
-                '```\n' + wrapper.formatCommand(c).trim() + '\n```',
+                '```sh-session\n' + wrapper.formatCommand(c).trim() + '\n```',
                 this.commandCode(config, c),
@@ -141,0 +142,0 @@ ]).join('\n\n');

oclif.manifest.json

@@ -1,1 +0,1 @@
-{"version":"0.1.2","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":[]}}}
+{"version":"0.1.3","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.1.2",
+  "version": "0.1.3",
   "author": "Pierluigi Viti <[e-mail]>",
@@ -17,3 +17,3 @@ "bugs": "https://github.com/commercelayer/commercelayer-cli-dev/issues",
     "@types/mocha": "^5.2.7",
-    "@types/node": "^16.11.25",
+    "@types/node": "^17.0.21",
     "chai": "^4.3.6",
@@ -27,3 +27,3 @@ "eslint": "^5.16.0",
     "nyc": "^14.1.1",
-    "ts-node": "^10.5.0",
+    "ts-node": "^10.6.0",
     "typescript": "^4.5.5"
@@ -70,3 +70,3 @@ },
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
-    "version": "npm run changelog && oclif readme && git add README.md",
+    "version": "npm run changelog && ./bin/run 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'",
@@ -73,0 +73,0 @@ "build": "rm -rf lib && tsc"

README.md

@@ -1,3 +0,2 @@
-@oclif/dev-cli
-===============
+# @oclif/dev-cli
 
@@ -15,28 +14,28 @@ helpers for oclif CLIs
 <!-- toc -->
+
 * [Usage](#usage)
 * [Commands](#commands)
 <!-- tocstop -->
-# Usage
+
+## Usage
 <!-- usage -->
+
 ```sh-session
-$ npm install -g @commercelayer/cli-dev
-$ cl-cli-dev COMMAND
-running command...
-$ cl-cli-dev (--version)
-@commercelayer/cli-dev/0.1.2 darwin-x64 node-v16.13.2
-$ cl-cli-dev --help [COMMAND]
-USAGE
-  $ cl-cli-dev COMMAND
-...
+      $ cl-cli-dev COMMAND
+
+      $ cl-cli-dev (-v | version | --version) to check the version of the CLI you have installed.
+
+      $ cl-cli-dev [COMMAND] (--help | -h) for detailed information about CLI commands.
 ```
 <!-- usagestop -->
-# Commands
+## Commands
 <!-- commands -->
+
 * [`cl-cli-dev readme`](#cl-cli-dev-readme)
 
-## `cl-cli-dev readme`
+### `cl-cli-dev readme`
 
-adds commands to README.md in current directory
+Adds commands to README.md in current directory
 
-```
+```sh-session
 USAGE
@@ -43,0 +42,0 @@ $ cl-cli-dev readme --dir <value> [--multi] [--bin <value> --plugin]

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

Improved metrics

Lines of code

402

increased by0.25%

Worsened metrics

Total package byte prevSize

23541

decreased by-0.1%

Number of lines in readme file

67

decreased by-1.47%

No dependency changes