@mouse_484/eslint-config 5.4.0 → 5.4.2

package/README.md

@@ -2,10 +2,48 @@
 
 ESLint Config based on [@antfu/eslint-config](https://github.com/antfu/eslint-config)
 
+## Requirements
+- ESLint: v9 or higher (Flat Config supported)
+
 ## Usage
+Run the setup command:
 ```
-@mouse_484/eslint-config@latest
+npx @mouse_484/eslint-config@latest
 ```
 
-> [!WARNING]
-> `npx` does not work. Use `pnpx` or run bin/cli.js directly after installation.
+## Features
+
+- More flexible adjustments for opinionated rules than [`lessOpinionated`](https://github.com/antfu/eslint-config?tab=readme-ov-file#top-level-function-style-etc).
+  - Disables `antfu/no-top-level-await` and `antfu/if-newline`.
+- Includes additional configurations by default:
+  - Recommended rules from [unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn).
+  - Rules from [stylistic](https://eslint.style/).
+- Customized rules:
+  - Stylistic rules adjustments.
+  - JSX properties sort order.
+  - File naming convention rules.
+- Additional plugins:
+  - [`eslint-plugin-better-tailwindcss`](https://github.com/schoero/eslint-plugin-better-tailwindcss) for Tailwind CSS.
+
+## Advanced Configuration
+
+#### TypeScript
+
+for type-aware linting
+
+```js
+export default mouse({
+  typescript: {
+    tsconfigPath: './tsconfig.json',
+  }
+})
+```
+
+#### Tailwind CSS
+
+```js
+export default mouse({
+  tailwind: {
+    entryPoint: './src/index.css',
+  },
+})

package/bin/cli.js

@@ -1,182 +1,114 @@
 #!/usr/bin/env node
-import { execSync, spawn } from 'node:child_process'
-import fs from 'node:fs/promises'
+import { spawn } from 'node:child_process'
+import { readFile, writeFile } from 'node:fs/promises'
 import path from 'node:path'
 import process from 'node:process'
 import { resolveCommand } from 'package-manager-detector/commands'
 import { detect } from 'package-manager-detector/detect'
 
-/**
- * @typedef {object} PackageInfo
- * @property {string} name - Package name
- * @property {string} import - Import name in config
- * @property {string} [version] - Package version
- */
-
-/** @type {PackageInfo} */
-const SOURCE = {
-  name: '@antfu/eslint-config',
-  import: 'antfu',
+const PACKAGE_NAME = {
+  BASE: '@antfu/eslint-config',
+  CUSTOM: '@mouse_484/eslint-config',
 }
 
-/** @type {PackageInfo} */
-const TARGET = {
-  name: '@mouse_484/eslint-config',
-  import: 'mouse',
-}
-
-const PACKAGE_JSON_FILE = 'package.json'
-const ESLINT_CONFIG_JS_FILE = 'eslint.config.js'
-const ESLINT_CONFIG_MJS_FILE = 'eslint.config.mjs'
-
-// infinite loop prevention
-const isRunningFromSourcePackage = process.argv[1].includes(SOURCE.name)
-
 /**
- * Execute command with spawn
- * @param {string} command - Command to execute
- * @param {string[]} args - Command arguments
- * @returns {Promise<void>}
+ * Simple logger function
+ * @param {*} message
  */
-function runCommand(command, args = []) {
-  console.info(`Running: ${command} ${args.join(' ')}`)
-  const spawnedProcess = spawn(command, args, { stdio: 'inherit', shell: true })
-
-  return new Promise((resolve, reject) => {
-    spawnedProcess.on('close', (code) => {
-      if (code === 0) {
-        setTimeout(() => {
-          resolve()
-        }, 300)
-      } else {
-        reject(new Error(`Command failed with exit code ${code}`))
-      }
-    })
-    spawnedProcess.on('error', reject)
-  })
+function logger(message) {
+  console.info('@mouse_484/eslint-config:', message)
 }
 
 /**
- * Execute antfu's CLI directly via node
- * @returns {Promise<void>}
+ * @type {(...args: Parameters<typeof import("package-manager-detector/commands").resolveCommand>) => Promise<void>}
  */
-async function runAntfuCLI() {
-  console.info('Running @antfu/eslint-config setup...')
-
-  const cwd = process.cwd()
-  const cliPath = path.join(cwd, 'node_modules', SOURCE.name, 'bin', 'index.js')
-
+function runAgentCommand(agent, command_, args_) {
+  const { command, args } = resolveCommand(agent, command_, args_)
   return new Promise((resolve, reject) => {
-    const nodeProcess = spawn('node', [cliPath], {
-      stdio: 'inherit',
-      cwd,
-      shell: true,
-    })
+    const child = spawn(
+      command,
+      args,
+      {
+        stdio: 'inherit',
+      },
+    )
 
-    nodeProcess.on('close', (code) => {
+    child.on('close', (code) => {
       if (code === 0) {
-        setTimeout(() => {
-          resolve()
-        }, 300)
+        resolve()
       } else {
-        reject(new Error(`Antfu CLI failed with exit code ${code}`))
+        reject(new Error(`Command failed: ${code} (${command} ${args.join(' ')})`))
       }
     })
-    nodeProcess.on('error', reject)
+    child.on('error', (error) => {
+      reject(error)
+    })
   })
 }
 
-/**
- * Update JSON file with transform function
- * @param {string} filePath - JSON file path
- * @param {(data: any) => any} updateFunction - Transform function
- */
-async function updateJSONFile(filePath, updateFunction) {
-  const content = await fs.readFile(filePath, 'utf8')
-  const data = JSON.parse(content)
-  const updated = updateFunction(data)
-  await fs.writeFile(filePath, JSON.stringify(updated, undefined, 2))
-  return updated
-}
-
 async function main() {
-  console.info('Starting ESLint config setup...')
+  const cwd = process.cwd()
+  logger('Starting setup')
 
-  if (isRunningFromSourcePackage) {
-    console.error(
-      `Please run this script from the root of your project, not from ${SOURCE.name} package.`,
-    )
-    process.exitCode = 1
-    return
+  const packageManager = await detect() ?? {
+    name: 'npm',
+    agent: 'npm',
+    version: 'unknown',
   }
 
-  const pm = await detect()
-  if (!pm) {
-    console.error(
-      'Could not detect package manager. '
-      + 'Please ensure you are in a project with a package.json file.',
-    )
-    process.exitCode = 1
-    return
+  logger(`Detected package manager: ${packageManager.name}`)
+
+  logger(`Setting up base package ${PACKAGE_NAME.BASE}`)
+  await runAgentCommand(
+    packageManager.agent,
+    'execute',
+    [PACKAGE_NAME.BASE],
+  )
+  logger('Modifying base config to custom config')
+
+  logger(`Uninstalling base package ${PACKAGE_NAME.BASE}`)
+  await runAgentCommand(
+    packageManager.agent,
+    'uninstall',
+    [PACKAGE_NAME.BASE],
+  )
+  logger(`Installing custom package ${PACKAGE_NAME.CUSTOM}`)
+  await runAgentCommand(
+    packageManager.agent,
+    'install',
+    ['-D', PACKAGE_NAME.CUSTOM],
+  )
+
+  logger('Updating package.json scripts')
+  const packageJsonPath = path.join(cwd, 'package.json')
+  /**
+   * @type {{ scripts: Record<string, string>, type?: "module" }}
+   */
+  const packageJson = JSON.parse(await readFile(packageJsonPath, 'utf8'))
+  packageJson.scripts = {
+    ...packageJson.scripts,
+    'lint': 'eslint .',
+    'lint:fix': 'eslint --fix .',
   }
-
-  const installCmd = resolveCommand(pm.agent, 'add', ['-D', SOURCE.name])
-  await runCommand(installCmd.command, installCmd.args)
-  console.info(`Installed ${SOURCE.name}`)
-
-  await runAntfuCLI()
-
-  console.info(`Start replacing the config from ${SOURCE.name} to ${TARGET.name}`)
-
-  const cwd = process.cwd()
-
-  const packageJSONPath = path.join(cwd, PACKAGE_JSON_FILE)
-
-  const package_ = await updateJSONFile(packageJSONPath, (packageData) => {
-    packageData.devDependencies = packageData.devDependencies || {}
-    delete packageData.devDependencies[SOURCE.name]
-
-    let targetVersion
-    try {
-      targetVersion = execSync(`npm view ${TARGET.name} dist-tags.latest`).toString().trim()
-    } catch (error) {
-      console.warn(
-        `Warning: Could not fetch latest version for ${TARGET.name}, using 'latest'. `
-        + `Error: ${error.message}`,
-      )
-      targetVersion = 'latest'
-    }
-    TARGET.version = targetVersion
-    packageData.devDependencies[TARGET.name] = targetVersion
-
-    packageData.scripts = {
-      ...packageData.scripts,
-      'lint': 'eslint .',
-      'lint:fix': 'eslint --fix .',
-    }
-
-    return packageData
+  await writeFile(packageJsonPath, JSON.stringify(packageJson, undefined, 2), 'utf8')
+
+  logger('Updating config file')
+  const configPath = path.join(cwd, `eslint.config.${packageJson.type === 'module' ? 'js' : 'mjs'}`)
+  await writeFile(configPath, `
+import mouse from '${PACKAGE_NAME.CUSTOM}'
+
+export default mouse()
+`.trim(), 'utf8')
+
+  logger('Linting the project to verify setup')
+  await runAgentCommand(
+    packageManager.agent,
+    'run',
+    ['lint:fix'],
+  ).catch((error) => {
+    logger(`Linting failed: ${error.message}`)
   })
-
-  const configExtension = package_.type === 'module' ? 'js' : 'mjs'
-  const eslintConfigFile = configExtension === 'js'
-    ? ESLINT_CONFIG_JS_FILE
-    : ESLINT_CONFIG_MJS_FILE
-  const configPath = path.join(cwd, eslintConfigFile)
-
-  let configContent = await fs.readFile(configPath, 'utf8')
-  configContent = configContent
-    .replace(
-      `import ${SOURCE.import} from '${SOURCE.name}'`,
-      `import ${TARGET.import} from '${TARGET.name}'`,
-    )
-    .replaceAll(new RegExp(`(?<!['"])${SOURCE.import}(?!['"])`, 'g'), TARGET.import)
-  await fs.writeFile(configPath, configContent)
-
-  const finalInstallCmd = resolveCommand(pm.agent, 'install', [])
-  await runCommand(finalInstallCmd.command, finalInstallCmd.args)
-
-  console.info(`Successfully replaced the config from ${SOURCE.name} to ${TARGET.name}`)
 }
 
 await main()
+console.info('---------------- Setup Complete ----------------')

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mouse_484/eslint-config",
   "type": "module",
-  "version": "5.4.0",
+  "version": "5.4.2",
   "author": "mouse_484",
   "license": "MIT",
   "homepage": "https://github.com/mouse484/config/tree/main/packages/eslint",

package/src/index.js

@@ -15,7 +15,6 @@ async function mouse(options, ...userConfigs) {
       allRecommended: true,
     },
     stylistic: true,
-    typescript: true,
     ...options,
   }
 
@@ -33,7 +32,12 @@ async function mouse(options, ...userConfigs) {
     ...tailwind(options),
   ]
 
-  return antfu(options, ...configs, ...userConfigs)
+  const normalizedOptions = {
+    ...options,
+    ignores: typeof options?.ignores === 'function' ? options.ignores([]) : options?.ignores,
+  }
+
+  return antfu(normalizedOptions, ...configs, ...userConfigs)
 }
 
 export default mouse