create-a-npm 0.0.0 → 0.0.1

package/LICENSE

@@ -1,13 +1,13 @@
-Copyright (c) <2024> <letmiseesee>
-
-Permission to use, copy, modify, and/or distribute this software for any  
-purpose with or without fee is hereby granted, provided that the above  
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES  
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF  
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR  
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES  
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN  
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF  
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+Copyright (c) <2024> <letmiseesee>
+
+Permission to use, copy, modify, and/or distribute this software for any  
+purpose with or without fee is hereby granted, provided that the above  
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES  
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF  
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR  
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES  
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN  
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF  
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -1,26 +1,20 @@
-# is mi
-
-long long ago, in i'm a child.
-
-At that time, I was still in school and my English class was terrible.
-
-In class, the foreign language teacher asked me to go to the podium to write English words.
-
-and I wrote "This is mi" .
-
-My classmates laughed uncontrollably when they saw it,
-
-and then they called me 'is mi'
-
-## install
-
-```sh
-npm install  -g  ismi
-```
-
-## Other languages
-
-<table><tr>
-<td><a href="https://github.com/lmssee/ismi/blob/main/README.md"  target="_self">English</a></td>
-<td><a href="https://github.com/lmssee/ismi/blob/main/自述文件.md"  target="_self">中文</a></td>
-</tr></table>
+# create a node package module
+
+This package is used to generate a node package based on `typescript`, built using `rollup`, formatted using `prettier`, and checked using `eslint`
+
+## install
+
+```sh
+npm install  -g create-a-npm
+```
+
+## use
+
+```sh
+#  Non essential installation
+npm create a-npm
+```
+
+## Other languages
+
+[English](https://github.com/lmssee/ismi/blob/main/README.md) [中文](https://github.com/lmssee/ismi/blob/main/自述文件.md)

package/mjs/index.mjs

@@ -0,0 +1,10 @@
+import askForName from './src/askForName.mjs';
+import { createNpm } from './src/createNpm.mjs';
+import custom from './src/custom.mjs';
+
+/// 设定包名
+await askForName();
+/// 参看是否自定义包的内容，这里会自定义是否使用 eslint 等相关内容
+await custom();
+/// 开始包创建
+await createNpm();

package/mjs/src/askForName.mjs

@@ -0,0 +1,90 @@
+import { command } from './command.mjs';
+import data from './data.mjs';
+import { _p, Color, dirEmpty, cursorMoveUp, cursorAfterClear } from 'a-node-tools';
+import { mkdirSync } from 'node:fs';
+
+/** Inquire about the current package name  \
+ * 查看是否当前有项目名
+ */
+async function askForName() {
+    /** The name of the package to be created  \
+     * 将创建的包的名称
+     */
+    let commandName = await command.question({
+        text: '您即将创建的包名',
+        tip: '请使用空格/连字符(-)做分隔符',
+        private: true,
+    });
+    /** Clean up spaces and convert hyphens
+     *
+     * 清理空格即转换连字符 */
+    commandName = commandName.trim().replace(/\s+/gm, '-');
+    /**  */
+    if (commandName.length == 0 || commandName[0].match(/[^a-z]/)) {
+        _p(Color.fromRgb('您的输入为空或首字符非法 \n', '#ff0'));
+        await aslForAgainOrQuit('您的输入有误，请重试', '重试或退出');
+        return;
+    }
+    const dirIsEmpty = dirEmpty(commandName);
+    /** Detected that the current directory contains a package with the same name
+     *
+     * 检测出当前目录下包含同名包且不为空
+     */
+    if (dirIsEmpty == 0) {
+        _p(Color.fromRgb('当前目录下存在非空同名文件夹 \n', '#ff0'));
+        await aslForAgainOrQuit('更换为其他名称', '更换为其他的名称或退出');
+        /**
+         *
+         * 当前任务已完成，避免数据污染，需要 return 结束
+         */
+        return;
+    }
+    /** 先进行赋值 */
+    data.name = commandName;
+    /*** 根据刚才的判断参看是否为非 */
+    if (dirIsEmpty == -1) {
+        /** In the current state,
+         *  it indicates that there is no folder with the same name in the working directory.
+         * In this case, create an empty folder
+         *
+         *  当前状态下表明该工作目录下并没有同名文件夹，这时候创建一个空的文件夹  */
+        mkdirSync(commandName, { recursive: true });
+    }
+}
+/**
+ *
+ * 问询当前不符合的情况下是否要重试或直接退出
+ *
+ * @param askMessage {@link String}  询问的文本
+ *
+ * @param [text=''] {@link String} 展示的文本
+ *
+ * @returns  Promise<void>>  {@link  Promise} 没有返回值
+ */
+async function aslForAgainOrQuit(askMessage, text = '') {
+    const tip = [askMessage, '退出'];
+    text = text == '' ? `${askMessage}或退出` : text;
+    const select = await command.question({
+        text,
+        tip,
+        private: true,
+    }, true);
+    // Cover the printed information on top
+    // 覆盖上面的打印信息
+    cursorMoveUp(2);
+    cursorAfterClear();
+    // If the user chooses to exit
+    // 倘若用户选择了退出
+    if (select === tip[1]) {
+        // _p('好的，即将退出');
+        command.end;
+    }
+    else {
+        // The user calls himself to restart the query after selecting Continue
+        // 用户选择了继续后调用自己重新开始问询
+        await askForName();
+        return;
+    }
+}
+
+export { askForName as default };

package/mjs/src/command.mjs

@@ -0,0 +1,9 @@
+import { Command } from 'a-command';
+
+const command = new Command('create-a-npm');
+/** 暂未配置自定义项，后续会跟上   */
+// command.bind({ 'custom <cm>  (自定义)': [] });
+// 执行，并在触发 -h、-v 时直接结束应用
+command.run().isEnd.end;
+
+export { command };

package/mjs/src/createNpm.mjs

@@ -0,0 +1,29 @@
+import askForName from './askForName.mjs';
+import custom from './custom.mjs';
+import data from './data.mjs';
+import { packageIndex } from './package/index.mjs';
+import { testFile } from './test/index.mjs';
+import { src } from './library/index.mjs';
+
+/**
+ *
+ * 开始根据数据创建包  */
+async function createNpm() {
+    /**
+     *
+     *  检测是否遗漏了询问包名
+     *
+     * 倘若并没有配置 name 属性值，则
+     * */
+    if (data.name == '') {
+        await askForName();
+        await custom();
+        await createNpm();
+        return;
+    }
+    packageIndex();
+    src();
+    testFile();
+}
+
+export { createNpm };

package/mjs/src/custom.mjs

@@ -0,0 +1,13 @@
+import './command.mjs';
+import 'a-node-tools';
+
+/*** 自定义插件的安装  */
+/**
+ *
+ * 自定义
+ */
+async function custom () {
+    return;
+}
+
+export { custom as default };

package/mjs/src/data.mjs

@@ -0,0 +1,56 @@
+import { initializeFile, getDirectoryBy, readFileToJsonSync, pathJoin } from 'a-node-tools';
+import { basename } from 'node:path';
+
+/** 初始化当前工作文件路径  */
+const [__dirname] = initializeFile();
+/** 根据当前被调用文件查找当前包的 package.json  文件配置 */
+let cwd = getDirectoryBy('package.json', 'file', __dirname);
+/** 这里好像难以避免 cwd 为 undefined */
+if (cwd == undefined) {
+    cwd = process.cwd();
+}
+/** 读取当前包的 package.json 文件内容  */
+const packageJsonData = readFileToJsonSync(pathJoin(cwd, 'package.json'));
+/** 导出构建数据 */
+var data = {
+    /** 工作目录 */
+    cwd: '',
+    /** 创建文件的路径 */
+    fileName(str) {
+        return pathJoin(this.cwd, str);
+    },
+    /** 项目名称
+     *
+     * 该值在 askForName 中进行赋值
+     */
+    get name() {
+        return this.package.name;
+    },
+    set name(name) {
+        let finalName;
+        /** 将创建路径储存起来  */
+        this.cwd = name;
+        /** 查看创建路径和基础根路径是否相同 */
+        if (basename(name) == name) {
+            finalName = name;
+        }
+        else {
+            finalName = basename(name);
+        }
+        this.package.name = finalName;
+    },
+    /** 是否携带 npx 指令
+     *  该值将在 custom 过程中进行赋值 */
+    bin: false,
+    /** 包中需要的内容  */
+    package: {
+        /**包名称  */
+        name: '',
+        /** 依赖 */
+        dependencies: packageJsonData.dependencies || {},
+        /** 开发依赖 */
+        devDependencies: packageJsonData.devDependencies || {},
+    },
+};
+
+export { data as default };

package/mjs/src/library/index.mjs

@@ -0,0 +1,19 @@
+import data from '../data.mjs';
+import { pathJoin } from 'a-node-tools';
+import { writeFileSync, mkdirSync } from 'node:fs';
+
+/**
+ * 导出生成 src 的主文件
+ */
+function src() {
+    /// index.ts
+    writeFileSync(data.fileName('index.ts'), `import { _p } from 'a-node-tools';\n _p('hello world');`);
+    // 创建文件
+    mkdirSync(pathJoin(data.cwd, 'src'));
+    //
+    writeFileSync(data.fileName('src/index.ts'), `import { _p } from 'a-node-tools';
+// print 'hello ${data.name} on the terminal'  
+_p(\`hello , ${data.name}\`)`);
+}
+
+export { src };

package/mjs/src/package/eslint.mjs

@@ -0,0 +1,24 @@
+import { writeFileSync } from 'node:fs';
+import data from '../data.mjs';
+
+/**
+ * eslint 配置
+ *
+ */
+function eslintConfig() {
+    writeFileSync(data.fileName('eslint.config.js'), `import globals from 'globals';
+import pluginJs from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import eslintConfigPrettier from 'eslint-config-prettier';
+
+export default [
+  { files: ['**/*.{js,mjs,cjs,ts}'] },
+  { languageOptions: { globals: globals.browser } },
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended,
+  eslintConfigPrettier,
+];
+`);
+}
+
+export { eslintConfig };

package/mjs/src/package/index.mjs

@@ -0,0 +1,21 @@
+import { eslintConfig } from './eslint.mjs';
+import { packageJson } from './package.mjs';
+import { prettier } from './prettier.mjs';
+import { readme } from './readme.mjs';
+import { rollup } from './rollup.mjs';
+import { tsconfigJson } from './tsconfig.mjs';
+
+/**
+ *
+ * 导出 package 的主文件
+ */
+function packageIndex() {
+    packageJson();
+    tsconfigJson();
+    rollup();
+    readme();
+    eslintConfig();
+    prettier();
+}
+
+export { packageIndex };

package/mjs/src/package/package.mjs

@@ -0,0 +1,63 @@
+import data from '../data.mjs';
+import { writeToJsonFile } from '../tools.mjs';
+
+/**
+ *  这里之前返回的是一个对象，导致 js 在预编译的时候直接生成一个静态数据
+ *  而无法在调用 packageJson 的时候真正的将 data 的最新值带入
+ *  这便是现在以函数的形式进行返回，能够在调用时直接获取 data 的最新值
+ *
+ */
+/**  除了 data 中提供的数据以外的数据   */
+const initData = () => ({
+    name: '',
+    type: 'module',
+    version: '0.0.0',
+    main: 'cjs/index.cjs',
+    typings: 'types/index.d.ts',
+    author: '___  <___@___.___>  (https://___.___)',
+    description: 'here is the project description, please change the content with double underline',
+    script: {
+        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',
+    },
+    files: ['mjs', 'cjs', 'types'],
+    exports: {
+        '.': {
+            import: {
+                default: './mjs/index.mjs',
+                types: './types/index.d.ts',
+            },
+            require: {
+                default: './cjs/index.cjs',
+                types: './types/index.d.ts',
+            },
+        },
+    },
+    keywords: [data.name],
+    license: 'ISC',
+    homepage: 'https://___.___',
+    bugs: {
+        url: `https://github.com/__/${data.name}/issues`,
+        email: '__@__.__',
+    },
+    repository: {
+        type: 'git',
+        url: `git+https://github.com/___/${data.name}.git')`,
+    },
+    publishConfig: {
+        access: 'public',
+        registry: 'https://registry.npmjs.org/',
+    },
+});
+/** 生成 package.json 文件内容  */
+function packageJson() {
+    const bin = {};
+    bin[``] = 'bin/index.js';
+    const finalData = Object.assign(initData(), data.package, { bin });
+    writeToJsonFile('package.json', finalData);
+}
+
+export { packageJson };

package/mjs/src/package/prettier.mjs

@@ -0,0 +1,38 @@
+import { writeFileSync } from 'node:fs';
+import data from '../data.mjs';
+import { writeToJsonFile } from '../tools.mjs';
+
+/**
+ * 导出 prettier 的相关配置文件
+ */
+function prettier() {
+    // 写入 prettier ignore 忽略规则
+    writeFileSync(data.fileName('.prettierignore'), `node_modules/*
+
+*/node_modules
+
+## 打包文件
+
+list
+
+test/out
+
+.DS_Store`);
+    /// 写入规则
+    writeToJsonFile('.prettierrc', {
+        // 屏幕单行的宽度
+        printWidth: 80,
+        // tab 宽度，默认是 2 ，但是我觉得不太明显
+        tabWidth: 2,
+        useTabs: false,
+        semi: true,
+        // 单引号
+        singleQuote: true,
+        trailingComma: 'all',
+        bracketSpacing: true,
+        arrowParens: 'avoid',
+        endOfLine: 'auto',
+    });
+}
+
+export { prettier };

package/mjs/src/package/readme.mjs

@@ -0,0 +1,54 @@
+import { writeFileSync } from 'node:fs';
+import data from '../data.mjs';
+
+/** 当前的时间  */
+const now = new Date();
+/** 月份  */
+const month = now.getMonth() + 1;
+/** 日期  */
+const day = now.getDate();
+/** 年份  */
+const year = now.getFullYear();
+/**
+ * 导出生成一些琐碎而又必须的文件
+ */
+function readme() {
+    /// readme.md
+    writeFileSync(data.fileName('README.md'), `# ${data.name}`);
+    /// 自述文件.md
+    writeFileSync(data.fileName('自述文件.md'), `# ${data.name}`);
+    /// changeLog.md
+    writeFileSync(data.fileName('CHANGELOG.md'), `# ${data.name}\n\n## 0.0.0 (${month} 月 ${day} ${year} 年)\n\n- 初始化项目`);
+    /// LICENSE
+    license();
+    /// 生成 .gitignore 文件
+    writeFileSync(data.fileName('.gitignore'), `node_modules/*
+
+*/node_modules
+
+## 打包文件
+
+list
+
+test/out
+
+.DS_Store`);
+}
+/** 导出生成 license 文件  */
+function license() {
+    writeFileSync(data.fileName('LICENSE'), `Copyright (c) <${year}> <${data.name}>
+    
+    Permission to use, copy, modify, and/or distribute this software for any  
+    purpose with or without fee is hereby granted, provided that the above  
+    copyright notice and this permission notice appear in all copies.
+    
+    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES  
+    WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF  
+    MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR  
+    ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES  
+    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN  
+    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF  
+    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.`);
+}
+
+export { license, readme };

package/mjs/src/package/rollup.mjs

@@ -0,0 +1,116 @@
+import { writeFileSync } from 'node:fs';
+import data from '../data.mjs';
+
+/**
+ *  生成 rollup 打包工具的配置文件信息
+ */
+function rollup() {
+    rollupJs();
+    rollupConfigTestJs();
+}
+/** 导出生成 rollup.config.js 文件  */
+function rollupJs() {
+    writeFileSync(data.fileName('rollup.config.js'), `import typescript from '@rollup/plugin-typescript';
+import resolve from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+import json from '@rollup/plugin-json';
+// import terser from '@rollup/plugin-terser';
+import cleanup from 'rollup-plugin-cleanup';
+import copy from 'rollup-plugin-copy';
+
+export default {
+  input: './index.ts',
+  output: [
+    {
+      format: 'es',
+      entryFileNames: '[name].mjs',
+      preserveModules: true,
+      sourcemap: false,
+      exports: 'named',
+      dir: 'dist/mjs',
+    },
+    //  若是生成 \`bin\` 类型，或是生成的文件不包含 commonJs，下面导出 commonJs 的配置可是删除
+    {
+      format: 'cjs',
+      entryFileNames: '[name].cjs',
+      preserveModules: true,
+      sourcemap: false,
+      exports: 'named',
+      dir: 'dist/cjs',
+    },
+  ],
+  // 配置需要排除的包
+  external: id =>
+    /^(node:)|^(tslib)|^(a-js-tools)|^(a-node-tools)|^(a-command)/.test(id),
+  plugins: [
+    resolve(),
+    commonjs(),
+    // 可打包 json 内容
+    json(),
+    typescript({
+      // compilerOptions: {},
+      // exclude: ["./node_modules", "./test"],
+    }),
+    // 打包压缩，自动去注释
+    // terser(),
+    // 去除无用代码
+    cleanup(),
+    copy({
+      targets: [
+        { src: 'package.json', dest: 'dist' },
+        { src: 'README.md', dest: 'dist' },
+        { src: 'LICENSE', dest: 'dist' },
+        // 若是生成 bin 类型的包，可以将下面的代码打开 
+        // { src: 'bin', dest: 'dist' },
+      ],
+    }),
+  ],
+};`);
+}
+/** 导出配置 rollup.config.test.js 文件 */
+function rollupConfigTestJs() {
+    writeFileSync(data.fileName('rollup.config.test.js'), `import typescript from '@rollup/plugin-typescript';
+import resolve from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+import json from '@rollup/plugin-json';
+import cleanup from 'rollup-plugin-cleanup';
+
+/** 配置需要不打包进生产包的包名配置  */
+const externalList = [
+  'nodejs',
+  'tslib',
+  'a-js-tools',
+  'a-node-tools',
+  'a-command',
+];
+
+export default {
+  input: 'test/index.ts',
+  output: [
+    {
+      format: 'es',
+      entryFileNames: '[name].mjs',
+      preserveModules: true,
+      sourcemap: false,
+      exports: 'named',
+      dir: 'test/out',
+    },
+  ],
+  // 配置需要排除的包
+  external: id => externalList.some(i => id.startsWith(i)),
+  plugins: [
+    resolve(),
+    commonjs(),
+    // 打包压缩，自动去注释
+    // terser(),
+    // 可打包 json 内容
+    json(),
+    typescript({}),
+    // 去除无用代码
+    cleanup(),
+  ],
+};
+`);
+}
+
+export { rollup, rollupConfigTestJs, rollupJs };

package/mjs/src/package/tsconfig.mjs

@@ -0,0 +1,48 @@
+import { writeToJsonFile } from '../tools.mjs';
+
+/** 将创建三个 tsconfig 文件的方法合并 */
+function tsconfigJson() {
+    tsconfigBaseJson();
+    _tsconfigJson();
+    tsconfigTypesJson();
+}
+/** 导出生成 tsconfig.base.json 文件  */
+function tsconfigBaseJson() {
+    writeToJsonFile('tsconfig.base.json', {
+        compilerOptions: {
+            baseUrl: '.',
+            jsx: 'preserve',
+            strict: true,
+            target: 'ESNext',
+            module: 'ESNext',
+            skipLibCheck: true,
+            esModuleInterop: true,
+            moduleResolution: 'Bundler',
+            allowSyntheticDefaultImports: true,
+            lib: ['ESNext', 'DOM'],
+            sourceMap: false,
+        },
+    });
+}
+/** 导出生成 tsconfig.json 配置文件 */
+function _tsconfigJson() {
+    writeToJsonFile('tsconfig.json', {
+        extends: './tsconfig.base.json',
+        include: ['index.ts', 'src/**/*.ts', '**.d.ts', 'test/**/*.ts'],
+        exclude: ['node_modules', 'dist'],
+    });
+}
+/** 导出生成的生产环境的 .d.ts 文件的 tsconfig 配置 */
+function tsconfigTypesJson() {
+    writeToJsonFile('tsconfig.types.json', {
+        extends: './tsconfig.base.json',
+        compilerOptions: {
+            emitDeclarationOnly: true,
+            declaration: true,
+            declarationDir: 'dist/types',
+        },
+        exclude: ['node_modules', 'test', 'dist'],
+    });
+}
+
+export { _tsconfigJson, tsconfigBaseJson, tsconfigJson, tsconfigTypesJson };

package/mjs/src/test/index.mjs

@@ -0,0 +1,20 @@
+import { pathJoin } from 'a-node-tools';
+import { mkdirSync, writeFileSync } from 'node:fs';
+import data from '../data.mjs';
+
+/**
+ *
+ * 添加 test 文件夹
+ *
+ * 及其下面的 index.ts 文件
+ */
+/** 创建 test 及相关的文件 */
+function testFile() {
+    const testCwd = pathJoin(data.cwd, 'test');
+    mkdirSync(testCwd);
+    writeFileSync(pathJoin(testCwd, 'index.ts'), `import { _p } from 'a-node-tools';
+// print 'hello world' on the terminal
+_p('hello world');`);
+}
+
+export { testFile };

package/mjs/src/tools.mjs

@@ -0,0 +1,14 @@
+import { writeJsonFile } from 'a-node-tools';
+import data from './data.mjs';
+
+/**
+ * 向文件写入 json 数据
+ *
+ * @param fileName  {@link string} 写入的文件名
+ * @param jsonData  写入的数据
+ */
+function writeToJsonFile(fileName, jsonData) {
+    writeJsonFile(data.fileName(fileName), jsonData);
+}
+
+export { writeToJsonFile };

package/package.json

@@ -1,62 +1,68 @@
-{
-  "name": "create-a-npm",
-  "type": "module",
-  "version": "0.0.0",
-  "author": "lmssee <lmssee@outlook.com>  (https://lmssee.com)",
-  "description": "a cli for create a node package module",
-  "scripts": {
-    "b": "rollup --config rollup.config.js && tsc -p tsconfig.types.json",
-    "build": "npx ixxx rm dist run b",
-    "clean": "npx ixxx up -d rm dist node_modules run npm install run b",
-    "diff": "npx ixxx  pkg diff",
-    "test": "echo 'welcome to see mi, yes , is mi'"
-  },
-  "files": [
-    "out",
-    "types"
-  ],
-  "keywords": [
-    "create-a-npm",
-    "create-a-node-package-module"
-  ],
-  "license": "ISC",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/lmssee/.git"
-  },
-  "homepage": "https://lmssee.github.io/ismi",
-  "bugs": {
-    "url": "https://github.com/lmssee/ismi/issues",
-    "email": "lmssee@outlook.com"
-  },
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
-  },
-  "dependencies": {
-    "ismi-command": "^0.0.13",
-    "ismi-js-tools": "^0.0.4",
-    "ismi-node-tools": "^0.0.14"
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.6.0",
-    "@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.10",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
-    "globals": "^15.8.0",
-    "prettier": "^3.3.2",
-    "rollup": "^4.18.1",
-    "rollup-plugin-cleanup": "^3.2.1",
-    "rollup-plugin-copy": "^3.5.0",
-    "typescript": "^5.5.3",
-    "typescript-eslint": "^7.16.0"
-  },
-  "bin": {
-    "create-a-npm": "bin/index.js"
-  }
-}
+{
+  "name": "create-a-npm",
+  "type": "module",
+  "version": "0.0.1",
+  "author": "lmssee <lmssee@outlook.com>  (https://lmssee.com)",
+  "description": "a cli for create a node package module（一个一键生成一个符合特定规则 <就是一个简单的代码模板库> 的 npm 包",
+  "scripts": {
+    "b": "rollup --config rollup.config.js && tsc -p tsconfig.types.json",
+    "build": "npx ixxx rm dist run b",
+    "clean": "npx ixxx up -d rm dist node_modules run npm install run b",
+    "diff": "npx ixxx  pkg diff",
+    "prettier": "npx prettier . --write",
+    "beautify": "npm run prettier",
+    "eslint": "npx eslint src",
+    "test": "npx ixxx rm test/out && rollup --config rollup.config.test.js && npx ixxx cls && node --trace-warnings  test/out/test/index.mjs cm -i",
+    "versionPatch": "npm version patch --force --no-git-tag-version --allow-same-version=true",
+    "up": "npm run versionPatch && npm run build && cd dist && npm publish && cd ../"
+  },
+  "files": [
+    "bin/",
+    "mjs/",
+    "types/"
+  ],
+  "keywords": [
+    "create-a-npm",
+    "create-a-node-package-module"
+  ],
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lmssee/createANpm.git"
+  },
+  "homepage": "https://lmssee.github.io/createANpm",
+  "bugs": {
+    "url": "https://github.com/lmssee/createANpm/issues",
+    "email": "lmssee@outlook.com"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.8.0",
+    "@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",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "globals": "^15.9.0",
+    "prettier": "^3.3.3",
+    "rollup": "^4.19.2",
+    "rollup-plugin-cleanup": "^3.2.1",
+    "rollup-plugin-copy": "^3.5.0",
+    "typescript": "^5.5.4",
+    "typescript-eslint": "^7.18.0"
+  },
+  "bin": {
+    "create-a-npm": "bin/index.js"
+  },
+  "dependencies": {
+    "a-command": "^0.0.4",
+    "a-js-tools": "^0.0.0",
+    "a-node-tools": "^0.0.4"
+  }
+}

package/types/src/askForName.d.ts

@@ -0,0 +1,4 @@
+/** Inquire about the current package name  \
+ * 查看是否当前有项目名
+ */
+export default function askForName(): Promise<void>;

package/types/src/command.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'a-command';
+declare const command: Command;
+export { command };

package/types/src/createNpm.d.ts

@@ -0,0 +1,4 @@
+/**
+ *
+ * 开始根据数据创建包  */
+export declare function createNpm(): Promise<void>;

package/types/src/custom.d.ts

@@ -0,0 +1,6 @@
+/*** 自定义插件的安装  */
+/**
+ *
+ * 自定义
+ */
+export default function (): Promise<void>;

package/types/src/data.d.ts

@@ -0,0 +1,25 @@
+/** 导出构建数据 */
+declare const _default: {
+    /** 工作目录 */
+    cwd: string;
+    /** 创建文件的路径 */
+    fileName(str: string): string;
+    /** 项目名称
+     *
+     * 该值在 askForName 中进行赋值
+     */
+    name: string;
+    /** 是否携带 npx 指令
+     *  该值将在 custom 过程中进行赋值 */
+    bin: boolean;
+    /** 包中需要的内容  */
+    package: {
+        /**包名称  */
+        name: string;
+        /** 依赖 */
+        dependencies: any;
+        /** 开发依赖 */
+        devDependencies: any;
+    };
+};
+export default _default;

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

@@ -0,0 +1,4 @@
+/**
+ * 导出生成 src 的主文件
+ */
+export declare function src(): void;

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

@@ -0,0 +1,2 @@
+/** 导出生成 index.ts 文件  */
+export declare function indexTs(): void;

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

@@ -0,0 +1,2 @@
+/**  */
+export declare function srcIndexTs(): void;

package/types/src/package/eslint.d.ts

@@ -0,0 +1,5 @@
+/**
+ * eslint 配置
+ *
+ */
+export declare function eslintConfig(): void;

package/types/src/package/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ *
+ * 导出 package 的主文件
+ */
+export declare function packageIndex(): void;

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

@@ -0,0 +1,2 @@
+/** 生成 package.json 文件内容  */
+export declare function packageJson(): void;

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

@@ -0,0 +1,4 @@
+/**
+ * 导出 prettier 的相关配置文件
+ */
+export declare function prettier(): void;

package/types/src/package/readme.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 导出生成一些琐碎而又必须的文件
+ */
+export declare function readme(): void;
+/** 导出生成 license 文件  */
+export declare function license(): void;

package/types/src/package/rollup.d.ts

@@ -0,0 +1,8 @@
+/**
+ *  生成 rollup 打包工具的配置文件信息
+ */
+export declare function rollup(): void;
+/** 导出生成 rollup.config.js 文件  */
+export declare function rollupJs(): void;
+/** 导出配置 rollup.config.test.js 文件 */
+export declare function rollupConfigTestJs(): void;

package/types/src/package/tsconfig.d.ts

@@ -0,0 +1,8 @@
+/** 将创建三个 tsconfig 文件的方法合并 */
+export declare function tsconfigJson(): void;
+/** 导出生成 tsconfig.base.json 文件  */
+export declare function tsconfigBaseJson(): void;
+/** 导出生成 tsconfig.json 配置文件 */
+export declare function _tsconfigJson(): void;
+/** 导出生成的生产环境的 .d.ts 文件的 tsconfig 配置 */
+export declare function tsconfigTypesJson(): void;

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

@@ -0,0 +1,8 @@
+/**
+ *
+ * 添加 test 文件夹
+ *
+ * 及其下面的 index.ts 文件
+ */
+/** 创建 test 及相关的文件 */
+export declare function testFile(): void;

package/types/src/tools.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 打印一些内容
+ *
+ * @param message  {@link  String} 将要打印的信息
+ */
+export declare function printSome(message: string): void;
+/**
+ * 向文件写入 json 数据
+ *
+ * @param fileName  {@link string} 写入的文件名
+ * @param jsonData  写入的数据
+ */
+export declare function writeToJsonFile(fileName: string, jsonData: unknown): void;