@qqi/check-version 0.0.2 → 0.1.0

package/README.md

@@ -13,27 +13,76 @@ npm install --save @qqi/check-version
 默认使用方式为传入 `name` 参数，代码将执行判断工作目录下的 'packages/[name]' 子 npm 包的版本号是否已存在于线上
 
 ```bash
+# 写法一
 npx @qqi/check-version name=[name]
-
+# 写法二
 npx @qqi/check-version n=[name]
+# 写法三
+npx @qqi/check-version name [name]
+# 写法四
+npx @qqi/check-version n [name]
 ```
 
 也可以传入 `cwd` 参数覆盖默认的判断文件夹，默认查找 'packages' 文件夹下子 npm 包，若您习惯于其他命名方式
 
 ```bash
-# 倘若子主包 core 在 pkgs 文件夹下
-npx @qqi/.check-version name=core cwd=pkgs
+# 倘若子主包 core 在 lists 文件夹下
+npx @qqi/check-version name=core cwd=lists  # 推荐模式
+
+npx @qqi/check-version name core cwd lists
+
+npx @qqi/check-version name=core cwd lists
+
+npx @qqi/check-version name core cwd=lists
+
+npx @qqi/check-version n=core c=lists  # 推荐模式
 
-npx @qqi/.check-version n=core c=pkgs
+npx @qqi/check-version n core c lists
 ```
 
+默认的 name 值为 "." ，即以 packages 目录为项目的根（倘若 package.json 文件在这里的话）
+
 使用 skip 参数是否跳过执行线上版本检测（因为 '0.0.0' 的版本默认为跳过检测，若初始版本非 '0.0.0' 时 ，也可以使用该参数跳过检测）
 
 ```bash
-# 倘若子主包 core 在 pkgs 文件夹下
-npx @qqi/.check-version name=core cwd=pkgs skip
+# 倘若子主包 core 在 lists 文件夹下
+npx @qqi/check-version name=core cwd=lists skip  # 推荐模式
+
+npx @qqi/check-version name=core cwd lists skip
+
+npx @qqi/check-version n=core c=lists s # 推荐模式
+
+npx @qqi/check-version n=core c lists s
+```
+
+若想在其他非分包的项目使用，即单独的项目使用配置，使用 `npx @qqi/check-version c=.` 即可。
+
+## 使用示例
+
+在 `pub.sh` 文件中使用时：
+
+```bash
+# 输出的 npm 发布的 tag。也可以通过调整 cwd 和 name 的参数来适配实际的项目地址
+output=$(npx @qqi/check-version c=. 2>&1)
+tag=""
+# 执行 npx  的返回值
+exit_code=$?
+
+# 如果执行成功，即 tag 值获取成功
+if [ $exit_code -eq 0 ];then
+  tag="$output"
+else
+  echo "$output"
+fi
+
+echo "开始发布 npm 包"
+
+if ! npm publish --provenance --access public --tag ${tag} ; then
+    echo "发布失败"
+    exit 0
+fi
 
-npx @qqi/.check-version n=core c=pkgs s
+echo "🚀🚀  发布成功，完结 🎉🎉 撒花 🎉🎉"
 ```
 
 ## 文档位置

package/bin.mjs

@@ -1,20 +1,28 @@
 #!/usr/bin/env node
-import { _p, pathJoin, fileExist, readFileToJsonSync, getNpmPkgInfo } from 'a-node-tools';
+import { _p, pathJoin, getDirectoryBy, fileExist, readFileToJsonSync, getNpmPkgInfo } from 'a-node-tools';
 import { isUndefined, isNull } from 'a-type-of-js';
 import { Command } from 'a-command';
 
+/**  从版本号中解析到 dist tag  */
+const getTag = (version) => {
+    const versionList = version.split('-');
+    if (versionList.length === 1) {
+        return 'latest';
+    }
+    return 'latest';
+};
 const command = new Command('@qqi/check-version');
 command.bind([
     'cwd <c> (检测的工作文件夹的位置路径，缺省值为当前跟路径的 packages)',
     'skip <s> (跳过线上包版本检测， 默认值为 false)',
-    'name <n> (检测的子包名)',
+    'name <n> (检测的子包名，默认值为 .)',
 ]);
 command.run().isEnd(true);
 const args = command.args.$map;
 /**  工作的相对路径  */
 const cwd = args.cwd?.value?.[0].toString() ?? 'packages';
 /** 获取输入的包名   */
-const name = args.name?.value?.[0].toString() ?? '';
+const name = args.name?.value?.[0].toString() ?? '.';
 /**  是否跳过检测  */
 const skip = args.skip?.value?.[0] !== false ? true : false;
 /**  未检测到输入的包名，则返回 false  */
@@ -23,7 +31,14 @@ if (isUndefined(name) || name === '') {
     process.exit(1);
 }
 /**  文件路径  */
-const filePath = pathJoin(process.cwd(), cwd, name, 'package.json');
+let filePath = pathJoin(process.cwd(), cwd, name);
+/// 下面是冗余步骤，有助于在非根目录下查找 package.json 文件
+const dirPath = getDirectoryBy('package.json', 'file', filePath);
+if (isUndefined(dirPath)) {
+    _p(`${filePath} 文件路径不存在`, false);
+    process.exit(1);
+}
+filePath = pathJoin(dirPath, 'package.json');
 /**  文件路径  */
 const fileIsExist = fileExist(filePath);
 if (isUndefined(fileIsExist)) {
@@ -44,7 +59,7 @@ const pkgInfo = await getNpmPkgInfo(fileContent.name);
 if (isNull(pkgInfo.data)) {
     if (pkgInfo.status === 'notFound' &&
         (skip || fileContent.version === '0.0.0')) {
-        _p(true, false);
+        _p(getTag(fileContent.version), false);
         process.exit(0);
     }
     _p(`${fileContent.name} 包未找到`, false);
@@ -55,5 +70,5 @@ if (pkgInfo.data.time[fileContent.version]) {
     _p(`${fileContent.name} 包版本号已存在`, false);
     process.exit(1);
 }
-_p(true, false);
+_p(getTag(fileContent.version), false);
 process.exit(0);

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@qqi/check-version",
   "type": "module",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "一个检测工作目录下 packages 文件夹下子 npm 包版本是否存在的模块",
   "dependencies": {
-    "a-command": "^2.1.7",
+    "a-command": "^2.1.8",
     "a-js-tools": ">=0.6.1 <1.0.0",
-    "a-node-tools": "^3.1.2",
+    "a-node-tools": "^3.1.4",
     "a-type-of-js": ">=0.2.0 <1.0.0"
   },
   "author": {