@planfredapp/eslint-config 1.0.51 → 1.0.53

package/README.md

@@ -1,129 +1,113 @@
-# planfred-eslint-config
+# @planfredapp/eslint-config
 
-Shared ESLint configurations for the Planfred monorepo.
+[![npm version](https://img.shields.io/npm/v/@planfredapp/eslint-config.svg)](https://www.npmjs.com/package/@planfredapp/eslint-config)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
 
-## Available Configurations
+Shared ESLint configurations for the Planfred monorepo. Uses ESLint 9 flat config format.
 
-### Base Configuration
+## Installation
 
-The base configuration includes common rules and plugins used across all projects:
-
-- Standard JavaScript rules
-- Import/export rules
-- Node.js specific rules
-- Promise handling rules
-- Stylistic rules
-
-### Vue Configuration
-
-Extends the base configuration with Vue.js specific rules:
-
-- Vue component rules
-- Template-specific styling rules
-- Component naming conventions
-- Vue-specific import path rules
-
-### Cypress Configuration
-
-Extends the base configuration with Cypress testing rules:
-
-- TypeScript support
-- Cypress-specific globals and rules
-- Test-specific linting rules
-
-### Test Configuration
+```bash
+npm install --save-dev @planfredapp/eslint-config eslint
+```
 
-Extends the base configuration with testing framework rules:
+## Configurations
 
-- Vitest support
-- Test-specific globals
-- Testing best practices
+| Config | Import Path | Description |
+|--------|-------------|-------------|
+| Base | `@planfredapp/eslint-config/base` | Core JS rules, imports, Node.js, stylistic |
+| Vue | `@planfredapp/eslint-config/vue` | Vue 3 components, extends base |
+| Cypress | `@planfredapp/eslint-config/cypress` | E2E tests with TypeScript |
+| Test | `@planfredapp/eslint-config/test` | Vitest unit tests |
 
 ## Usage
 
-### In ESLint Config Files
+Create `eslint.config.js` in your project root:
 
 ```javascript
-// For base configuration
+// Base config
 import baseConfig from '@planfredapp/eslint-config/base'
+export default [...baseConfig]
 
-export default [
-  ...baseConfig,
-  // your specific overrides
-]
-
-// For Vue projects
+// Vue project
 import vueConfig from '@planfredapp/eslint-config/vue'
+export default [...vueConfig]
 
+// With overrides
+import vueConfig from '@planfredapp/eslint-config/vue'
 export default [
   ...vueConfig,
-  // your specific overrides
+  {
+    rules: {
+      'no-console': 'warn',
+    },
+  },
 ]
+```
 
-// For Cypress tests
-import cypressConfig from '@planfredapp/eslint-config/cypress'
+## Included Plugins
 
-export default [
-  ...cypressConfig,
-  // your specific overrides
-]
+### Base Config
+- `@eslint/js` - ESLint recommended
+- `@stylistic/eslint-plugin` - Code formatting
+- `eslint-plugin-import` - Import/export validation
+- `eslint-plugin-n` - Node.js rules
+- `eslint-plugin-promise` - Promise handling
 
-// For test files
-import testConfig from '@planfredapp/eslint-config/test'
+### Vue Config
+- `eslint-plugin-vue` - Vue 3 rules
+- `eslint-plugin-no-relative-import-paths` - Enforce `@/` imports
 
-export default [
-  ...testConfig,
-  // your specific overrides
-]
-```
+### Cypress Config
+- `eslint-plugin-cypress` - Cypress globals and best practices
+- `typescript-eslint` - TypeScript support
 
-### Package.json Dependencies
+### Test Config
+- `@vitest/eslint-plugin` - Vitest globals and rules
+- `eslint-plugin-no-only-tests` - Prevent `.only()` in CI
 
-Add the shared config as a dependency in your package.json:
+## Key Rules
 
-```json
-{
-  "devDependencies": {
-    "@planfredapp/eslint-config": "^1.0.12"
-  }
-}
-```
+### Stylistic
+- 2-space indentation
+- Single quotes, no semicolons
+- Trailing commas in multiline
+- Spaces inside brackets: `[ 'a', 'b' ]`
+- Newlines for arrays/objects with 2+ items
+- Blank lines between statements
 
-Or install directly with npm:
+### Imports
+- Alphabetized, grouped by type
+- Newlines between groups
+- No relative paths in Vue (use `@/`)
 
-```bash
-npm install --save-dev @planfredapp/eslint-config
-```
+### Vue-Specific
+- Template-first block order
+- Component name matching filename
+- No unused refs/props/emits
+- PascalCase component names in templates
 
-### Available Versions
-
-You can install specific versions:
+## Peer Dependencies
 
 ```json
 {
-  "devDependencies": {
-    "@planfredapp/eslint-config": "1.0.12"
-  }
+  "eslint": "9.0.0"
 }
 ```
 
-Or use the latest version:
+## Files
 
-```json
-{
-  "devDependencies": {
-    "@planfredapp/eslint-config": "latest"
-  }
-}
+```
+base.js     - Core configuration
+vue.js      - Vue.js (extends base)
+cypress.js  - Cypress E2E (extends base)
+test.js     - Vitest unit tests (extends base)
 ```
 
-## Configuration Structure
+## Changelog
 
-The shared configurations are organized as follows:
+See [CHANGELOG.md](CHANGELOG.md) for version history.
 
-- `base.js` - Core configuration with common rules
-- `vue.js` - Vue.js specific configuration extending base
-- `cypress.js` - Cypress testing configuration extending base
-- `test.js` - General testing configuration extending base
+## License
 
-Each configuration can be extended and overridden as needed in individual projects.
+[MIT](LICENSE)

package/base.js

@@ -49,7 +49,7 @@ export default [
       camelcase: [
         'error',
         {
-          allow: ['^UNSAFE_'],
+          allow: [ '^UNSAFE_' ],
           properties: 'never',
           ignoreGlobals: true,
         },
@@ -311,12 +311,12 @@ export default [
         },
       ],
       'stylistic/arrow-parens': 'off',
-      'stylistic/template-curly-spacing': ['off'],
+      'stylistic/template-curly-spacing': [ 'off' ],
 
       // standard style rules
       'stylistic/array-bracket-spacing': [
         'error',
-        'never',
+        'always',
       ],
       'stylistic/arrow-spacing': [
         'error',
@@ -644,7 +644,7 @@ export default [
               '::',
               'flow-include',
             ],
-            exceptions: ['*'],
+            exceptions: [ '*' ],
           },
         },
       ],

package/eslint.config.js

@@ -3,7 +3,7 @@ import baseConfig from './base.js'
 export default [
   ...baseConfig,
   {
-    files: ['**/*.js'],
+    files: [ '**/*.js' ],
     ignores: [
       'node_modules/**',
       'dist/**',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planfredapp/eslint-config",
-  "version": "1.0.51",
+  "version": "1.0.53",
   "description": "Shared ESLint configurations for Planfred monorepo",
   "keywords": [
     "eslint",
@@ -65,7 +65,7 @@
     "vue-eslint-parser": "10.2.0"
   },
   "peerDependencies": {
-    "eslint": "9.0.0"
+    "eslint": ">=9.0.0"
   },
   "overrides": {
     "js-yaml": "4.1.1"

package/vue.js

@@ -13,7 +13,7 @@ export default [
     },
     rules: {
       // vue rules
-      'vue/padding-lines-in-component-definition': ['error'],
+      'vue/padding-lines-in-component-definition': [ 'error' ],
       'vue/padding-line-between-blocks': 'error',
       'vue/padding-line-between-tags': [
         'error',
@@ -92,7 +92,7 @@ export default [
         { ArrayExpression: 'consistent' },
       ],
       'vue/arrow-parens': 'off',
-      'vue/template-curly-spacing': ['off'],
+      'vue/template-curly-spacing': [ 'off' ],
 
       // extensions of stylistic rules applied to the template tag
       'vue/array-bracket-spacing': [
@@ -201,12 +201,12 @@ export default [
   },
   {
     // IMPORTANT: These rules should be only applied to components, not pages. That's why we filter the files here
-    files: ['src/components/**/*'],
+    files: [ 'src/components/**/*' ],
     rules: {
       'vue/match-component-file-name': [
         'error',
         {
-          extensions: ['vue'],
+          extensions: [ 'vue' ],
           shouldMatchCase: true,
         },
       ],
@@ -214,7 +214,7 @@ export default [
     },
   },
   {
-    files: ['src/**/*'], // exclude files from root folder
+    files: [ 'src/**/*' ], // exclude files from root folder
     plugins: {
       noRelativeImportPathsPlugin,
     },