create-a-npm 0.0.3 → 1.0.0

package/mjs/src/askForName.mjs

@@ -1,90 +0,0 @@
-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

@@ -1,17 +0,0 @@
-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>  (自定义)': [] });
-// 执行，并在触发 -h、-v 时直接结束应用
-command.run().isEnd.end;
-
-export { command };

package/mjs/src/createNpm.mjs

@@ -1,38 +0,0 @@
-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';
-
-/****************************************************************************
- * @Author lmssee
- * @Email lmssee@outlook.com
- * @ProjectName crate-a-npm
- * @FileName createNpm.ts
- * @CreateDate  周五  08/30/2024
- * @Description 创建 npm 主要内容
- * 该操作出现在命名完成后
- ****************************************************************************/
-/**
- *
- * 开始根据数据创建包  */
-async function createNpm() {
-    /**
-     *
-     *  检测是否遗漏了询问包名
-     *
-     * 倘若并没有配置 name 属性值，则
-     * */
-    if (data.name == '') {
-        await askForName();
-        await custom();
-        await createNpm();
-        return;
-    }
-    packageIndex();
-    src();
-    testFile();
-}
-
-export { createNpm };

package/mjs/src/custom.mjs

@@ -1,40 +0,0 @@
-import './command.mjs';
-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() {
-    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;
-}
-
-export { custom as default };

package/mjs/src/data.mjs

@@ -1,65 +0,0 @@
-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  文件配置 */
-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

@@ -1,26 +0,0 @@
-import data from '../data.mjs';
-import { pathJoin } from 'a-node-tools';
-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() {
-    // 创建 src 文件夹
-    mkdirSync(pathJoin(data.cwd, 'src'));
-    /// index.ts
-    indexTs();
-    //
-    srcIndexTs();
-}
-
-export { src };

package/mjs/src/library/indexTs.mjs

@@ -1,23 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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/eslint.mjs

@@ -1,24 +0,0 @@
-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

@@ -1,21 +0,0 @@
-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

@@ -1,74 +0,0 @@
-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 的最新值带入
- *  这便是现在以函数的形式进行返回，能够在调用时直接获取 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',
-    scripts: {
-        b: 'rollup --config rollup.config.js && tsc -p tsconfig.types.json',
-        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: {
-        '.': {
-            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

@@ -1,53 +0,0 @@
-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
-
-**/node_modules
-
-## 打包文件
-
-dist
-
-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

@@ -1,54 +0,0 @@
-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
-
-## 打包文件
-
-dist
-
-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

@@ -1,116 +0,0 @@
-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 };