@st1ggy/linter-config 5.0.0 → 6.3.1

package/scripts/linter-init-core.mjs

@@ -0,0 +1,317 @@
+// Shared logic for @st1ggy/linter-config CLI (no prompts).
+
+import { spawnSync } from 'node:child_process'
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs'
+import path from 'node:path'
+
+export const PACKAGE = '@st1ggy/linter-config'
+
+export const STACK_KEYS = ['common', 'react', 'next', 'svelte']
+
+export const STACKS = {
+  common: {
+    eslint: 'eslint-common',
+    prettier: 'prettier-common',
+    stylelint: 'stylelint-scss',
+  },
+  react: {
+    eslint: 'eslint-react',
+    prettier: 'prettier-common',
+    stylelint: 'stylelint-scss',
+  },
+  next: {
+    eslint: 'eslint-next',
+    prettier: 'prettier-common',
+    stylelint: 'stylelint-scss',
+  },
+  svelte: {
+    eslint: 'eslint-svelte',
+    prettier: 'prettier-svelte',
+    stylelint: 'stylelint-scss',
+  },
+}
+
+export const STACK_CHOICES = [
+  {
+    value: 'common',
+    name: 'common — TypeScript/JS base + Stylelint (default)',
+  },
+  {
+    value: 'react',
+    name: 'react — React + hooks on top of common',
+  },
+  {
+    value: 'next',
+    name: 'next — Next.js App Router on top of react',
+  },
+  {
+    value: 'svelte',
+    name: 'svelte — Svelte + Prettier plugin for Svelte',
+  },
+]
+
+export function readPackageJson(directory) {
+  const filePath = path.join(directory, 'package.json')
+
+  if (!existsSync(filePath)) {
+    return null
+  }
+
+  try {
+    return JSON.parse(readFileSync(filePath, 'utf8'))
+  } catch {
+    return null
+  }
+}
+
+export function mergedDeps(packageJson) {
+  return {
+    ...packageJson.optionalDependencies,
+    ...packageJson.peerDependencies,
+    ...packageJson.dependencies,
+    ...packageJson.devDependencies,
+  }
+}
+
+export function isSelfPackageRoot(directory) {
+  const packageJson = readPackageJson(directory)
+
+  return packageJson?.name === PACKAGE
+}
+
+export function hasResolvablePackage(startDirectory) {
+  let currentDirectory = path.resolve(startDirectory)
+
+  while (true) {
+    const marker = path.join(currentDirectory, 'node_modules', '@st1ggy', 'linter-config', 'package.json')
+
+    if (existsSync(marker)) {
+      return true
+    }
+
+    const parentDirectory = path.dirname(currentDirectory)
+
+    if (parentDirectory === currentDirectory) {
+      break
+    }
+
+    currentDirectory = parentDirectory
+  }
+
+  return false
+}
+
+export function detectPackageManager(startDirectory) {
+  let currentDirectory = path.resolve(startDirectory)
+
+  while (true) {
+    if (existsSync(path.join(currentDirectory, 'pnpm-lock.yaml'))) {
+      return 'pnpm'
+    }
+
+    if (existsSync(path.join(currentDirectory, 'yarn.lock'))) {
+      return 'yarn'
+    }
+
+    if (existsSync(path.join(currentDirectory, 'bun.lock'))) {
+      return 'bun'
+    }
+
+    if (existsSync(path.join(currentDirectory, 'package-lock.json'))) {
+      return 'npm'
+    }
+
+    const parentDirectory = path.dirname(currentDirectory)
+
+    if (parentDirectory === currentDirectory) {
+      return 'npm'
+    }
+
+    currentDirectory = parentDirectory
+  }
+}
+
+export function runPmSync(command, args, cwd) {
+  const result = spawnSync(command, args, { cwd, env: process.env, stdio: 'inherit' })
+
+  if (result.error) {
+    throw result.error
+  }
+
+  if (result.status !== 0) {
+    throw new Error(`${command} ${args.join(' ')} exited with ${result.status}`)
+  }
+}
+
+// skipInstall: skip npm install; options.quiet: suppress stderr warnings
+export function ensureDevDependency(targetDirectory, skipInstall, options = {}) {
+  const { quiet = false } = options
+
+  if (skipInstall) {
+    return
+  }
+
+  const directory = path.resolve(targetDirectory)
+
+  const packageJsonPath = path.join(directory, 'package.json')
+
+  if (!existsSync(packageJsonPath)) {
+    if (!quiet) {
+      process.stderr.write(
+        `warning: no package.json in ${directory}; add the dependency manually: npm i -D ${PACKAGE}\n`,
+      )
+    }
+
+    return
+  }
+
+  if (hasResolvablePackage(directory)) {
+    return
+  }
+
+  const packageJson = readPackageJson(directory)
+
+  if (!packageJson) {
+    return
+  }
+
+  const pm = detectPackageManager(directory)
+  const listed = Boolean(mergedDeps(packageJson)[PACKAGE])
+
+  if (listed) {
+    if (!quiet) {
+      process.stdout.write(`install: ${pm} install (${directory}) — dependency already listed\n`)
+    }
+
+    const sync = {
+      npm: () => runPmSync('npm', ['install'], directory),
+      pnpm: () => runPmSync('pnpm', ['install'], directory),
+      yarn: () => runPmSync('yarn', ['install'], directory),
+      bun: () => runPmSync('bun', ['install'], directory),
+    }
+
+    sync[pm]()
+
+    return
+  }
+
+  if (!quiet) {
+    process.stdout.write(`install: ${pm} add -D ${PACKAGE} (${directory})\n`)
+  }
+
+  const add = {
+    npm: () => runPmSync('npm', ['install', '-D', PACKAGE], directory),
+    pnpm: () => runPmSync('pnpm', ['add', '-D', PACKAGE], directory),
+    yarn: () => runPmSync('yarn', ['add', '-D', PACKAGE], directory),
+    bun: () => runPmSync('bun', ['add', '-d', PACKAGE], directory),
+  }
+
+  add[pm]()
+}
+
+export function printHelp() {
+  process.stdout.write(`\
+${PACKAGE} — generate local wrapper configs in a consumer project.
+
+With no command in an interactive terminal, opens a guided menu (or pass -i / --interactive).
+
+Commands:
+  init     Create missing files only (skip existing).
+  reinit   Overwrite selected files.
+  create   Same as init.
+
+Writes (each command):
+  eslint.config.js, prettier.config.js, stylelint.config.js — re-exports for one stack.
+
+Unless --skip-install: if package.json exists and ${PACKAGE} is not yet resolvable from node_modules
+(walking up to the filesystem root), runs the detected package manager to add or sync the dependency.
+
+Stack (at most one; default: common):
+  --common | --react | --next | --svelte
+
+Options:
+  --dir, -d       Target directory (default: current working directory).
+  --skip-install  Do not run npm/pnpm/yarn/bun (only write wrapper files).
+  -i, --interactive  Open the menu even when a command is passed (experimental).
+
+Examples (after: npm i -D ${PACKAGE}):
+  npx ${PACKAGE}
+  npx ${PACKAGE} init
+  npx ${PACKAGE} init --react
+  npx ${PACKAGE} reinit --svelte --dir ./apps/web
+  npm exec ${PACKAGE} -- init --common
+
+Without prior install (downloads this package; then runs the same CLI):
+  npx --yes ${PACKAGE} init --common
+
+Repo (paths from root):
+  node scripts/linter-init.mjs init --common
+`)
+}
+
+export function jsReExport(subpath) {
+  return `export { default } from '${PACKAGE}/${subpath}';\n`
+}
+
+export function resolveTargetDirectory(raw) {
+  return path.resolve(raw)
+}
+
+export function writeFile(targetDirectory, name, content, overwrite, options = {}) {
+  const { quiet = false } = options
+  const filePath = path.join(targetDirectory, name)
+
+  if (!overwrite && existsSync(filePath)) {
+    if (!quiet) {
+      process.stdout.write(`skip (exists): ${name}\n`)
+    }
+
+    return false
+  }
+
+  mkdirSync(targetDirectory, { recursive: true })
+  writeFileSync(filePath, content, 'utf8')
+
+  if (!quiet) {
+    process.stdout.write(`write: ${name}\n`)
+  }
+
+  return true
+}
+
+export function resolveStackKey(values) {
+  const chosen = []
+
+  for (const key of STACK_KEYS) {
+    if (values[key] === true) {
+      chosen.push(key)
+    }
+  }
+
+  if (chosen.length === 0) {
+    return 'common'
+  }
+
+  if (chosen.length > 1) {
+    const flags = STACK_KEYS.map((key) => `--${key}`).join(', ')
+
+    throw new Error(`Pick at most one stack flag: ${flags}`)
+  }
+
+  return chosen[0]
+}
+
+export function run(mode, targetDirectory, stackKey, options = {}) {
+  const { quiet = false } = options
+  const stack = STACKS[stackKey]
+
+  if (!stack) {
+    throw new Error(`Unknown stack "${stackKey}". Use: ${STACK_KEYS.join(', ')}`)
+  }
+
+  const overwrite = mode === 'reinit'
+
+  writeFile(targetDirectory, 'eslint.config.js', jsReExport(stack.eslint), overwrite, { quiet })
+  writeFile(targetDirectory, 'prettier.config.js', jsReExport(stack.prettier), overwrite, { quiet })
+  writeFile(targetDirectory, 'stylelint.config.js', jsReExport(stack.stylelint), overwrite, { quiet })
+}

package/scripts/linter-init.mjs

@@ -0,0 +1,243 @@
+#!/usr/bin/env node
+// @st1ggy/linter-config — interactive menu (TTY) or minimist CLI.
+
+import { CancelPromptError, ExitPromptError } from '@inquirer/core'
+import { confirm, input, select } from '@inquirer/prompts'
+import minimist from 'minimist'
+import process from 'node:process'
+import ora from 'ora'
+
+import {
+  PACKAGE,
+  STACK_CHOICES,
+  ensureDevDependency,
+  isSelfPackageRoot,
+  printHelp,
+  resolveStackKey,
+  resolveTargetDirectory,
+  run,
+} from './linter-init-core.mjs'
+
+function parseArgv(argv) {
+  return minimist(argv, {
+    string: ['dir', 'd'],
+    boolean: ['help', 'h', 'skip-install', 'eslint', 'biome', 'common', 'react', 'next', 'svelte', 'interactive', 'i'],
+    alias: {
+      h: 'help',
+      d: 'dir',
+      i: 'interactive',
+    },
+    default: {},
+  })
+}
+
+function argvToValues(argv) {
+  const directory = argv.dir ?? argv.d ?? process.cwd()
+
+  return {
+    dir: directory,
+    'skip-install': Boolean(argv['skip-install']),
+    eslint: Boolean(argv.eslint),
+    biome: Boolean(argv.biome),
+    common: Boolean(argv.common),
+    react: Boolean(argv.react),
+    next: Boolean(argv.next),
+    svelte: Boolean(argv.svelte),
+  }
+}
+
+async function runInteractive() {
+  const command = await select({
+    message: 'Command',
+    choices: [
+      {
+        value: 'init',
+        name: 'init — create eslint / prettier / stylelint wrappers (skip if files exist)',
+      },
+      {
+        value: 'reinit',
+        name: 'reinit — overwrite the three wrapper files',
+      },
+      {
+        value: 'create',
+        name: 'create — same as init',
+      },
+    ],
+    default: 'init',
+  })
+
+  const stackKey = await select({
+    message: 'Stack',
+    choices: STACK_CHOICES,
+    default: 'common',
+  })
+
+  const targetDirectory = await input({
+    message: 'Target directory',
+    default: process.cwd(),
+  })
+
+  const skipInstall = await confirm({
+    message: `Skip installing ${PACKAGE} (only write config files)?`,
+    default: false,
+  })
+
+  const resolved = resolveTargetDirectory(targetDirectory)
+
+  process.stdout.write('\n')
+  process.stdout.write(`  Command: ${command}\n`)
+  process.stdout.write(`  Stack:   ${stackKey}\n`)
+  process.stdout.write(`  Dir:     ${resolved}\n`)
+  process.stdout.write(`  Skip install: ${skipInstall ? 'yes' : 'no'}\n`)
+  process.stdout.write('\n')
+
+  const proceed = await confirm({
+    message: 'Proceed?',
+    default: true,
+  })
+
+  if (!proceed) {
+    process.stdout.write('Cancelled.\n')
+    process.exitCode = 0
+
+    return
+  }
+
+  if (isSelfPackageRoot(resolved)) {
+    throw new Error(
+      `Refusing to write consumer wrapper configs in the ${PACKAGE} source tree (that would replace this repository’s dev configs). Run from another project, or pass a different directory.`,
+    )
+  }
+
+  const cmd = command === 'create' ? 'init' : command
+
+  if (skipInstall) {
+    ora({ color: 'gray' }).info(`Skipped installing ${PACKAGE} (--skip-install)`)
+  } else {
+    const spinner = ora({
+      color: 'cyan',
+      text: `Ensuring ${PACKAGE} is installed…`,
+    }).start()
+
+    try {
+      ensureDevDependency(resolved, false, { quiet: true })
+      spinner.succeed(`${PACKAGE} is available`)
+    } catch (error) {
+      spinner.fail('Dependency step failed')
+      throw error
+    }
+  }
+
+  const writeSpinner = ora({
+    color: 'green',
+    text: 'Writing eslint.config.js, prettier.config.js, stylelint.config.js…',
+  }).start()
+
+  try {
+    run(cmd, resolved, stackKey, { quiet: true })
+    writeSpinner.succeed('Wrapper configs written')
+  } catch (error) {
+    writeSpinner.fail('Failed to write configs')
+    throw error
+  }
+}
+
+function runCli(command, values) {
+  if (values.biome === true) {
+    process.stderr.write(
+      `warning: --biome is ignored; Biome presets were removed from ${PACKAGE}. Only ESLint, Prettier, and Stylelint wrappers are written.\n`,
+    )
+  }
+
+  const targetDirectory = resolveTargetDirectory(values.dir)
+  const stackKey = resolveStackKey(values)
+  const skipInstall = values['skip-install'] === true
+
+  if (isSelfPackageRoot(targetDirectory)) {
+    throw new Error(
+      `Refusing to write consumer wrapper configs in the ${PACKAGE} source tree (that would replace this repository’s dev configs). Run from another project, or pass --dir <path> to a folder with its own package.json.`,
+    )
+  }
+
+  const cmd = command === 'create' ? 'init' : command
+
+  ensureDevDependency(targetDirectory, skipInstall)
+  run(cmd, targetDirectory, stackKey)
+}
+
+async function runInteractiveOrHandleErrors() {
+  try {
+    await runInteractive()
+  } catch (error) {
+    if (error instanceof ExitPromptError || error instanceof CancelPromptError) {
+      process.stdout.write('\nCancelled.\n')
+      process.exitCode = 0
+
+      return
+    }
+
+    const message = error instanceof Error ? error.message : String(error)
+
+    process.stderr.write(`${message}\n`)
+    process.exitCode = 1
+  }
+}
+
+function runSubcommandCli(command, argv) {
+  const values = argvToValues(argv)
+
+  try {
+    runCli(command, values)
+  } catch (error) {
+    const message = error instanceof Error ? error.message : String(error)
+
+    process.stderr.write(`${message}\n`)
+    process.exitCode = 1
+  }
+}
+
+async function main() {
+  const raw = process.argv.slice(2)
+  const argv = parseArgv(raw)
+  const positional = argv._
+  const first = positional[0]
+
+  if (argv.help) {
+    printHelp()
+    process.exitCode = 0
+
+    return
+  }
+
+  const tty = Boolean(process.stdin.isTTY && process.stdout.isTTY)
+  const forceMenu = Boolean(argv.interactive || argv.i)
+  const noSubcommand = positional.length === 0
+  const useInteractiveMenu = noSubcommand && (forceMenu || tty)
+
+  if (useInteractiveMenu) {
+    await runInteractiveOrHandleErrors()
+
+    return
+  }
+
+  if (noSubcommand) {
+    printHelp()
+    process.exitCode = 1
+
+    return
+  }
+
+  const command = first
+
+  if (command !== 'init' && command !== 'reinit' && command !== 'create') {
+    process.stderr.write(`Unknown command "${String(command)}".\n\n`)
+    printHelp()
+    process.exitCode = 1
+
+    return
+  }
+
+  runSubcommandCli(command, argv)
+}
+
+await main()

package/scripts/remove-current.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+# Optional migration helper: interactively delete files in the *current directory* whose names
+# contain eslint, stylelint, or prettier (maxdepth 1). Use before switching to the three standard
+# wrappers from @st1ggy/linter-config — it does NOT replace `reinit` (reinit overwrites the standard
+# filenames without prompts). Not invoked by the CLI; run manually when cleaning legacy configs.
+
+set -euo pipefail
+
+for tool in eslint stylelint prettier; do
+  while IFS= read -r -d '' file; do
+    read -r -p "Delete ${file#./}? y/n " -n 1 -r
+    echo
+    if [[ $REPLY =~ ^[Yy]$ ]]; then
+      rm -f "$file"
+    fi
+  done < <(find . -maxdepth 1 -type f -name "*${tool}*" -print0)
+done

package/{packages/eslint/src → src}/eslint/configs/config.typescript.js

@@ -3,9 +3,25 @@ import { configs } from 'typescript-eslint'
 
 import { filesTypeAware } from './constants.js'
 
+// `flat/stylistic` enables `@typescript-eslint/consistent-type-definitions` as `'error'` only, which
+// uses the rule default (`interface`). Strip it here so we set `type` explicitly below.
+const stylisticWithoutTypeDefinitionStyle = configs.stylistic.map((block) => {
+  const rules = block.rules
+
+  if (!rules?.['@typescript-eslint/consistent-type-definitions']) {
+    return block
+  }
+
+  const nextRules = { ...rules }
+
+  delete nextRules['@typescript-eslint/consistent-type-definitions']
+
+  return { ...block, rules: nextRules }
+})
+
 export default defineConfig([
   ...configs.recommended,
-  ...configs.stylistic,
+  ...stylisticWithoutTypeDefinitionStyle,
   {
     files: filesTypeAware,
     languageOptions: {