@linter-spec/cli 1.0.0

package/dist/utils/messages.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Centralised user-facing strings (Chinese), parameterised by the CLI name so
+ * renames stay in one place.
+ */
+export declare const messages: {
+    readonly description: "linter-spec 是配套 linter-spec 前端编码规范的 Lint 工具，提供简单的 CLI 和 Node.js API，让项目一键接入、一键扫描、一键修复、一键升级，并配置 git commit 卡点。";
+    readonly initDescription: "一键接入：为项目初始化规范工具和配置，可根据项目类型和需求定制";
+    readonly scanDescription: "一键扫描：对项目进行代码规范问题扫描";
+    readonly fixDescription: "一键修复：自动修复项目的代码规范扫描问题";
+    readonly updateDescription: `\u66F4\u65B0 ${string} \u81F3\u6700\u65B0\u7248\u672C`;
+    readonly commitMsgScanDescription: "commit message 检查：git commit 时对 commit message 进行检查";
+    readonly commitFileScanDescription: "代码提交检查：git commit 时对提交代码进行规范问题扫描";
+    readonly optVscode: "写入 .vscode/settings.json 配置";
+    readonly optQuiet: "仅报告错误信息 - 默认: false";
+    readonly optOutputReport: "输出扫描出的规范问题日志";
+    readonly optInclude: "指定要进行规范扫描的目录";
+    readonly optNoIgnore: "忽略 eslint 的 ignore 配置文件和 ignore 规则";
+    readonly optStrict: "严格模式，对 warn 和 error 问题都卡口，默认仅对 error 问题卡口";
+    readonly runChecking: "执行 linter-spec 代码检查";
+    readonly runFixing: "执行 linter-spec 代码修复";
+    readonly runCommitChecking: "执行 linter-spec 代码提交检查";
+    readonly installingDeps: (npm: string) => string;
+    readonly notStaged: (files: string) => string;
+    readonly stepChooseType: (step: number) => string;
+    readonly stepEnableStylelint: (step: number) => string;
+    readonly stepEnableMarkdownlint: (step: number) => string;
+    readonly stepEnablePrettier: (step: number) => string;
+    readonly stepConflict: (step: number) => string;
+    readonly stepConflictDone: (step: number) => string;
+    readonly stepInstall: (step: number) => string;
+    readonly stepInstallDone: (step: number) => string;
+    readonly stepHusky: (step: number) => string;
+    readonly stepHuskyDone: (step: number) => string;
+    readonly stepWrite: (step: number) => string;
+    readonly stepWriteDone: (step: number) => string;
+    readonly initDone: "linter-spec 初始化完成 :D";
+    readonly conflictDetected: "检测到项目中存在可能与 linter-spec 冲突的依赖和配置，为保证正常运行将";
+    readonly conflictRemoveDeps: "删除以下依赖：";
+    readonly conflictRemoveConfig: "删除以下配置文件：";
+    readonly conflictRewriteConfig: "覆盖以下配置文件：";
+    readonly conflictConfirm: "请确认是否继续：";
+    readonly conflictCancelled: "已取消，未修改任何文件。";
+    readonly updateChecking: `[${string}] \u6B63\u5728\u68C0\u67E5\u6700\u65B0\u7248\u672C...`;
+    readonly updateFound: (v: string) => string;
+    readonly updateHint: (latest: string, current: string, command: string) => string;
+    readonly updateNone: "当前没有可用的更新";
+};

package/dist/utils/messages.js

@@ -0,0 +1,54 @@
+import { CLI_NAME, PKG_NAME } from './constants.js';
+/**
+ * Centralised user-facing strings (Chinese), parameterised by the CLI name so
+ * renames stay in one place.
+ */
+export const messages = {
+    description: `${CLI_NAME} 是配套 linter-spec 前端编码规范的 Lint 工具，提供简单的 CLI 和 Node.js API，让项目一键接入、一键扫描、一键修复、一键升级，并配置 git commit 卡点。`,
+    // command descriptions
+    initDescription: '一键接入：为项目初始化规范工具和配置，可根据项目类型和需求定制',
+    scanDescription: '一键扫描：对项目进行代码规范问题扫描',
+    fixDescription: '一键修复：自动修复项目的代码规范扫描问题',
+    updateDescription: `更新 ${PKG_NAME} 至最新版本`,
+    commitMsgScanDescription: 'commit message 检查：git commit 时对 commit message 进行检查',
+    commitFileScanDescription: '代码提交检查：git commit 时对提交代码进行规范问题扫描',
+    // option descriptions
+    optVscode: '写入 .vscode/settings.json 配置',
+    optQuiet: '仅报告错误信息 - 默认: false',
+    optOutputReport: '输出扫描出的规范问题日志',
+    optInclude: '指定要进行规范扫描的目录',
+    optNoIgnore: '忽略 eslint 的 ignore 配置文件和 ignore 规则',
+    optStrict: '严格模式，对 warn 和 error 问题都卡口，默认仅对 error 问题卡口',
+    // runtime
+    runChecking: `执行 ${CLI_NAME} 代码检查`,
+    runFixing: `执行 ${CLI_NAME} 代码修复`,
+    runCommitChecking: `执行 ${CLI_NAME} 代码提交检查`,
+    installingDeps: (npm) => `使用项目 Lint 配置，检测到项目未安装依赖，将进行安装（执行 ${npm} install）`,
+    notStaged: (files) => `[${CLI_NAME}] changes not staged for commit: \n${files}\n`,
+    // init steps
+    stepChooseType: (step) => `Step ${step}. 请选择项目的语言（JS/TS）和框架（React/Vue）类型：`,
+    stepEnableStylelint: (step) => `Step ${step}. 是否需要使用 stylelint（若没有样式文件则不需要）：`,
+    stepEnableMarkdownlint: (step) => `Step ${step}. 是否需要使用 markdownlint（若没有 Markdown 文件则不需要）：`,
+    stepEnablePrettier: (step) => `Step ${step}. 是否需要使用 Prettier 格式化代码：`,
+    stepConflict: (step) => `Step ${step}. 检查并处理项目中可能存在的依赖和配置冲突`,
+    stepConflictDone: (step) => `Step ${step}. 已完成项目依赖和配置冲突检查处理 :D`,
+    stepInstall: (step) => `Step ${step}. 安装依赖`,
+    stepInstallDone: (step) => `Step ${step}. 安装依赖成功 :D`,
+    stepHusky: (step) => `Step ${step}. 配置 git commit 卡点`,
+    stepHuskyDone: (step) => `Step ${step}. 配置 git commit 卡点成功 :D`,
+    stepWrite: (step) => `Step ${step}. 写入配置文件`,
+    stepWriteDone: (step) => `Step ${step}. 写入配置文件成功 :D`,
+    initDone: `${CLI_NAME} 初始化完成 :D`,
+    // conflict resolve
+    conflictDetected: `检测到项目中存在可能与 ${CLI_NAME} 冲突的依赖和配置，为保证正常运行将`,
+    conflictRemoveDeps: '删除以下依赖：',
+    conflictRemoveConfig: '删除以下配置文件：',
+    conflictRewriteConfig: '覆盖以下配置文件：',
+    conflictConfirm: '请确认是否继续：',
+    conflictCancelled: '已取消，未修改任何文件。',
+    // update
+    updateChecking: `[${PKG_NAME}] 正在检查最新版本...`,
+    updateFound: (v) => `[${PKG_NAME}] 存在新版本，将升级至 ${v}`,
+    updateHint: (latest, current, command) => `最新版本为 ${latest}，本地版本为 ${current}，请尽快升级到最新版本。\n你可以执行 ${command} 来安装此版本\n`,
+    updateNone: '当前没有可用的更新',
+};

package/dist/utils/npm.d.ts

@@ -0,0 +1,20 @@
+export type PackageManager = 'npm' | 'pnpm' | 'yarn' | 'bun' | 'cnpm';
+/**
+ * Detect the package manager a project uses, by decreasing reliability:
+ *
+ * 1. `npm_config_user_agent` — the PM that actually invoked this process
+ *    (npm/pnpm/yarn/bun/cnpm all set it; first segment is `<tool>/<version>`).
+ * 2. `package.json` `"packageManager"` (Corepack) — the project's declared PM.
+ * 3. A lockfile present in `cwd`.
+ * 4. `npm` as the final fallback.
+ *
+ * Replaces the old `command-exists`-based guess, which only checked whether
+ * `pnpm` happened to be on PATH and so polluted lockfiles in yarn/bun projects.
+ */
+export declare function detectPackageManager(cwd?: string): PackageManager;
+/** `[command, args]` to add a dev dependency, per package manager. */
+export declare function addDevCommand(pm: PackageManager, pkg: string): [string, string[]];
+/** `[command, args]` to add a global package, per package manager. */
+export declare function addGlobalCommand(pm: PackageManager, pkg: string): [string, string[]];
+/** `[command, args]` to install all dependencies — `<pm> install` works for all. */
+export declare function installAllCommand(pm: PackageManager): [string, string[]];

package/dist/utils/npm.js

@@ -0,0 +1,76 @@
+import fs from 'node:fs';
+import path from 'node:path';
+const KNOWN = ['npm', 'pnpm', 'yarn', 'bun', 'cnpm'];
+/**
+ * Detect the package manager a project uses, by decreasing reliability:
+ *
+ * 1. `npm_config_user_agent` — the PM that actually invoked this process
+ *    (npm/pnpm/yarn/bun/cnpm all set it; first segment is `<tool>/<version>`).
+ * 2. `package.json` `"packageManager"` (Corepack) — the project's declared PM.
+ * 3. A lockfile present in `cwd`.
+ * 4. `npm` as the final fallback.
+ *
+ * Replaces the old `command-exists`-based guess, which only checked whether
+ * `pnpm` happened to be on PATH and so polluted lockfiles in yarn/bun projects.
+ */
+export function detectPackageManager(cwd = process.cwd()) {
+    // 1. The PM that launched us.
+    const ua = process.env.npm_config_user_agent;
+    if (ua) {
+        const name = ua.split('/')[0];
+        if (KNOWN.includes(name))
+            return name;
+    }
+    // 2. The project's declared PM.
+    try {
+        const pkg = JSON.parse(fs.readFileSync(path.join(cwd, 'package.json'), 'utf8'));
+        if (typeof pkg.packageManager === 'string') {
+            const name = pkg.packageManager.split('@')[0];
+            if (KNOWN.includes(name))
+                return name;
+        }
+    }
+    catch {
+        /* no / unreadable package.json */
+    }
+    // 3. Lockfile in cwd.
+    if (fs.existsSync(path.join(cwd, 'pnpm-lock.yaml')))
+        return 'pnpm';
+    if (fs.existsSync(path.join(cwd, 'yarn.lock')))
+        return 'yarn';
+    if (fs.existsSync(path.join(cwd, 'bun.lockb')) || fs.existsSync(path.join(cwd, 'bun.lock'))) {
+        return 'bun';
+    }
+    if (fs.existsSync(path.join(cwd, 'package-lock.json')))
+        return 'npm';
+    if (fs.existsSync(path.join(cwd, 'npm-shrinkwrap.json')))
+        return 'npm';
+    // 4. Fallback.
+    return 'npm';
+}
+/** `[command, args]` to add a dev dependency, per package manager. */
+export function addDevCommand(pm, pkg) {
+    switch (pm) {
+        case 'yarn':
+            return ['yarn', ['add', '-D', pkg]];
+        case 'bun':
+            return ['bun', ['add', '-d', pkg]];
+        default: // npm / pnpm / cnpm
+            return [pm, ['i', '-D', pkg]];
+    }
+}
+/** `[command, args]` to add a global package, per package manager. */
+export function addGlobalCommand(pm, pkg) {
+    switch (pm) {
+        case 'yarn':
+            return ['yarn', ['global', 'add', pkg]];
+        case 'bun':
+            return ['bun', ['add', '-g', pkg]];
+        default: // npm / pnpm / cnpm
+            return [pm, ['i', '-g', pkg]];
+    }
+}
+/** `[command, args]` to install all dependencies — `<pm> install` works for all. */
+export function installAllCommand(pm) {
+    return [pm, ['install']];
+}

package/dist/utils/print-report.d.ts

@@ -0,0 +1,5 @@
+import type { ScanResult } from '../types.js';
+/**
+ * Print the scan report to the console.
+ */
+export default function printReport(results: ScanResult[], fix: boolean): void;

package/dist/utils/print-report.js

@@ -0,0 +1,63 @@
+import chalk from 'chalk';
+import table from 'text-table';
+import terminalLink from 'terminal-link';
+import isDocker from 'is-docker';
+import stripAnsi from 'strip-ansi';
+import { CLI_NAME, UNICODE } from './constants.js';
+/**
+ * Print the scan report to the console.
+ */
+export default function printReport(results, fix) {
+    let output = '\n';
+    let errorCount = 0;
+    let warningCount = 0;
+    let fixableErrorCount = 0;
+    let fixableWarningCount = 0;
+    let summaryColor = 'yellow';
+    const transformMessage = ({ line, column, rule, url, message, errored }) => {
+        if (errored)
+            summaryColor = 'red';
+        let text = '';
+        if (rule && url) {
+            text = terminalLink(chalk.blue(rule), chalk.dim(` ${url} `), { fallback: !isDocker() });
+        }
+        else if (rule) {
+            text = chalk.blue(rule);
+        }
+        return [
+            '',
+            chalk.dim(`${line}:${column}`),
+            errored ? chalk.red('error') : chalk.yellow('warning'),
+            message,
+            text,
+        ];
+    };
+    for (const result of results) {
+        if (result.messages.length === 0)
+            continue;
+        errorCount += result.errorCount;
+        warningCount += result.warningCount;
+        fixableErrorCount += result.fixableErrorCount;
+        fixableWarningCount += result.fixableWarningCount;
+        output += `${chalk.underline(result.filePath)}\n`;
+        output += `${table(result.messages.map(transformMessage), {
+            align: ['.', 'r', 'l'],
+            stringLength: (str) => stripAnsi(str).length,
+        })}\n\n`;
+    }
+    const total = errorCount + warningCount;
+    if (fix)
+        output += chalk.green('代码规范问题自动修复完成，请通过 git diff 确认修复效果 :D\n');
+    if (fix && total > 0) {
+        output += chalk.green('ps. 以上显示的是无法被自动修复的问题，需要手动进行修复\n');
+    }
+    if (!fix && total > 0) {
+        output += chalk[summaryColor].bold(`${UNICODE.failure} 共 ${total} 个问题（${errorCount} 个错误，${warningCount} 个警告）\n`);
+        if (fixableErrorCount > 0 || fixableWarningCount > 0) {
+            output += chalk[summaryColor].bold(`  其中 ${fixableErrorCount} 个错误、${fixableWarningCount} 个警告可通过 \`${CLI_NAME} fix\` 自动修复`);
+        }
+    }
+    if (!fix && total === 0)
+        output = chalk.green.bold(`${UNICODE.success} 没有发现问题`);
+    console.log(chalk.reset(output));
+}

package/dist/utils/read-config.d.ts

@@ -0,0 +1,3 @@
+import type { Config } from '../types.js';
+/** Read `<cli>.config.{mjs,cjs,js}` from the project, if present. */
+export declare function readLinterSpecConfig(cwd: string): Promise<Config>;

package/dist/utils/read-config.js

@@ -0,0 +1,15 @@
+import path from 'node:path';
+import { pathToFileURL } from 'node:url';
+import fs from 'fs-extra';
+import { CLI_NAME } from './constants.js';
+/** Read `<cli>.config.{mjs,cjs,js}` from the project, if present. */
+export async function readLinterSpecConfig(cwd) {
+    for (const ext of ['mjs', 'cjs', 'js']) {
+        const configPath = path.resolve(cwd, `${CLI_NAME}.config.${ext}`);
+        if (fs.existsSync(configPath)) {
+            const mod = await import(pathToFileURL(configPath).href);
+            return (mod.default ?? mod);
+        }
+    }
+    return {};
+}

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "@linter-spec/cli",
+  "version": "1.0.0",
+  "description": "One-command lint toolchain (ESLint / Stylelint / markdownlint / Prettier / commitlint) for the linter-spec spec.",
+  "type": "module",
+  "author": "SotherWind",
+  "license": "MIT",
+  "homepage": "https://github.com/SotherWind/linter-spec/tree/main/packages/cli",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SotherWind/linter-spec.git",
+    "directory": "packages/cli"
+  },
+  "bugs": {
+    "url": "https://github.com/SotherWind/linter-spec/issues"
+  },
+  "keywords": [
+    "lint",
+    "cli",
+    "eslint",
+    "stylelint",
+    "prettier",
+    "linter-spec"
+  ],
+  "bin": {
+    "linter-spec": "./dist/cli.js"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@commitlint/cli": "^19.5.0",
+    "@inquirer/prompts": "^8.5.2",
+    "chalk": "^5.6.2",
+    "commander": "^14.0.3",
+    "cross-spawn": "^7.0.6",
+    "ejs": "^6.0.1",
+    "eslint": "^9.39.4",
+    "execa": "^9.6.1",
+    "fast-glob": "^3.3.3",
+    "fs-extra": "^11.3.5",
+    "is-docker": "^4.0.0",
+    "markdownlint": "^0.34.0",
+    "markdownlint-cli2": "^0.14.0",
+    "markdownlint-rule-helpers": "^0.25.0",
+    "ora": "^9.4.0",
+    "prettier": "^3.8.3",
+    "strip-ansi": "^7.2.0",
+    "stylelint": "^17.13.0",
+    "terminal-link": "^5.0.0",
+    "text-table": "^0.2.0",
+    "@linter-spec/commitlint-config": "^1.0.0",
+    "@linter-spec/eslint-config": "^1.0.0",
+    "@linter-spec/markdownlint-config": "^1.0.0",
+    "@linter-spec/stylelint-config": "^1.0.0"
+  },
+  "devDependencies": {
+    "@types/cross-spawn": "^6.0.6",
+    "@types/ejs": "^3.1.5",
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^22.7.0",
+    "@types/text-table": "^0.2.5",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.6.2",
+    "vitest": "^2.1.1"
+  },
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "scripts": {
+    "build": "rimraf dist && tsc && node scripts/copy-templates.mjs",
+    "dev": "tsc -w",
+    "pretest": "pnpm build",
+    "test": "vitest run"
+  }
+}