@mouse_484/eslint-config 5.4.1 → 5.4.3

package/README.md

@@ -2,7 +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:
 ```
 npx @mouse_484/eslint-config@latest
 ```
+
+## 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

@@ -24,6 +24,7 @@ function logger(message) {
  */
 function runAgentCommand(agent, command_, args_) {
   const { command, args } = resolveCommand(agent, command_, args_)
+  console.info(`Running command: ${command} ${args.join(' ')}`)
   return new Promise((resolve, reject) => {
     const child = spawn(
       command,
@@ -62,7 +63,7 @@ async function main() {
   await runAgentCommand(
     packageManager.agent,
     'execute',
-    [PACKAGE_NAME.BASE],
+    ['-y', `${PACKAGE_NAME.BASE}@latest`],
   )
   logger('Modifying base config to custom config')
 
@@ -110,5 +111,6 @@ export default mouse()
   })
 }
 
+console.info('---------------- Setting up @mouse_484/eslint-config ----------------')
 await main()
 console.info('---------------- Setup Complete ----------------')

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mouse_484/eslint-config",
   "type": "module",
-  "version": "5.4.1",
+  "version": "5.4.3",
   "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