@deot/dev-cli 1.0.5 → 1.0.7

package/README.md

@@ -9,8 +9,60 @@
 - `link`
 - `test`
 - `add`
-- `release`: [与本仓库相同](./README.md#changelog)
+- `release`: [与本仓库相同](../../README.md)
 
 ## 其他
 
-暂时不支持全局引入，一些配置项，如`tsconfig.json`, `api-extractor.json`, `jest.config.cjs` 这些依赖项目本身
+暂时不支持全局引入，一些配置项，如`tsconfig.json`, `api-extractor.json`, `jest.config.cjs` 这些依赖项目本身
+
+
+## 默认的目录参考（配置后期再考虑）
+
+#### Monorepo
+
+```
+Monorepo
+├─ .husky
+├─ packages
+│    ├─ index
+│    │    ├─ __tests__
+│    │    ├─ src
+│    │    ├─ api-extractor.json
+│    │    └─ package.json
+│    ├─ shared
+│    │    ├─ __tests__
+│    │    ├─ src
+│    │    ├─ api-extractor.json
+│    │    └─ package.json
+│    └─ shims.d.ts
+├─ .eslintignore
+├─ .eslintrc.cjs
+├─ .lintstagedrc.json
+├─ .npmrc
+├─ jest.config.js
+├─ pnpm-lock.yaml
+├─ pnpm-workspace.yaml
+├─ tsconfig.json
+└─ package.json
+```
+
+#### Single Repo
+
+```
+Single Repo
+├─ .husky
+├─ __tests__
+├─ src
+├─ .eslintignore
+├─ .eslintrc.cjs
+├─ .npmrc
+├─ jest.config.js
+├─ shims.d.ts
+├─ api-extractor.json
+├─ pnpm-lock.yaml
+├─ pnpm-workspace.yaml
+├─ tsconfig.json
+├─ yarn.lock
+└─ package.json
+```
+

package/config/commit-lint.js

@@ -1,6 +1,7 @@
 import fs from 'fs';
 
-const commitRE = /^(revert: )?(fix|feat|docs|style|perf|test|types|build|chore|refactor|workflow|ci|wip|release|breaking change)(\(.+\))?: .{1,50}/;
+// eslint-disable-next-line max-len
+const commitRE = /^(revert: )?(void|fix|feat|docs|style|perf|test|types|build|chore|refactor|workflow|ci|wip|release|breaking change)(\(.+\))?: .{1,50}/;
 const mergeRE = /Merge branch /;
 
 const gitParams = process.env.HUSKY_GIT_PARAMS || process.argv.pop(); // 兼容husky@v4和husky@v8
@@ -30,6 +31,7 @@ if (!commitRE.test(commitMsg) && !mergeRE.test(commitMsg)) {
 		- build：影响构建系统或外部依赖项的更改
 		- ci: 持续集成相关
 		- breaking change：破坏性修改
+		- void：无类型，通常用于初始化
 		- Merge branch 'foo' into 'bar'
 		`
 	);

package/config/jest.config.js

@@ -1,5 +1,14 @@
 const options = JSON.parse(decodeURIComponent(process.env.TEST_OPTIONS || '{}'));
-const { packageFolderName } = options;
+const { workspace, packageFolderName } = options;
+const rootDir = process.cwd();
+
+const testDirPrefix = workspace 
+	? `<rootDir>/${workspace}/${packageFolderName || '*'}/__tests__` 
+	: `<rootDir>/__tests__`;
+
+const collectDirPrefix = workspace 
+	? `<rootDir>/${workspace}/${packageFolderName || '*'}/src`
+	: `<rootDir>/src`;
 
 export default {
 	preset: 'ts-jest',
@@ -22,19 +31,19 @@ export default {
 	// 匹配相关
 	moduleFileExtensions: ['ts', 'tsx', 'js', 'json'],
 	// 匹配规则很重要
-	rootDir: process.cwd(),
+	rootDir,
 	watchPathIgnorePatterns: ['/node_modules/', '/dist/', '/.git/'],
 	testPathIgnorePatterns: [
 		'/node_modules/'
 	],
 	testMatch: [
-		`<rootDir>/packages/${packageFolderName || '**'}/__tests__/**.(spec|test).[jt]s?(x)`
+		`${testDirPrefix}/**.(spec|test).[jt]s?(x)`
 	],
 
 	collectCoverage: true,
 	coverageDirectory: 'coverage',
 	collectCoverageFrom: [
-		`packages/${packageFolderName || '*'}/src/**/*.ts`
+		`${collectDirPrefix}/**/*.ts`
 	],
 	coverageThreshold: {
 		global: {

package/dist/index.js

@@ -2,7 +2,7 @@ import { program } from 'commander';
 import { createRequire } from 'node:module';
 import chalk from 'chalk';
 import ora from 'ora';
-import { Utils, Shell, Logger } from '@deot/dev-shared';
+import { Utils, Logger, Shell } from '@deot/dev-shared';
 import * as path from 'node:path';
 import { resolve } from 'node:path';
 import fs from 'fs-extra';
@@ -61,16 +61,20 @@ class Shared {
         return result.reverse();
     };
     static getPackageName = (packageFolderName$) => {
-        const { packageFolderName, packageName } = Shared.impl();
-        if (!packageFolderName$ || packageFolderName$ === packageFolderName) {
-            return `${packageName}`;
+        const { workspace, packageFolderName, packageName } = Shared.impl();
+        if (!workspace
+            || !packageFolderName$
+            || packageFolderName$ === packageFolderName) {
+            return packageName;
         }
         else {
             return `${packageName}-${packageFolderName$.replace(new RegExp(`${packageName}-?`), '')}`;
         }
     };
     static getPackageFolderName = (packageName$) => {
-        const { packageFolderName, packageName } = Shared.impl();
+        const { workspace, packageFolderName, packageName } = Shared.impl();
+        if (!workspace)
+            return '';
         if (packageName$ === packageName)
             return packageFolderName;
         return packageName$?.replace(new RegExp(`${packageName}-?`), '');
@@ -79,12 +83,15 @@ class Shared {
         if (Shared.config)
             return Shared.config;
         const rootPackageOptions = require$$2(`${cwd}/package.json`);
-        const packageFolderName = 'index';
-        const packageDir = path.resolve(cwd, './packages');
-        const packageOptions = require$$2(`${cwd}/packages/${packageFolderName}/package.json`);
+        let workspace = 'packages';
+        let isMonorepo = fs.existsSync(path.resolve(cwd, workspace));
+        workspace = isMonorepo ? workspace : '';
+        const packageFolderName = isMonorepo ? 'index' : '';
+        const packageDir = path.resolve(cwd, workspace);
+        const packageOptions = require$$2(path.resolve(packageDir, packageFolderName, 'package.json'));
         const packageName = packageOptions.name;
         const packageVersion = packageOptions.version;
-        const packageFolderNames = fs
+        const packageFolderNames = !isMonorepo ? [] : fs
             .readdirSync(packageDir)
             .reduce((pre, file) => {
             const fullpath = path.resolve(packageDir, file);
@@ -95,12 +102,12 @@ class Shared {
             }
             return pre;
         }, []);
-        const packageOptionsMap = packageFolderNames.reduce((pre, packageFolderDir) => {
-            pre[packageFolderDir] = require$$2(`${cwd}/packages/${packageFolderDir}/package.json`);
+        const packageOptionsMap = packageFolderNames.reduce((pre, packageFolderName$) => {
+            pre[packageFolderName$] = require$$2(path.resolve(packageDir, packageFolderName$, 'package.json'));
             return pre;
         }, {});
-        const packageRelation = packageFolderNames.reduce((pre, packageFolderDir) => {
-            let packagesOptions = packageOptionsMap[packageFolderDir];
+        const packageRelation = packageFolderNames.reduce((pre, packageFolderName$) => {
+            let packagesOptions = packageOptionsMap[packageFolderName$];
             let deps = {
                 ...(packagesOptions.dependencies || {}),
                 ...(packagesOptions.devDependencies || {}),
@@ -111,8 +118,10 @@ class Shared {
         const normalizePackageNames = Shared.getNormalizePackage(packageRelation);
         const normalizePackageFolderNames = normalizePackageNames
             .map(i => i.replace(new RegExp(`${packageName}-?`), '') || packageFolderName);
+        const homepage = (rootPackageOptions.repository || packageOptions.repository || {}).url || '';
         const config = {
-            homepage: (rootPackageOptions.homepage || packageOptions.homepage).replace(/(#.+)/, ''),
+            workspace,
+            homepage: homepage.replace(/(.*)(https?:\/\/.*)(#|\.git)/, '$2'),
             packageFolderName,
             packageDir,
             packageOptions,
@@ -130,13 +139,17 @@ class Shared {
 }
 
 const run$5 = (options) => Utils.autoCatch(async () => {
+    const locals = Shared.impl();
+    const { workspace, packageFolderNames } = locals;
+    if (!workspace) {
+        return Logger.log(`<link> Monorepo Supported Only.`);
+    }
     if (typeof options.dryRun === 'undefined') {
         options.dryRun = process.env.NODE_ENV === 'UNIT';
     }
-    const command = 'npx pnpm link ./packages/';
+    const command = `npx pnpm link ./${workspace}/`;
     if (options.dryRun)
         return Shell.spawn(`echo ${command}`);
-    const { packageFolderNames } = Shared.impl();
     const spinner = ora(`Links ...\n`);
     spinner.start();
     await Promise.all(packageFolderNames.map(i => {
@@ -231,14 +244,18 @@ const getOptions$1 = async () => {
 };
 
 const run$4 = (options) => Utils.autoCatch(async () => {
+    const locals = Shared.impl();
+    const { workspace, packageDir } = locals;
+    if (!workspace) {
+        return Logger.log(`<add> Monorepo Supported Only.`);
+    }
     if (typeof options.dryRun === 'undefined') {
         options.dryRun = process.env.NODE_ENV === 'UNIT';
     }
     const { mode, dependentName, args, packageFolderName, packageName } = await getOptions$1();
-    const { packageDir } = Shared.impl();
     let command = mode === 'dependent'
         ? `npx pnpm add --filter ${packageName} ${dependentName} ${args.join(' ')}`
-        : `npx pnpm link ./packages/${packageFolderName}`;
+        : `npx pnpm link ./${workspace}/${packageFolderName}`;
     if (options.dryRun)
         return Shell.spawn(`echo "${command}"`);
     const spinner = ora(`${command}\n`).start();
@@ -266,7 +283,7 @@ const run$4 = (options) => Utils.autoCatch(async () => {
         }, null, 2));
         fs.outputFileSync(`${dir}/${packageFolderName}/api-extractor.json`, JSON.stringify({
             extends: "../../api-extractor.json",
-            mainEntryPointFilePath: `./dist/packages/${packageFolderName}/src/index.d.ts`,
+            mainEntryPointFilePath: `./dist/${workspace}/${packageFolderName}/src/index.d.ts`,
             dtsRollup: {
                 publicTrimmedFilePath: "./dist/index.d.ts"
             }
@@ -317,10 +334,11 @@ const getOptions = async () => {
 };
 
 const run$3 = (options) => Utils.autoCatch(async () => {
+    const locals = Shared.impl();
     if (typeof options.dryRun === 'undefined') {
         options.dryRun = process.env.NODE_ENV === 'UNIT';
     }
-    if (!options.packageName) {
+    if (locals.workspace && !options.packageName) {
         const promptOptions = await getOptions();
         options = {
             ...options,
@@ -329,8 +347,11 @@ const run$3 = (options) => Utils.autoCatch(async () => {
     }
     const { packageName, watch, dryRun } = options;
     options.packageFolderName = Shared.getPackageFolderName(options.packageName) || options.packageFolderName;
+    options.workspace = locals.workspace;
     if (!options.packageFolderName)
         delete options.packageFolderName;
+    if (!options.workspace)
+        delete options.workspace;
     delete options.packageName;
     const command = `cross-env NODE_ENV=${process.env.NODE_ENV || 'TEST'} TEST_OPTIONS=${encodeURIComponent(JSON.stringify(options))} jest `
         + ([
@@ -362,6 +383,7 @@ const run$2 = (options) => Utils.autoCatch(async () => {
     if (options.dryRun)
         return Shell.spawn(`echo development`);
     process.env.NODE_ENV = process.env.NODE_ENV || 'development';
+    options.watch = true;
     await run$3(options);
 });
 
@@ -372,13 +394,13 @@ class Builder {
     packageOptions;
     config;
     constructor(config) {
-        const { packageDir, packageName } = Shared.impl();
+        const { workspace, packageDir, packageName } = Shared.impl();
         if (typeof config === 'string') {
             let packageFolderName = config;
             let packageDir$ = path.resolve(packageDir, packageFolderName);
             config = {
                 dir: packageDir$,
-                name: packageFolderName,
+                name: packageFolderName || 'index',
                 input: packageDir$ + '/src/index.ts',
                 output: {
                     file: packageDir$ + '/dist/index.js',
@@ -388,8 +410,10 @@ class Builder {
                 }
             };
         }
-        this.packageDir = path.resolve(packageDir, `./${config.name}`);
-        this.packageName = config.name === 'index' ? packageName : `${packageName}-${config.name}`;
+        this.packageDir = path.resolve(packageDir, workspace ? `./${config.name}` : '');
+        this.packageName = config.name === 'index'
+            ? packageName
+            : `${packageName}-${config.name}`;
         this.packageOptions = require$$1(`${this.packageDir}/package.json`);
         this.config = config;
     }
@@ -410,6 +434,7 @@ class Builder {
         }
     }
     async buildSourceAsES() {
+        const { workspace } = Shared.impl();
         const { name, input, output } = this.config;
         const { packageOptions } = this;
         const external = Object
@@ -418,6 +443,9 @@ class Builder {
             ...packageOptions.peerDependencies
         })
             .map(i => new RegExp(`^${i}$`));
+        const source = workspace ? `${workspace}/${name}/**/*` : 'src/**/*';
+        const shims = workspace ? `${workspace}/shims.d.ts` : 'shims.d.ts';
+        const outDir = workspace ? `${workspace}/${name}/dist` : 'dist';
         const builder = await rollup({
             input,
             external: [
@@ -427,18 +455,18 @@ class Builder {
             ],
             plugins: [
                 typescript({
-                    include: [`packages/${name}/**/*`, 'packages/shims.d.ts'],
+                    include: [source, shims],
                     exclude: ['dist'],
                     compilerOptions: {
                         rootDir: '.',
-                        outDir: `packages/${name}/dist`,
+                        outDir,
                         declaration: true
                     }
                 }),
                 commonjs({ extensions: ['.js', '.ts'] }),
                 nodeResolve(),
                 replace({
-                    '1.0.4': `'${packageOptions.version}'`,
+                    '1.0.6': `'${packageOptions.version}'`,
                     false: 'false',
                     true: true
                 })
@@ -449,17 +477,20 @@ class Builder {
         return stat;
     }
     async buildTypes() {
+        const { workspace } = Shared.impl();
         const { packageDir } = this;
         const config = path.resolve(packageDir, `api-extractor.json`);
-        const result = Extractor.invoke(ExtractorConfig.loadFileAndPrepare(config), {
-            localBuild: true,
-            showVerboseMessages: false
-        });
-        if (!result.succeeded) {
-            Logger.error(`API Extractor completed with ${result.errorCount} errors and ${result.warningCount} warnings`);
-            process.exitCode = 1;
+        if (fs.existsSync(config)) {
+            const result = Extractor.invoke(ExtractorConfig.loadFileAndPrepare(config), {
+                localBuild: true,
+                showVerboseMessages: false
+            });
+            if (!result.succeeded) {
+                Logger.error(`API Extractor completed with ${result.errorCount} errors and ${result.warningCount} warnings`);
+                process.exitCode = 1;
+            }
         }
-        await fs.remove(`${packageDir}/dist/packages`);
+        await fs.remove(`${packageDir}/dist/${workspace || 'src'}`);
     }
 }
 const builder = (options) => {
@@ -467,13 +498,14 @@ const builder = (options) => {
 };
 
 const run$1 = (options) => Utils.autoCatch(async () => {
+    const locals = Shared.impl();
     if (typeof options.dryRun === 'undefined') {
         options.dryRun = process.env.NODE_ENV === 'UNIT';
     }
     const { normalizePackageFolderNames } = Shared.impl();
     let packageFolderName = Shared.getPackageFolderName(options.packageName || '**');
     let inputs = [];
-    if (packageFolderName === '**') {
+    if (locals.workspace && packageFolderName === '**') {
         inputs = normalizePackageFolderNames;
     }
     else {
@@ -531,7 +563,7 @@ class Releaser {
         this.packageName = Shared.getPackageName(config.name);
         this.packageFolderName = config.name;
         this.packageOptions = require$(`${this.packageDir}/package.json`);
-        this.packageRelation = packageRelation[this.packageName];
+        this.packageRelation = packageRelation[this.packageName] || [];
         this.config = config;
         this.commits = [];
         this.changeLog = '';
@@ -539,13 +571,13 @@ class Releaser {
         this.commandOptions = commandOptions;
     }
     async parseCommits() {
+        const { workspace } = Shared.impl();
         const { packageFolderName, packageName, commandOptions } = this;
         let params = ['tag', '--list', `'${packageName}@*'`, '--sort', '-v:refname'];
         const { stdout: tags } = await Shell.exec('git', params);
         const [latestTag] = tags.split('\n');
         Logger.log(chalk.yellow(`Last Release Tag`) + `: ${latestTag || '<none>'}`);
         params = ['--no-pager', 'log', `${latestTag}..HEAD`, `--format=%B%n${HASH}%n%H${SUFFIX}`];
-        const rePlugin = new RegExp(`^[\\w\\!]+\\(([\\w,-]+)?${packageFolderName}([\\w,-]+)?\\)`, 'i');
         let { stdout } = await Shell.exec('git', params);
         let skipGetLog = false;
         if (latestTag) {
@@ -564,8 +596,10 @@ class Releaser {
             }
             ({ stdout } = await Shell.exec('git', params));
         }
-        const commits = stdout
-            .split(SUFFIX)
+        const allowTypes = ['feat', `fix`, `break change`, `style`, `perf`, `types`, `refactor`, `chore`];
+        const rePlugin = new RegExp(`^(${allowTypes.join('|')})${workspace ? `\\(${packageFolderName}\\)` : '(\\(.+\\))?'}: .*`, 'i');
+        const allCommits = stdout.split(SUFFIX);
+        const commits = allCommits
             .filter((commit) => {
             const chunk = commit.trim();
             return chunk && rePlugin.test(chunk);
@@ -586,7 +620,11 @@ class Releaser {
             Logger.log(chalk.red(`No Commits Found.`));
         }
         else {
-            Logger.log(chalk.yellow(`Found `) + chalk.bold(`${commits.length}`) + ` Commits`);
+            Logger.log(chalk.yellow(`Found `)
+                + chalk.bold(`${allCommits.length}`)
+                + ` Commits, `
+                + chalk.bold(`${commits.length}`)
+                + ' Commits Valid');
         }
         const { skipUpdatePackage } = commandOptions;
         if (commits.length && skipUpdatePackage) {
@@ -639,7 +677,7 @@ class Releaser {
                 this.commits = [
                     {
                         type: 'chore',
-                        header: `chore(${this.packageFolderName}): force-publish ${versionChanged}`,
+                        header: `chore(${this.packageFolderName || 'release'}): force-publish ${versionChanged}`,
                         hash: '',
                         effect: false,
                         breaking: false,
@@ -652,7 +690,7 @@ class Releaser {
     }
     rebuildChangeLog(commits) {
         const { packageDir } = this;
-        const { homepage } = Shared.impl();
+        const { homepage, workspace } = Shared.impl();
         const logPath = path.resolve(packageDir, './CHANGELOG.md');
         const logFile = fs.existsSync(logPath) ? fs.readFileSync(logPath, 'utf-8') : '';
         const notes = {
@@ -669,7 +707,7 @@ class Releaser {
                 ? ''
                 : ` ([${hash?.substring(0, 7)}](${homepage}/commit/${hash}))`;
             let message = header?.trim();
-            if (!effect) {
+            if (workspace && !effect) {
                 message = message.replace(/\(.+\)!?:/, ':');
             }
             message = message
@@ -898,11 +936,12 @@ class Releaser {
         });
     }
     async process() {
+        const { workspace } = Shared.impl();
         const { packageName, packageDir, packageFolderName } = this;
         if (!packageDir || !fs.pathExists(packageDir)) {
             throw new RangeError(`Could not find directory for package: ${packageFolderName}`);
         }
-        Logger.log(chalk.cyan(`Releasing ${packageName}`) + ' from ' + chalk.grey(`packages/${packageFolderName}`));
+        Logger.log(chalk.cyan(`Releasing ${packageName}`) + ' from ' + chalk.grey(`${workspace}/${packageFolderName}`));
         await this.parseCommits();
         return this;
     }
@@ -912,13 +951,20 @@ const releaser = (options, commandOptions) => {
 };
 
 const run = (options) => Utils.autoCatch(async () => {
+    const locals = Shared.impl();
     if (options.dryRun) {
         Logger.log(chalk.magenta(`DRY RUN: `)
             + 'No files will be modified.');
     }
-    const { normalizePackageFolderNames } = Shared.impl();
+    let inputs = [];
+    if (locals.workspace) {
+        inputs = locals.normalizePackageFolderNames;
+    }
+    else {
+        inputs = [''];
+    }
     const instances = {};
-    await normalizePackageFolderNames
+    await inputs
         .reduce((preProcess, packageFolderName) => {
         preProcess = preProcess
             .then(() => releaser(packageFolderName, options).process())
@@ -930,7 +976,7 @@ const run = (options) => Utils.autoCatch(async () => {
     Logger.log(chalk.blue(`---------------------\n`));
     let message = `chore(release): publish\n\n`;
     let relationVerisons = {};
-    await normalizePackageFolderNames.reduce((preProcess, packageFolderName) => {
+    await inputs.reduce((preProcess, packageFolderName) => {
         const instance = instances[packageFolderName];
         instance.packageRelation.forEach(i => {
             let packageFolderName$ = Shared.getPackageFolderName(i);
@@ -968,7 +1014,7 @@ const run = (options) => Utils.autoCatch(async () => {
         await Shell.spawn('git', ['add', process.cwd()]);
         await Shell.spawn('git', ['commit', '--m', `'${message}'`]);
     }
-    await normalizePackageFolderNames
+    await inputs
         .reduce((preProcess, packageFolderName) => {
         const instance = instances[packageFolderName];
         preProcess = preProcess
@@ -1024,6 +1070,7 @@ program
     .command('dev')
     .alias('d')
     .description('dev')
+    .option('-p, --package-name <string>', 'Select PackageName')
     .option('--dry-run [boolean]', 'Dry Run')
     .action(run$2);
 program

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deot/dev-cli",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",