create-a-npm 0.0.1 → 0.0.3

package/README.md

@@ -17,4 +17,4 @@ npm create a-npm
 
 ## Other languages
 
-[English](https://github.com/lmssee/ismi/blob/main/README.md) [中文](https://github.com/lmssee/ismi/blob/main/自述文件.md)
+[English](https://github.com/lmssee/createANpm/blob/main/README.md) [中文](https://github.com/lmssee/createANpm/blob/main/自述文件.md)

package/mjs/index.mjs

@@ -2,6 +2,13 @@ import askForName from './src/askForName.mjs';
 import { createNpm } from './src/createNpm.mjs';
 import custom from './src/custom.mjs';
 
+/****************************************************************************
+ * @Author lmssee
+ * @Email lmssee@outlook.com
+ * @FileName index.ts
+ * @Date  周三  08/28/2024
+ * @Description 包源文件的跟文件，该文件暴露相应的接口
+ ****************************************************************************/
 /// 设定包名
 await askForName();
 /// 参看是否自定义包的内容，这里会自定义是否使用 eslint 等相关内容

package/mjs/src/command.mjs

@@ -1,5 +1,13 @@
 import { Command } from 'a-command';
 
+/****************************************************************************
+ * @Author lmssee
+ * @Email lmssee@outlook.com
+ * @ProjectName create-a-npm
+ * @FileName command.ts
+ * @CreateDate  周五  08/30/2024
+ * @Description 一个由 `a-command` 创建的 command 对象
+ ****************************************************************************/
 const command = new Command('create-a-npm');
 /** 暂未配置自定义项，后续会跟上   */
 // command.bind({ 'custom <cm>  (自定义)': [] });

package/mjs/src/createNpm.mjs

@@ -5,6 +5,15 @@ import { packageIndex } from './package/index.mjs';
 import { testFile } from './test/index.mjs';
 import { src } from './library/index.mjs';
 
+/****************************************************************************
+ * @Author lmssee
+ * @Email lmssee@outlook.com
+ * @ProjectName crate-a-npm
+ * @FileName createNpm.ts
+ * @CreateDate  周五  08/30/2024
+ * @Description 创建 npm 主要内容
+ * 该操作出现在命名完成后
+ ****************************************************************************/
 /**
  *
  * 开始根据数据创建包  */

package/mjs/src/custom.mjs

@@ -1,12 +1,39 @@
 import './command.mjs';
-import 'a-node-tools';
+import { runOtherCode, cursorMoveUp } from 'a-node-tools';
 
+/****************************************************************************
+ * @Author lmssee
+ * @Email lmssee@outlook.com
+ * @FileName custom.ts
+ * @Date  周三  08/28/2024
+ * @Description
+ ****************************************************************************/
 /*** 自定义插件的安装  */
+// import { homedir } from 'node:os';
+/**  TODO
+ *
+ *  后期这里要添加 配置文件的读取和配置
+ *
+ *  思路：
+ *  - 从  node:os 的 homedir 获取用户的文件夹目录
+ *
+ */
 /**
  *
  * 自定义
  */
-async function custom () {
+async function custom() {
+    const { data } = await runOtherCode({ code: 'git config user.name' });
+    console.log(data?.replace(/(.*)\n$/, '$1'));
+    cursorMoveUp(3);
+    /** 用户文件的根目录  */
+    // const userDir: string = homedir();
+    /**  判断当前文件是否存在（应该是存在的吧，这里验证有点多此一举） */
+    // const testDir = dirEmpty(userDir) > -1;
+    // if (testDir) {
+    //   console.log(userDir);
+    //   console.log(dirEmpty(userDir));
+    // }
     return;
 }
 

package/mjs/src/data.mjs

@@ -1,6 +1,15 @@
 import { initializeFile, getDirectoryBy, readFileToJsonSync, pathJoin } from 'a-node-tools';
 import { basename } from 'node:path';
 
+/****************************************************************************
+ * @Author lmssee
+ * @Email lmssee@outlook.com
+ * @ProjectName create-a-npm
+ * @FileName data.ts
+ * @CreateDate  周五  08/30/2024
+ * @Description  数据中心
+ * 当配置包名时，后自动创建包的工作路径
+ ****************************************************************************/
 /** 初始化当前工作文件路径  */
 const [__dirname] = initializeFile();
 /** 根据当前被调用文件查找当前包的 package.json  文件配置 */

package/mjs/src/library/index.mjs

@@ -1,19 +1,26 @@
 import data from '../data.mjs';
 import { pathJoin } from 'a-node-tools';
-import { writeFileSync, mkdirSync } from 'node:fs';
+import { mkdirSync } from 'node:fs';
+import { indexTs } from './indexTs.mjs';
+import { srcIndexTs } from './srcIndexTs.mjs';
 
+/****************************************************************************
+ * @Author lmssee
+ * @Email lmssee@outlook.com
+ * @FileName index.ts
+ * @Date  周三  08/28/2024
+ * @Description 生成 sec 文件夹，并导入其他生成项目文件的模块
+ ****************************************************************************/
 /**
  * 导出生成 src 的主文件
  */
 function src() {
-    /// index.ts
-    writeFileSync(data.fileName('index.ts'), `import { _p } from 'a-node-tools';\n _p('hello world');`);
-    // 创建文件
+    // 创建 src 文件夹
     mkdirSync(pathJoin(data.cwd, 'src'));
+    /// index.ts
+    indexTs();
     //
-    writeFileSync(data.fileName('src/index.ts'), `import { _p } from 'a-node-tools';
-// print 'hello ${data.name} on the terminal'  
-_p(\`hello , ${data.name}\`)`);
+    srcIndexTs();
 }
 
 export { src };

package/mjs/src/library/indexTs.mjs

@@ -0,0 +1,23 @@
+import { writeFileSync } from 'node:fs';
+import data from '../data.mjs';
+
+/** 导出生成 index.ts 文件  */
+function indexTs() {
+    /// index.ts
+    writeFileSync(data.fileName('index.ts'), `import './src/index';
+/**  测试函数 
+ * 
+ *   仅做初始化后测试用
+ *    
+ *  @returns {@link undefined}
+ */
+export function testFunction() {
+  console.log('**********************');
+  console.log('测试函数打印内容');
+  console.log('**********************');
+  return;
+}
+  `);
+}
+
+export { indexTs };

package/mjs/src/library/srcIndexTs.mjs

@@ -0,0 +1,14 @@
+import { writeFileSync } from 'node:fs';
+import data from '../data.mjs';
+
+/**  */
+function srcIndexTs() {
+    writeFileSync(data.fileName('src/index.ts'), `import { _p } from 'a-node-tools';
+
+// print 'hello ${data.name} on the terminal'
+// 向终端输出 "你好 ${data.name}"
+_p('welcome ${data.name}');
+`);
+}
+
+export { srcIndexTs };

package/mjs/src/package/package.mjs

@@ -1,6 +1,15 @@
 import data from '../data.mjs';
 import { writeToJsonFile } from '../tools.mjs';
 
+/****************************************************************************
+ * @Author lmssee
+ * @Email lmssee@outlook.com
+ * @FileName package.ts
+ * @Date  周三  08/28/2024
+ * @Description 生成 package.json 文件内容
+ *
+ * 每次调用时都会访问本地的 npm 信息并返回，每一次版本更新都会导致包的更新
+ ****************************************************************************/
 /**
  *  这里之前返回的是一个对象，导致 js 在预编译的时候直接生成一个静态数据
  *  而无法在调用 packageJson 的时候真正的将 data 的最新值带入
@@ -16,12 +25,14 @@ const initData = () => ({
     typings: 'types/index.d.ts',
     author: '___  <___@___.___>  (https://___.___)',
     description: 'here is the project description, please change the content with double underline',
-    script: {
+    scripts: {
         b: 'rollup --config rollup.config.js && tsc -p tsconfig.types.json',
-        build: 'ixxx rm dist run b',
-        diff: 'ixxx pkg diff',
-        prettier: 'ixxx cls && prettier . --write',
-        test: 'rollup --config rollup.config.test.js',
+        build: 'npx ixxx rm dist run b',
+        diff: 'npx ixxx pkg diff',
+        eslint: 'npx ixxx cls && eslint src',
+        beautify: 'npm run prettier',
+        prettier: 'npx ixxx cls && prettier . --write',
+        test: 'npx ixxx cls && rollup --config rollup.config.test.js && node test/out/test/index.mjs',
     },
     files: ['mjs', 'cjs', 'types'],
     exports: {

package/mjs/src/package/prettier.mjs

@@ -2,18 +2,33 @@ import { writeFileSync } from 'node:fs';
 import data from '../data.mjs';
 import { writeToJsonFile } from '../tools.mjs';
 
+/****************************************************************************
+ * @Author lmssee
+ * @Email lmssee@outlook.com
+ * @FileName prettier.ts
+ * @Date  周三  08/28/2024
+ * @Description 生成 prettier 规则的文件
+ *
+ * 包含：
+ * - .prettierignore  prettier 执行忽略文件
+ * - .prettierrc      prettier 配置文件
+ ****************************************************************************/
 /**
  * 导出 prettier 的相关配置文件
+ *
+ * 生成包含：
+ * - .prettierignore  prettier 执行忽略文件
+ * - .prettierrc      prettier 配置文件
  */
 function prettier() {
     // 写入 prettier ignore 忽略规则
-    writeFileSync(data.fileName('.prettierignore'), `node_modules/*
+    writeFileSync(data.fileName('.prettierignore'), `node_modules
 
-*/node_modules
+**/node_modules
 
 ## 打包文件
 
-list
+dist
 
 test/out
 

package/mjs/src/package/readme.mjs

@@ -22,13 +22,13 @@ function readme() {
     /// LICENSE
     license();
     /// 生成 .gitignore 文件
-    writeFileSync(data.fileName('.gitignore'), `node_modules/*
+    writeFileSync(data.fileName('.gitignore'), `node_modules
 
-*/node_modules
+**/node_modules
 
 ## 打包文件
 
-list
+dist
 
 test/out
 

package/mjs/src/test/index.mjs

@@ -1,6 +1,7 @@
 import { pathJoin } from 'a-node-tools';
 import { mkdirSync, writeFileSync } from 'node:fs';
 import data from '../data.mjs';
+import { testFunction } from './testFunction.mjs';
 
 /**
  *
@@ -8,13 +9,23 @@ import data from '../data.mjs';
  *
  * 及其下面的 index.ts 文件
  */
+console.log('====================================');
+console.log(999999);
+console.log('====================================');
 /** 创建 test 及相关的文件 */
 function testFile() {
+    createIndexTs();
+    // 创建 test testFunction 文件
+    testFunction();
+}
+function createIndexTs() {
     const testCwd = pathJoin(data.cwd, 'test');
+    console.log('====================================');
+    console.log(data.cwd);
+    console.log('====================================');
     mkdirSync(testCwd);
-    writeFileSync(pathJoin(testCwd, 'index.ts'), `import { _p } from 'a-node-tools';
-// print 'hello world' on the terminal
-_p('hello world');`);
+    /**  写入测试跟文件  */
+    writeFileSync(pathJoin(testCwd, 'index.ts'), "import './testTestFunction';");
 }
 
 export { testFile };

package/mjs/src/test/testFunction.mjs

@@ -0,0 +1,25 @@
+import { pathJoin } from 'a-node-tools';
+import { writeFileSync } from 'node:fs';
+import data from '../data.mjs';
+
+/****************************************************************************
+ * @Author lmssee
+ * @Email lmssee@outlook.com
+ * @FileName testFunction.ts
+ * @Date  周三  08/28/2024
+ * @Description 测试函数的测试文件，仅做测试用
+ * 倘若后期删除 `testFunction` 测试函数，该文件亦当移除
+ ****************************************************************************/
+function testFunction() {
+    /**  写入  */
+    writeFileSync(pathJoin(data.cwd, 'test/testTestFunction.ts'), `import test from 'node:test';
+import assert from 'node:assert'; 
+import { testFunction }  from  '../index';
+
+
+test('测试测试函数', () => {
+  assert.equal(testFunction(), undefined ,'当两者不相等的我会被打印出来');
+})`);
+}
+
+export { testFunction };

package/mjs/src/tools.mjs

@@ -1,6 +1,17 @@
 import { writeJsonFile } from 'a-node-tools';
 import data from './data.mjs';
 
+/****************************************************************************
+ * @Author lmssee
+ * @Email lmssee@outlook.com
+ * @ProjectName create-a-npm
+ * @FileName tools.ts
+ * @Date  周三  08/28/2024
+ * @Description 工具函数文件
+ *
+ * - printSome                打印彩色信息
+ * - writeToJsonFile          将 json 写入新的文件
+ ****************************************************************************/
 /**
  * 向文件写入 json 数据
  *

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-a-npm",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "author": "lmssee <lmssee@outlook.com>  (https://lmssee.com)",
   "description": "a cli for create a node package module（一个一键生成一个符合特定规则 <就是一个简单的代码模板库> 的 npm 包",
   "scripts": {
@@ -40,18 +40,18 @@
     "registry": "https://registry.npmjs.org/"
   },
   "devDependencies": {
-    "@eslint/js": "^9.8.0",
+    "@eslint/js": "^9.9.1",
     "@rollup/plugin-commonjs": "^25.0.8",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^11.1.6",
-    "@types/node": "^20.14.13",
+    "@types/node": "^20.16.2",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "globals": "^15.9.0",
     "prettier": "^3.3.3",
-    "rollup": "^4.19.2",
+    "rollup": "^4.21.1",
     "rollup-plugin-cleanup": "^3.2.1",
     "rollup-plugin-copy": "^3.5.0",
     "typescript": "^5.5.4",
@@ -63,6 +63,6 @@
   "dependencies": {
     "a-command": "^0.0.4",
     "a-js-tools": "^0.0.0",
-    "a-node-tools": "^0.0.4"
+    "a-node-tools": "^0.0.5"
   }
 }

package/types/src/command.d.ts

@@ -1,3 +1,11 @@
+/****************************************************************************
+ * @Author lmssee
+ * @Email lmssee@outlook.com
+ * @ProjectName create-a-npm
+ * @FileName command.ts
+ * @CreateDate  周五  08/30/2024
+ * @Description 一个由 `a-command` 创建的 command 对象
+ ****************************************************************************/
 import { Command } from 'a-command';
 declare const command: Command;
 export { command };

package/types/src/custom.d.ts

@@ -1,6 +1,21 @@
+/****************************************************************************
+ * @Author lmssee
+ * @Email lmssee@outlook.com
+ * @FileName custom.ts
+ * @Date  周三  08/28/2024
+ * @Description
+ ****************************************************************************/
 /*** 自定义插件的安装  */
+/**  TODO
+ *
+ *  后期这里要添加 配置文件的读取和配置
+ *
+ *  思路：
+ *  - 从  node:os 的 homedir 获取用户的文件夹目录
+ *
+ */
 /**
  *
  * 自定义
  */
-export default function (): Promise<void>;
+export default function custom(): Promise<void>;

package/types/src/library/testFunction.d.ts

@@ -0,0 +1,7 @@
+/****************************************************************************
+ * @Author lmssee
+ * @Email lmssee@outlook.com
+ * @FileName testFunction.ts
+ * @Date  周三  08/28/2024
+ * @Description 测试函数添加
+ ****************************************************************************/

package/types/src/package/prettier.d.ts

@@ -1,4 +1,8 @@
 /**
  * 导出 prettier 的相关配置文件
+ *
+ * 生成包含：
+ * - .prettierignore  prettier 执行忽略文件
+ * - .prettierrc      prettier 配置文件
  */
 export declare function prettier(): void;

package/types/src/test/testFunction.d.ts

@@ -0,0 +1,9 @@
+/****************************************************************************
+ * @Author lmssee
+ * @Email lmssee@outlook.com
+ * @FileName testFunction.ts
+ * @Date  周三  08/28/2024
+ * @Description 测试函数的测试文件，仅做测试用
+ * 倘若后期删除 `testFunction` 测试函数，该文件亦当移除
+ ****************************************************************************/
+export declare function testFunction(): void;

package/types/src/tools.d.ts

@@ -2,8 +2,9 @@
  * 打印一些内容
  *
  * @param message  {@link  String} 将要打印的信息
+ * @returns void
  */
-export declare function printSome(message: string): void;
+export declare function printSome(message: string): undefined;
 /**
  * 向文件写入 json 数据
  *