@varlet/cli 2.9.3-alpha.1679537809832 → 2.9.3

package/lib/node/bin.js

@@ -131,6 +131,13 @@ program
     const { commitLint } = await import('./commands/commitLint.js');
     return commitLint(option);
 });
+program
+    .command('checklist <gitParams>')
+    .description('Display a checklist for confirmation')
+    .action(async (option) => {
+    const { checklist } = await import('./commands/checklist.js');
+    return checklist(option);
+});
 program.on('command:*', async ([cmd]) => {
     const { default: logger } = await import('./shared/logger.js');
     program.outputHelp();

package/lib/node/commands/checklist.d.ts

@@ -0,0 +1,6 @@
+export interface CheckBlock {
+    type: string;
+    list: string[];
+}
+export declare function getCheckBlocks(html: string): CheckBlock[];
+export declare function checklist(gitParams: string): Promise<void>;

package/lib/node/commands/checklist.js

@@ -0,0 +1,61 @@
+import fse from 'fs-extra';
+import markdownIt from 'markdown-it';
+import logger from '../shared/logger.js';
+import { CHECKLIST_FILE } from '../shared/constant.js';
+import { COMMIT_MESSAGE_RE, isVersionCommitMessage, getCommitMessage } from './commitLint.js';
+const { readFileSync, existsSync } = fse;
+const blockRE = /<h3>(.|\n|\r)+?<\/ul>/g;
+const typeRE = /<h3>(.+)<\/h3>/;
+const childrenRE = /<ul>(.|\n|\r)+<\/ul>/;
+const childRE = /<li>(.|\n|\r)+?<\/li>/g;
+export function getCheckBlocks(html) {
+    var _a;
+    const blocks = (_a = html.match(blockRE)) !== null && _a !== void 0 ? _a : [];
+    const checkBlocks = [];
+    blocks.forEach((block) => {
+        var _a, _b;
+        const type = (_a = block.match(typeRE)) === null || _a === void 0 ? void 0 : _a[1];
+        const childrenBlock = (_b = block.match(childrenRE)) === null || _b === void 0 ? void 0 : _b[0];
+        if (!type || !childrenBlock) {
+            return;
+        }
+        const children = childrenBlock.match(childRE);
+        if (!children) {
+            return;
+        }
+        const list = children.map((child) => {
+            return child
+                .replaceAll('<li>', '')
+                .replaceAll('</li>', '')
+                .replaceAll('<p>', '')
+                .replaceAll('</p>', '')
+                .replaceAll('\n', '');
+        });
+        checkBlocks.push({
+            type,
+            list,
+        });
+    });
+    return checkBlocks;
+}
+export async function checklist(gitParams) {
+    var _a, _b, _c, _d, _e;
+    const commitMessage = getCommitMessage(gitParams);
+    if (isVersionCommitMessage(commitMessage) || !existsSync(CHECKLIST_FILE)) {
+        return;
+    }
+    const content = readFileSync(CHECKLIST_FILE, 'utf-8');
+    const html = markdownIt().render(content);
+    const checkBlocks = getCheckBlocks(html);
+    if (!checkBlocks.length) {
+        logger.warning('Cannot find anything need to checked');
+        return;
+    }
+    const type = (_a = commitMessage.match(COMMIT_MESSAGE_RE)) === null || _a === void 0 ? void 0 : _a[1];
+    const typeChildren = (_c = (_b = checkBlocks.find((checkBlock) => checkBlock.type === type)) === null || _b === void 0 ? void 0 : _b.list) !== null && _c !== void 0 ? _c : [];
+    const commonChildren = (_e = (_d = checkBlocks.find((checkBlock) => checkBlock.type === 'common')) === null || _d === void 0 ? void 0 : _d.list) !== null && _e !== void 0 ? _e : [];
+    const list = [...commonChildren, ...typeChildren];
+    logger.title('\nIt is recommended that you check the following information before pushing:\n');
+    logger.warning(`${list.map((item) => `🔔 ${item}`).join('\n')}\n`);
+    logger.title('If there are changes that need to be amended, please use git commit --amend to resolve.');
+}

package/lib/node/commands/commitLint.d.ts

@@ -1 +1,4 @@
+export declare const COMMIT_MESSAGE_RE: RegExp;
+export declare function isVersionCommitMessage(message: string): string | false | null;
+export declare function getCommitMessage(gitParams: string): string;
 export declare function commitLint(gitParams: string): void;

package/lib/node/commands/commitLint.js

@@ -2,13 +2,16 @@ import logger from '../shared/logger.js';
 import semver from 'semver';
 import fse from 'fs-extra';
 const { readFileSync } = fse;
-function isVersion(message) {
+export const COMMIT_MESSAGE_RE = /^(revert|fix|feat|docs|perf|test|types|style|build|chore|release|refactor)(\(.+\))?!?: (.|\n)+/;
+export function isVersionCommitMessage(message) {
     return message.startsWith('v') && semver.valid(message.slice(1));
 }
+export function getCommitMessage(gitParams) {
+    return readFileSync(gitParams, 'utf-8').trim();
+}
 export function commitLint(gitParams) {
-    const message = readFileSync(gitParams, 'utf-8').trim();
-    const COMMIT_MESSAGE_RE = /^(revert|fix|feat|docs|perf|test|types|style|build|chore|release|refactor)(\(.+\))?!?: (.|\n)+/;
-    if (!isVersion(message) && !COMMIT_MESSAGE_RE.test(message)) {
+    const commitMessage = getCommitMessage(gitParams);
+    if (!isVersionCommitMessage(commitMessage) && !COMMIT_MESSAGE_RE.test(commitMessage)) {
         logger.error(`Commit message invalid`);
         logger.warning(`\
 The rules for commit messages are as follows

package/lib/node/index.d.ts

@@ -12,3 +12,4 @@ export * from './commands/changelog.js';
 export * from './commands/preview.js';
 export * from './commands/vite.js';
 export * from './commands/extension.js';
+export * from './commands/checklist.js';

package/lib/node/index.js

@@ -12,3 +12,4 @@ export * from './commands/changelog.js';
 export * from './commands/preview.js';
 export * from './commands/vite.js';
 export * from './commands/extension.js';
+export * from './commands/checklist.js';

package/lib/node/shared/constant.d.ts

@@ -21,6 +21,7 @@ export declare const TESTS_DIR_NAME = "__tests__";
 export declare const GENERATORS_DIR: string;
 export declare const UI_PACKAGE_JSON: string;
 export declare const CLI_PACKAGE_JSON: string;
+export declare const CHECKLIST_FILE: string;
 export declare const SITE: string;
 export declare const SITE_OUTPUT_PATH: string;
 export declare const SITE_PUBLIC_PATH: string;

package/lib/node/shared/constant.js

@@ -23,6 +23,7 @@ export const TESTS_DIR_NAME = '__tests__';
 export const GENERATORS_DIR = resolve(dirname, '../../../template/generators');
 export const UI_PACKAGE_JSON = resolve(CWD, 'package.json');
 export const CLI_PACKAGE_JSON = resolve(dirname, '../../../package.json');
+export const CHECKLIST_FILE = resolve(CWD, 'CHECKLIST.md');
 // site
 export const SITE = resolve(dirname, '../../../site');
 export const SITE_OUTPUT_PATH = resolve(CWD, 'site');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@varlet/cli",
-  "version": "2.9.3-alpha.1679537809832",
+  "version": "2.9.3",
   "type": "module",
   "description": "cli of varlet",
   "bin": {
@@ -69,8 +69,9 @@
     "vue": "3.2.25",
     "vue-jest": "^5.0.0-alpha.8",
     "webfont": "^9.0.0",
-    "@varlet/shared": "2.9.3-alpha.1679537809832",
-    "@varlet/vite-plugins": "2.9.3-alpha.1679537809832"
+    "markdown-it": "^12.2.3",
+    "@varlet/shared": "2.9.3",
+    "@varlet/vite-plugins": "2.9.3"
   },
   "devDependencies": {
     "@types/babel__core": "^7.1.12",
@@ -83,8 +84,9 @@
     "@types/node": "^18.7.20",
     "@types/semver": "^7.3.9",
     "@types/sharp": "0.31.1",
-    "@varlet/icons": "2.9.3-alpha.1679537809832",
-    "@varlet/touch-emulator": "2.9.3-alpha.1679537809832"
+    "@types/markdown-it": "^12.2.3",
+    "@varlet/icons": "2.9.3",
+    "@varlet/touch-emulator": "2.9.3"
   },
   "peerDependencies": {
     "@vue/runtime-core": "3.2.16",
@@ -94,8 +96,8 @@
     "lodash-es": "^4.17.21",
     "vue": "3.2.25",
     "vue-router": "4.0.12",
-    "@varlet/icons": "2.9.3-alpha.1679537809832",
-    "@varlet/touch-emulator": "2.9.3-alpha.1679537809832"
+    "@varlet/icons": "2.9.3",
+    "@varlet/touch-emulator": "2.9.3"
   },
   "scripts": {
     "dev": "tsc --watch",