@clerc/plugin-version 0.40.0 → 0.41.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Ray <https://github.com/so1ve>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 Ray <https://github.com/so1ve>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,25 @@
+# @clerc/plugin-version
+
+[![NPM version](https://img.shields.io/npm/v/@clerc/plugin-version?color=a1b858&label=)](https://www.npmjs.com/package/@clerc/plugin-version)
+
+Clerc plugin to add version command to your cli.
+
+## 📦 Installation
+
+```bash
+$ npm install @clerc/plugin-version
+$ yarn add @clerc/plugin-version
+$ pnpm add @clerc/plugin-version
+```
+
+## 🚀 Usage
+
+```ts
+import { versionPlugin } from "@clerc/plugin-version";
+
+cli.use(versionPlugin());
+```
+
+## 📝 License
+
+[MIT](../../LICENSE). Made with ❤️ by [Ray](https://github.com/so1ve)

package/dist/index.js

@@ -1 +1,53 @@
-import{definePlugin as v}from"@clerc/core";const p=s=>s.length===0?"":s.startsWith("v")?s:`v${s}`,a={en:{"version.description":"Show CLI version","version.notes.1":'The version string begins with a "v".'},"zh-CN":{"version.description":"\u5C55\u793A CLI \u7248\u672C","version.notes.1":'\u7248\u672C\u53F7\u5F00\u5934\u5E26\u6709 "v"\u3002'}},f=({command:s=!0,flag:r=!0}={})=>v({setup:e=>{const{add:t,t:n}=e.i18n;t(a);const o=p(e._version);return s&&(e=e.command("version",n("version.description"),{help:{notes:[n("version.notes.1")]}}).on("version",()=>{process.stdout.write(o)})),r&&(e=e.flag("version",n("version.description"),{alias:"V",type:Boolean,default:!1}),e.inspector({enforce:"pre",fn:(i,u)=>{i.flags.version?process.stdout.write(o):u()}})),e}});export{f as versionPlugin};
+import { definePlugin } from '@clerc/core';
+import { gracefulVersion } from '@clerc/utils';
+
+const locales = {
+  "en": {
+    "version.description": "Show CLI version",
+    "version.notes.1": 'The version string begins with a "v".'
+  },
+  "zh-CN": {
+    "version.description": "\u5C55\u793A CLI \u7248\u672C",
+    "version.notes.1": '\u7248\u672C\u53F7\u5F00\u5934\u5E26\u6709 "v"\u3002'
+  }
+};
+
+const versionPlugin = ({
+  command = true,
+  flag = true
+} = {}) => definePlugin({
+  setup: (cli) => {
+    const { add, t } = cli.i18n;
+    add(locales);
+    const gracefullyVersion = gracefulVersion(cli._version);
+    if (command) {
+      cli = cli.command("version", t("version.description"), {
+        help: {
+          notes: [t("version.notes.1")]
+        }
+      }).on("version", () => {
+        process.stdout.write(gracefullyVersion);
+      });
+    }
+    if (flag) {
+      cli = cli.flag("version", t("version.description"), {
+        alias: "V",
+        type: Boolean,
+        default: false
+      });
+      cli.inspector({
+        enforce: "pre",
+        fn: (ctx, next) => {
+          if (ctx.flags.version) {
+            process.stdout.write(gracefullyVersion);
+          } else {
+            next();
+          }
+        }
+      });
+    }
+    return cli;
+  }
+});
+
+export { versionPlugin };

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@clerc/plugin-version",
-  "version": "0.40.0",
+  "version": "0.41.0",
   "author": "Ray <i@mk1.io> (https://github.com/so1ve)",
+  "type": "module",
   "description": "Clerc plugin version",
   "keywords": [
-    "cli",
-    "clerc",
-    "clerc-plugin",
+    "args",
     "arguments",
     "argv",
-    "args",
+    "clerc",
+    "clerc-plugin",
+    "cli",
     "terminal"
   ],
-  "type": "module",
   "homepage": "https://github.com/so1ve/clerc/tree/main/packages/plugin-version#readme",
   "repository": {
     "type": "git",
@@ -39,15 +39,14 @@
   "publishConfig": {
     "access": "public"
   },
+  "dependencies": {
+    "@clerc/utils": "0.41.0"
+  },
   "peerDependencies": {
     "@clerc/core": "*"
   },
-  "devDependencies": {
-    "@clerc/core": "0.40.0",
-    "@clerc/utils": "0.40.0"
-  },
   "scripts": {
-    "build": "pkgroll --minify",
+    "build": "pkgroll",
     "watch": "pkgroll --watch"
   }
 }