@linter-spec/cli 1.0.0 → 1.0.2

package/dist/actions/init/index.js

@@ -7,7 +7,7 @@ import generateTemplate from '../../utils/generate-template.js';
 import { CLI_NAME, PROJECT_TYPES } from '../../utils/constants.js';
 import { messages } from '../../utils/messages.js';
 import { chooseEnableMarkdownlint, chooseEnablePrettier, chooseEnableStylelint, chooseEslintType, } from './prompts.js';
-import { installCliDep } from './install-deps.js';
+import { installProjectDeps } from './install-deps.js';
 import { setupHusky } from './setup-husky.js';
 export default async function init(options) {
     const cwd = options.cwd || process.cwd();
@@ -46,7 +46,7 @@ export default async function init(options) {
         log.success(messages.stepConflictDone(step));
         if (!disableNpmInstall) {
             log.info(messages.stepInstall(++step));
-            await installCliDep(cwd);
+            await installProjectDeps(cwd, config);
             log.success(messages.stepInstallDone(step));
         }
     }

package/dist/actions/init/install-deps.d.ts

@@ -1,7 +1,25 @@
 /** True when the project carries its own lint config files. */
 export declare function hasLocalLintConfig(cwd: string): boolean;
-/** Install the CLI itself as a dev dependency of the target project. */
-export declare function installCliDep(cwd: string): Promise<void>;
+export interface ProjectDepsConfig {
+    enableESLint: boolean;
+    eslintType: string;
+    enableStylelint: boolean;
+    enableMarkdownlint: boolean;
+    enablePrettier: boolean;
+}
+/**
+ * The npm packages to install as devDependencies of the user's project so that
+ * the generated `eslint.config.mjs` (and friends) can resolve everything they
+ * need — including peers of `@linter-spec/eslint-config` that are marked
+ * `optional` in its `peerDependenciesMeta` and therefore would NOT be installed
+ * transitively just by adding `@linter-spec/cli`.
+ */
+export declare function projectDepsToInstall(config: ProjectDepsConfig): string[];
+/**
+ * Install everything the chosen lint setup needs (CLI + eslint-config +
+ * project-type-specific plugins + selected toolchains) as devDeps of `cwd`.
+ */
+export declare function installProjectDeps(cwd: string, config: ProjectDepsConfig): Promise<void>;
 /**
  * When a project relies on the bundled lint configs but has no `node_modules`,
  * install its dependencies first (otherwise config resolution fails).

package/dist/actions/init/install-deps.js

@@ -16,10 +16,87 @@ export function hasLocalLintConfig(cwd) {
         '.markdownlint?(-cli2).@(jsonc|json|yaml|yml|cjs|mjs)',
     ], { cwd, dot: true }).length > 0);
 }
-/** Install the CLI itself as a dev dependency of the target project. */
-export async function installCliDep(cwd) {
-    const [command, args] = addDevCommand(detectPackageManager(cwd), PKG_NAME);
-    spawn.sync(command, args, { stdio: 'inherit', cwd });
+/**
+ * Version ranges to pin so npm/pnpm don't pull a major that the config doesn't
+ * support yet. Mirrors `@linter-spec/eslint-config`'s `peerDependencies` —
+ * e.g., ESLint 10 changed `context.getFilename()` to `context.filename`, which
+ * crashes `eslint-plugin-react@7` at rule-load time. Keep this in sync with
+ * eslint-config's peers if those ranges bump.
+ */
+const PINNED_VERSIONS = {
+    eslint: '^9.0.0',
+    typescript: '^5.6.2',
+    'typescript-eslint': '^8.8.1',
+    'eslint-plugin-react': '^7.37.1',
+    'eslint-plugin-react-hooks': '^5.0.0',
+    'eslint-plugin-jsx-a11y': '^6.10.0',
+    'eslint-plugin-vue': '^9.28.0',
+    'vue-eslint-parser': '^9.4.3',
+    'eslint-plugin-n': '^17.10.3',
+};
+function pin(name) {
+    const v = PINNED_VERSIONS[name];
+    return v ? `${name}@${v}` : name;
+}
+/**
+ * The npm packages to install as devDependencies of the user's project so that
+ * the generated `eslint.config.mjs` (and friends) can resolve everything they
+ * need — including peers of `@linter-spec/eslint-config` that are marked
+ * `optional` in its `peerDependenciesMeta` and therefore would NOT be installed
+ * transitively just by adding `@linter-spec/cli`.
+ */
+export function projectDepsToInstall(config) {
+    const deps = new Set([PKG_NAME]);
+    if (config.enableESLint) {
+        deps.add('eslint');
+        deps.add('@linter-spec/eslint-config');
+        const t = config.eslintType;
+        const isTs = t.startsWith('typescript');
+        const isReact = t === 'react' || t === 'typescript/react';
+        const isVue = t === 'vue' || t === 'typescript/vue';
+        const isNode = t === 'node' || t === 'typescript/node';
+        if (isTs) {
+            deps.add('typescript');
+            deps.add('typescript-eslint');
+        }
+        if (isReact) {
+            deps.add('eslint-plugin-react');
+            deps.add('eslint-plugin-react-hooks');
+            deps.add('eslint-plugin-jsx-a11y');
+        }
+        if (isVue) {
+            deps.add('eslint-plugin-vue');
+            deps.add('vue-eslint-parser');
+        }
+        if (isNode) {
+            deps.add('eslint-plugin-n');
+        }
+    }
+    if (config.enableStylelint) {
+        deps.add('stylelint');
+        deps.add('@linter-spec/stylelint-config');
+    }
+    if (config.enableMarkdownlint) {
+        deps.add('markdownlint-cli2');
+        deps.add('@linter-spec/markdownlint-config');
+    }
+    if (config.enablePrettier) {
+        deps.add('prettier');
+    }
+    return [...deps].map(pin);
+}
+/**
+ * Install everything the chosen lint setup needs (CLI + eslint-config +
+ * project-type-specific plugins + selected toolchains) as devDeps of `cwd`.
+ */
+export async function installProjectDeps(cwd, config) {
+    const pm = detectPackageManager(cwd);
+    const pkgs = projectDepsToInstall(config);
+    const [command, args] = addDevCommand(pm, pkgs);
+    const result = spawn.sync(command, args, { stdio: 'inherit', cwd });
+    if (result.status !== 0) {
+        throw new Error(`Failed to install project dependencies (\`${command} ${args.join(' ')}\` exited with ${result.status}).`);
+    }
 }
 /**
  * When a project relies on the bundled lint configs but has no `node_modules`,

package/dist/config/tsconfig.json.ejs

@@ -0,0 +1,30 @@
+<%_
+// Only emit a tsconfig for TypeScript project types. The init flow skips
+// templates that render to an empty string.
+if (!eslintType.startsWith('typescript')) { return ''; }
+
+const isReact = eslintType === 'typescript/react';
+const isVue   = eslintType === 'typescript/vue';
+const isNode  = eslintType === 'typescript/node';
+// Node-only projects don't need DOM types; everything else (plain TS, React, Vue) does.
+const lib = isNode ? ['ES2022'] : ['ES2022', 'DOM', 'DOM.Iterable'];
+_%>
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "lib": [<%- lib.map((l) => `"${l}"`).join(', ') %>],<% if (isReact) { %>
+    "jsx": "react-jsx",<% } %><% if (isVue) { %>
+    "jsx": "preserve",<% } %>
+    "strict": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true
+  },
+  "include": ["**/*.ts"<% if (isReact) { %>, "**/*.tsx"<% } %><% if (isVue) { %>, "**/*.vue"<% } %>],
+  "exclude": ["node_modules", "dist", "build", "coverage", ".next", ".nuxt", ".turbo"]
+}

package/dist/utils/conflict-resolve.js

@@ -6,6 +6,7 @@ import { confirm } from '@inquirer/prompts';
 import log from './log.js';
 import { messages } from './messages.js';
 import { CliAbortError } from './errors.js';
+import { SKIP_IF_EXISTS } from './generate-template.js';
 const dirname = path.dirname(fileURLToPath(import.meta.url));
 // Remove these exact dependencies (they conflict or are superseded).
 const packageNamesToRemove = [
@@ -55,6 +56,7 @@ const checkUselessConfig = (cwd) => []
 const checkReWriteConfig = (cwd) => fg
     .sync('**/*.ejs', { cwd: path.resolve(dirname, '../config'), dot: true })
     .map((name) => name.replace(/^_/, '.').replace(/\.ejs$/, ''))
+    .filter((filename) => !SKIP_IF_EXISTS.has(path.basename(filename)))
     .filter((filename) => fs.existsSync(path.resolve(cwd, filename)));
 export default async function conflictResolve(cwd, rewriteConfig) {
     const pkgPath = path.resolve(cwd, 'package.json');

package/dist/utils/generate-template.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Files we will never silently overwrite — user customisations would be lost.
+ * The conflict-resolve step already prompts before regenerating known lint
+ * configs; these are extra files we only seed on a clean project.
+ */
+export declare const SKIP_IF_EXISTS: Set<string>;
 /**
  * Render the EJS config templates into `cwd`.
  * @param cwd  target project root

package/dist/utils/generate-template.js

@@ -39,6 +39,12 @@ const mergeVSCodeConfig = (filepath, content) => {
         return '';
     }
 };
+/**
+ * Files we will never silently overwrite — user customisations would be lost.
+ * The conflict-resolve step already prompts before regenerating known lint
+ * configs; these are extra files we only seed on a clean project.
+ */
+export const SKIP_IF_EXISTS = new Set(['tsconfig.json']);
 /**
  * Render the EJS config templates into `cwd`.
  * @param cwd  target project root
@@ -49,7 +55,10 @@ export default function generateTemplate(cwd, data, vscode) {
     const templatePath = path.resolve(dirname, '../config');
     const templates = fg.sync(`${vscode ? '_vscode' : '**'}/*.ejs`, { cwd: templatePath, dot: true });
     for (const name of templates) {
-        const filepath = path.resolve(cwd, name.replace(/\.ejs$/, '').replace(/^_/, '.'));
+        const outName = name.replace(/\.ejs$/, '').replace(/^_/, '.');
+        const filepath = path.resolve(cwd, outName);
+        if (SKIP_IF_EXISTS.has(path.basename(outName)) && fs.existsSync(filepath))
+            continue;
         let content = ejs.render(fs.readFileSync(path.resolve(templatePath, name), 'utf8'), {
             eslintIgnores: ESLINT_IGNORE_GLOBS,
             stylelintExt: STYLELINT_FILE_EXT,

package/dist/utils/npm.d.ts

@@ -12,8 +12,8 @@ export type PackageManager = 'npm' | 'pnpm' | 'yarn' | 'bun' | 'cnpm';
  * `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 one or more dev dependencies, per package manager. */
+export declare function addDevCommand(pm: PackageManager, pkg: string | 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. */

package/dist/utils/npm.js

@@ -48,15 +48,16 @@ export function detectPackageManager(cwd = process.cwd()) {
     // 4. Fallback.
     return 'npm';
 }
-/** `[command, args]` to add a dev dependency, per package manager. */
+/** `[command, args]` to add one or more dev dependencies, per package manager. */
 export function addDevCommand(pm, pkg) {
+    const list = Array.isArray(pkg) ? pkg : [pkg];
     switch (pm) {
         case 'yarn':
-            return ['yarn', ['add', '-D', pkg]];
+            return ['yarn', ['add', '-D', ...list]];
         case 'bun':
-            return ['bun', ['add', '-d', pkg]];
+            return ['bun', ['add', '-d', ...list]];
         default: // npm / pnpm / cnpm
-            return [pm, ['i', '-D', pkg]];
+            return [pm, ['i', '-D', ...list]];
     }
 }
 /** `[command, args]` to add a global package, per package manager. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linter-spec/cli",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "One-command lint toolchain (ESLint / Stylelint / markdownlint / Prettier / commitlint) for the linter-spec spec.",
   "type": "module",
   "author": "SotherWind",
@@ -61,9 +61,9 @@
     "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/eslint-config": "^1.0.0",
+    "@linter-spec/commitlint-config": "^1.0.0",
     "@linter-spec/stylelint-config": "^1.0.0"
   },
   "devDependencies": {