@st1ggy/linter-config 6.3.2 → 7.2.2

package/scripts/linter-init.mjs

@@ -10,18 +10,36 @@ import ora from 'ora'
 import {
   PACKAGE,
   STACK_CHOICES,
-  ensureDevDependency,
+  STACK_KEYS,
+  ensureDevDependencies,
+  existingWrapperFiles,
   isSelfPackageRoot,
+  legacyConfigFiles,
   printHelp,
+  removeFiles,
   resolveStackKey,
   resolveTargetDirectory,
   run,
+  stackPackages,
 } 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'],
+    boolean: [
+      'help',
+      'h',
+      'skip-install',
+      'eslint',
+      'biome',
+      'common',
+      'react',
+      'next',
+      'svelte',
+      'astro',
+      'interactive',
+      'i',
+    ],
     alias: {
       h: 'help',
       d: 'dir',
@@ -43,85 +61,120 @@ function argvToValues(argv) {
     react: Boolean(argv.react),
     next: Boolean(argv.next),
     svelte: Boolean(argv.svelte),
+    astro: Boolean(argv.astro),
   }
 }
 
-async function runInteractive() {
-  const command = await select({
-    message: 'Command',
+async function selectCommand(command) {
+  if (command) {
+    return command
+  }
+
+  return select({
+    message: 'Action',
     choices: [
       {
         value: 'init',
-        name: 'init — create eslint / prettier / stylelint wrappers (skip if files exist)',
-      },
-      {
-        value: 'reinit',
-        name: 'reinit — overwrite the three wrapper files',
+        name: 'init — create missing ESLint, Prettier and Stylelint wrappers',
       },
       {
-        value: 'create',
-        name: 'create — same as init',
+        value: 'migrate',
+        name: 'migrate — remove selected legacy configs and replace wrappers',
       },
     ],
     default: 'init',
   })
+}
+
+async function selectStack(values) {
+  const stackKey = resolveStackKey(values)
+
+  if (STACK_KEYS.some((key) => values[key] === true)) {
+    return stackKey
+  }
 
-  const stackKey = await select({
+  return select({
     message: 'Stack',
     choices: STACK_CHOICES,
     default: 'common',
   })
+}
 
-  const targetDirectory = await input({
-    message: 'Target directory',
-    default: process.cwd(),
-  })
+async function selectLegacyFiles(command, directory) {
+  if (command !== 'migrate') {
+    return []
+  }
 
-  const skipInstall = await confirm({
-    message: `Skip installing ${PACKAGE} (only write config files)?`,
-    default: false,
-  })
+  const selected = []
 
-  const resolved = resolveTargetDirectory(targetDirectory)
+  for (const file of legacyConfigFiles(directory)) {
+    if (await confirm({ message: `Remove legacy config ${file}?`, default: false })) {
+      selected.push(file)
+    }
+  }
+
+  return selected
+}
+
+function printSummary(command, stack, directory, shouldSkipInstall, existing, filesToRemove, packages) {
+  const wrapperFiles =
+    command === 'init' && existing.length > 0
+      ? `create missing; keep ${existing.join(', ')}`
+      : 'write eslint.config.js, prettier.config.js, stylelint.config.js'
 
   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(`  Action:  ${command}\n`)
+  process.stdout.write(`  Stack:   ${stack}\n`)
+  process.stdout.write(`  Dir:     ${directory}\n`)
+  process.stdout.write(`  Install packages: ${shouldSkipInstall ? 'no (--skip-install)' : packages.join(', ')}\n`)
+  process.stdout.write(`  Wrapper files: ${wrapperFiles}\n`)
+  process.stdout.write(`  Legacy files to remove: ${filesToRemove.length > 0 ? filesToRemove.join(', ') : 'none'}\n`)
   process.stdout.write('\n')
+}
 
-  const proceed = await confirm({
+async function runInteractive(command, values) {
+  const selectedCommand = await selectCommand(command)
+  const selectedStack = await selectStack(values)
+  const targetDirectory = await input({ message: 'Target directory', default: values.dir ?? process.cwd() })
+
+  const resolved = resolveTargetDirectory(targetDirectory)
+
+  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 shouldSkipInstall = values['skip-install'] === true
+  const existing = existingWrapperFiles(resolved)
+  const filesToRemove = await selectLegacyFiles(selectedCommand, resolved)
+  const packages = stackPackages(selectedStack)
+
+  printSummary(selectedCommand, selectedStack, resolved, shouldSkipInstall, existing, filesToRemove, packages)
+
+  const shouldProceed = await confirm({
     message: 'Proceed?',
     default: true,
   })
 
-  if (!proceed) {
+  if (!shouldProceed) {
     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) {
+  if (shouldSkipInstall) {
     ora({ color: 'gray' }).info(`Skipped installing ${PACKAGE} (--skip-install)`)
   } else {
     const spinner = ora({
       color: 'cyan',
-      text: `Ensuring ${PACKAGE} is installed…`,
+      text: `Installing ${selectedStack} linting packages…`,
     }).start()
 
     try {
-      ensureDevDependency(resolved, false, { quiet: true })
-      spinner.succeed(`${PACKAGE} is available`)
+      ensureDevDependencies(resolved, packages, false, { quiet: true })
+      spinner.succeed(`${selectedStack} linting packages are available`)
     } catch (error) {
       spinner.fail('Dependency step failed')
       throw error
@@ -134,7 +187,8 @@ async function runInteractive() {
   }).start()
 
   try {
-    run(cmd, resolved, stackKey, { quiet: true })
+    removeFiles(resolved, filesToRemove)
+    run(selectedCommand, resolved, selectedStack, { quiet: true })
     writeSpinner.succeed('Wrapper configs written')
   } catch (error) {
     writeSpinner.fail('Failed to write configs')
@@ -142,32 +196,30 @@ async function runInteractive() {
   }
 }
 
-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`,
-    )
+function normalizeCommand(command) {
+  if (command === 'create') {
+    return 'init'
   }
 
-  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.`,
-    )
+  if (command === 'reinit') {
+    return 'migrate'
   }
 
-  const cmd = command === 'create' ? 'init' : command
+  return command
+}
 
-  ensureDevDependency(targetDirectory, skipInstall)
-  run(cmd, targetDirectory, stackKey)
+function warnLegacyFlags(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`,
+    )
+  }
 }
 
-async function runInteractiveOrHandleErrors() {
+async function runInteractiveOrHandleErrors(command, values) {
   try {
-    await runInteractive()
+    warnLegacyFlags(values)
+    await runInteractive(command, values)
   } catch (error) {
     if (error instanceof ExitPromptError || error instanceof CancelPromptError) {
       process.stdout.write('\nCancelled.\n')
@@ -183,24 +235,8 @@ async function runInteractiveOrHandleErrors() {
   }
 }
 
-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]
+  const argv = parseArgv(process.argv.slice(2))
 
   if (argv.help) {
     printHelp()
@@ -209,35 +245,24 @@ async function main() {
     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()
+  if (!process.stdin.isTTY || !process.stdout.isTTY) {
+    process.stderr.write('This command requires an interactive terminal.\n')
     process.exitCode = 1
 
     return
   }
 
-  const command = first
+  const first = argv._[0]
 
-  if (command !== 'init' && command !== 'reinit' && command !== 'create') {
-    process.stderr.write(`Unknown command "${String(command)}".\n\n`)
+  if (first !== undefined && first !== 'init' && first !== 'migrate' && first !== 'reinit' && first !== 'create') {
+    process.stderr.write(`Unknown command "${String(first)}".\n\n`)
     printHelp()
     process.exitCode = 1
 
     return
   }
 
-  runSubcommandCli(command, argv)
+  await runInteractiveOrHandleErrors(first === undefined ? undefined : normalizeCommand(first), argvToValues(argv))
 }
 
 await main()

package/src/eslint/configs/astro-stack.js

@@ -0,0 +1,3 @@
+import { configs } from 'eslint-plugin-astro'
+
+export default configs.recommended

package/src/eslint/configs/config.common.js

@@ -102,7 +102,7 @@ export default defineConfig([
         { blankLine: 'always', prev: '*', next: 'case' },
         { blankLine: 'always', prev: 'if', next: '*' },
       ],
-      '@stylistic/multiline-comment-style': ['error', 'separate-lines', { checkJSDoc: true }],
+      '@stylistic/multiline-comment-style': 'off',
     },
   },
 ])

package/src/eslint/configs/config.gitignore.js

@@ -1,11 +1,10 @@
-import { includeIgnoreFile } from '@eslint/compat'
+import { includeIgnoreFile } from '@eslint/config-helpers'
 import { defineConfig } from 'eslint/config'
 import { findUpSync } from 'find-up-simple'
 import process from 'node:process'
 import { fileURLToPath } from 'node:url'
 
 const gitignorePath = findUpSync('.gitignore', { cwd: process.cwd() })
+const ignoreFile = gitignorePath ? fileURLToPath(new URL(gitignorePath, import.meta.url)) : null
 
-export default defineConfig(
-  gitignorePath ? [includeIgnoreFile(fileURLToPath(new URL(gitignorePath, import.meta.url)))] : [],
-)
+export default defineConfig(ignoreFile ? [includeIgnoreFile(ignoreFile)] : [])

package/src/eslint/configs/config.unicorn.js

@@ -12,7 +12,7 @@ export default defineConfig([
       'unicorn/custom-error-definition': 'error',
       'unicorn/no-unused-properties': 'error',
       'unicorn/no-null': 'off',
-      'unicorn/prevent-abbreviations': [
+      'unicorn/name-replacements': [
         'error',
         {
           replacements: {

package/src/eslint/configs/constants.js

@@ -1,7 +1,9 @@
 export const files = ['**/*.{js,jsx,ts,tsx,mts,cts,mjs,cjs,vue,svelte}']
 
-/** For `parserOptions.project` / type-aware @typescript-eslint rules (omit `.svelte`; Svelte scripts use svelte-eslint-parser). */
+// For `parserOptions.project` / type-aware @typescript-eslint rules (omit `.svelte`; Svelte scripts use svelte-eslint-parser).
+// Svelte scripts use svelte-eslint-parser.
 export const filesTypeAware = ['**/*.{js,jsx,ts,tsx,mts,cts,mjs,cjs,vue}']
 
-/** Prettier run via eslint-plugin-prettier (omit `.svelte` unless Prettier is configured with `prettier-plugin-svelte`). */
+// Prettier runs via eslint-plugin-prettier.
+// Omit `.svelte` unless Prettier is configured with `prettier-plugin-svelte`.
 export const filesPrettier = ['**/*.{js,jsx,ts,tsx,mts,cts,mjs,cjs,vue}']

package/src/eslint/eslint.config.astro.js

@@ -0,0 +1,4 @@
+import astroConfig from './configs/astro-stack.js'
+import commonConfig from './eslint.config.common.js'
+
+export default [...commonConfig, ...astroConfig]

package/src/examples/example.astro

@@ -0,0 +1,7 @@
+---
+const title = 'Astro example'
+---
+
+<main>
+  <h1>{title}</h1>
+</main>

package/src/examples/example.ts

@@ -1 +1 @@
-export const example = true
+export const isExample = true

package/src/index.js

@@ -2,8 +2,10 @@ export { default as eslintCommon } from './eslint/eslint.config.common.js'
 export { default as eslintReact } from './eslint/eslint.config.react.js'
 export { default as eslintNext } from './eslint/eslint.config.next.js'
 export { default as eslintSvelte } from './eslint/eslint-svelte.config.js'
+export { default as eslintAstro } from './eslint/eslint.config.astro.js'
 
 export { default as prettierCommon } from './prettier/prettier.config.common.js'
 export { default as prettierSvelte } from './prettier/prettier-svelte.config.js'
+export { default as prettierAstro } from './prettier/prettier-astro.config.js'
 
 export { default as stylelintScss } from './stylelint/stylelint.config.scss.js'

package/src/prettier/prettier-astro.config.js

@@ -0,0 +1,7 @@
+import commonConfig from './prettier.config.common.js'
+
+export default {
+  ...commonConfig,
+  plugins: ['prettier-plugin-astro'],
+  overrides: [{ files: '*.astro', options: { parser: 'astro' } }],
+}