@ruan-cat/utils 4.8.1 → 4.9.1

package/README.md

@@ -1 +1,9 @@
-详情看[此文件](./src/index.md)。
+---
+order: 10
+dir:
+  order: 10
+---
+
+# 工具包
+
+这是阮喵喵开发的工具包，提供了一些工具函数。

package/dist/node-esm/index.d.ts

@@ -39,6 +39,19 @@ declare function hasChangelogMd(): boolean;
  */
 declare function copyChangelogMd(/** 目标文件夹 */ target: string): void;
 
+/** 检查当前运行的根目录 是否存在文件名大写的 `README.md` 文件 */
+declare function hasCapitalReadmeMd(): boolean;
+/** 检查当前运行的根目录 是否存在文件名小写的 `readme.md` 文件 */
+declare function hasLowerCaseReadmeMd(): boolean;
+/** 检查当前运行的根目录 是否存在任意一个大小写命名的 README.md 文件 */
+declare function hasReadmeMd(): boolean;
+/**
+ * 将 README.md 文件移动到指定要求的位置内，并重命名为 index.md
+ * @description
+ * 该函数相当于实现 `cpx README.md docs` 命令
+ */
+declare function copyReadmeMd(/** 目标文件夹 */ target: string): void;
+
 interface WriteYaml2mdParams<T = Record<string, any>> {
     /** 目标md文件地址 */
     mdPath: string;
@@ -59,4 +72,4 @@ interface AddChangelog2docOptions<T = Record<string, any>> {
 /** 将变更日志添加到指定的文档目录内 并提供参数 */
 declare function addChangelog2doc<T>(options: AddChangelog2docOptions<T>): void;
 
-export { type AddChangelog2docOptions, type PackageInfo, type WriteYaml2mdParams, addChangelog2doc, clean, copyChangelogMd, defaultCleanTargets, getRuanCatPkgInfo, hasChangelogMd, writeYaml2md };
+export { type AddChangelog2docOptions, type PackageInfo, type WriteYaml2mdParams, addChangelog2doc, clean, copyChangelogMd, copyReadmeMd, defaultCleanTargets, getRuanCatPkgInfo, hasCapitalReadmeMd, hasChangelogMd, hasLowerCaseReadmeMd, hasReadmeMd, writeYaml2md };

package/dist/node-esm/index.js

@@ -80,6 +80,11 @@ function generateSpawnSync(spawnSyncSimpleParams) {
   });
 }
 
+// src/conditions.ts
+function isConditionsSome(conditions) {
+  return conditions.some((condition) => condition());
+}
+
 // src/print.ts
 import { isPlainObject, isArray } from "lodash-es";
 
@@ -131,9 +136,48 @@ function copyChangelogMd(target) {
   fs.copyFileSync(source, destination);
 }
 
+// src/node-esm/scripts/copy-readme.ts
+import fs2 from "fs";
+import path2 from "path";
+import consola3 from "consola";
+var capitalReadmeMd = "README.md";
+var lowerCaseReadmeMd = "readme.md";
+function hasCapitalReadmeMd() {
+  const res = fs2.existsSync(path2.resolve(process.cwd(), capitalReadmeMd));
+  if (!res) {
+    consola3.warn(`\u5F53\u524D\u9879\u76EE\u6839\u76EE\u5F55\u4E0D\u5B58\u5728 ${capitalReadmeMd} \u6587\u4EF6`);
+  }
+  return res;
+}
+function hasLowerCaseReadmeMd() {
+  const res = fs2.existsSync(path2.resolve(process.cwd(), lowerCaseReadmeMd));
+  if (!res) {
+    consola3.log(`\u5F53\u524D\u9879\u76EE\u6839\u76EE\u5F55\u4E0D\u5B58\u5728 ${lowerCaseReadmeMd} \u6587\u4EF6`);
+  }
+  return res;
+}
+function hasReadmeMd() {
+  const res = isConditionsSome([() => hasCapitalReadmeMd(), () => hasCapitalReadmeMd()]);
+  return res;
+}
+function copyReadmeMd(target) {
+  if (!hasReadmeMd()) {
+    return;
+  }
+  let readmeFileName = capitalReadmeMd;
+  if (hasCapitalReadmeMd()) {
+    readmeFileName = capitalReadmeMd;
+  } else if (hasLowerCaseReadmeMd()) {
+    readmeFileName = lowerCaseReadmeMd;
+  }
+  const source = path2.resolve(process.cwd(), readmeFileName);
+  const destination = path2.resolve(process.cwd(), target, "index.md");
+  fs2.copyFileSync(source, destination);
+}
+
 // src/node-esm/scripts/yaml-to-md.ts
 import { readFileSync, writeFileSync } from "fs";
-import { consola as consola3 } from "consola";
+import { consola as consola4 } from "consola";
 import { isUndefined } from "lodash-es";
 
 // ../../node_modules/.pnpm/js-yaml@4.1.0/node_modules/js-yaml/dist/js-yaml.mjs
@@ -2760,16 +2804,16 @@ var js_yaml_default = jsYaml;
 
 // src/node-esm/scripts/yaml-to-md.ts
 function writeYaml2md(params) {
-  consola3.info(` \u5F53\u524D\u8FD0\u884C\u7684\u5730\u5740\u4E3A\uFF1A ${process.cwd()} `);
+  consola4.info(` \u5F53\u524D\u8FD0\u884C\u7684\u5730\u5740\u4E3A\uFF1A ${process.cwd()} `);
   const { mdPath, data } = params;
   if (isUndefined(mdPath)) {
-    consola3.error(" \u8BF7\u63D0\u4F9Bmd\u6587\u4EF6\u7684\u5730\u5740 ");
+    consola4.error(" \u8BF7\u63D0\u4F9Bmd\u6587\u4EF6\u7684\u5730\u5740 ");
     process.exit(1);
   }
   try {
     readFileSync(mdPath, "utf-8");
   } catch (error) {
-    consola3.error(` \u6587\u4EF6 ${mdPath} \u4E0D\u5B58\u5728 `);
+    consola4.error(` \u6587\u4EF6 ${mdPath} \u4E0D\u5B58\u5728 `);
     process.exit(1);
   }
   const mdContent = readFileSync(mdPath, "utf-8");
@@ -2779,18 +2823,18 @@ ${yamlContent}---
 
 ${mdContent}`;
   writeFileSync(mdPath, newContent, "utf-8");
-  consola3.success(` \u5DF2\u5C06YAML\u6570\u636E\u5199\u5165\u5230 ${mdPath} `);
+  consola4.success(` \u5DF2\u5C06YAML\u6570\u636E\u5199\u5165\u5230 ${mdPath} `);
 }
 
 // src/node-esm/scripts/add-changelog-to-doc.ts
-import path2 from "path";
+import path3 from "path";
 function addChangelog2doc(options) {
   const { data, target } = options;
   if (!hasChangelogMd()) {
     return;
   }
   copyChangelogMd(target);
-  const mdPath = path2.resolve(process.cwd(), target, "CHANGELOG.md");
+  const mdPath = path3.resolve(process.cwd(), target, "CHANGELOG.md");
   writeYaml2md({
     mdPath,
     data
@@ -2800,9 +2844,13 @@ export {
   addChangelog2doc,
   clean,
   copyChangelogMd,
+  copyReadmeMd,
   defaultCleanTargets,
   getRuanCatPkgInfo,
+  hasCapitalReadmeMd,
   hasChangelogMd,
+  hasLowerCaseReadmeMd,
+  hasReadmeMd,
   writeYaml2md
 };
 /*! Bundled license information: