@ivanmaxlogiudice/eslint-config 0.1.10 → 1.0.0-beta.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Iván Lo Giudice
+Copyright (c) 2022-PRESENT Iván M. Lo Giudice<https://github.com/ivanmaxlogiudice>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/README.md

@@ -1,28 +1,42 @@
-# ESLint Config
+# @ivanmaxlogiudice/eslint-config [![npm (scoped with tag)](https://flat.badgen.net/npm/v/@ivanmaxlogiudice/eslint-config)](https://npmjs.com/package/@ivanmaxlogiudice/eslint-config) [![npm](https://flat.badgen.net/npm/dt/@ivanmaxlogiudice/eslint-config)](https://npmjs.com/package/@ivanmaxlogiudice/eslint-config) #
 
-[![npm (scoped with tag)](https://flat.badgen.net/npm/v/@ivanmaxlogiudice/eslint-config)](https://npmjs.com/package/@ivanmaxlogiudice/eslint-config)
-[![npm](https://flat.badgen.net/npm/dt/@ivanmaxlogiudice/eslint-config)](https://npmjs.com/package/@ivanmaxlogiudice/eslint-config)
+Personal Flat ESLint configuration for Javascript, TypeScript, Vue 2, Vue 3.
 
-Personal ESLint configuration
+based on [@sxzz/eslint-config](https://github.com/sxzz/eslint-config)
 
-## Getting Started
+## Features
+- Single quotes, no semi
+- Auto fix for formatting (aimed to be used standalone without Prettier)
+- Designed to work with TypeScript, Vue 2 & 3 out-of-box
+- Lint also for json, yaml, markdown
+- Sorted imports, dangling commas
+- Reasonable defaults, best practices, only one-line of config
 
-1. Add the package to your devDependencies
+## Install
 ```bash
-$ pnpm add -D eslint @ivanmaxlogiudice/eslint-config
+pnpm add -D @ivanmaxlogiudice/eslint-config
 ```
 
-2. Create a `.eslintrc` file
-```bash
-{
-    "extends": ["@ivanmaxlogiudice/eslint-config"]
-}
+## Usage
+```js
+// eslint.config.js
+import { all } from '@ivanmaxlogiudice/eslint-config'
+
+export default defineFlatConfig(all)
 ```
 
-## TypeScript
+### Custom Config
 
-If you're using TypeScript, follow [Getting Started](https://github.com/ivanlogiudice/eslint-config/tree/main/packages/eslint-config-ts#getting-started).
+```js
+import { config } from '@ivanmaxlogiudice/eslint-config'
+export default config(
+  [
+    /* your custom config */
+  ],
+  { vue: true, markdown: true }
+)
+```
 
-## Vue 3 with TS
+## License
 
-If you're using Vue 3, follow [Getting Started](https://github.com/ivanlogiudice/eslint-config/tree/main/packages/eslint-config-vue#getting-started).
+[MIT](./LICENSE) License © 2022-PRESENT [Iván M. Lo Giudice](https://github.com/ivanmaxlogiudice)

package/index.js

@@ -1,414 +1,9 @@
-module.exports = {
-    env: {
-        es6: true,
-        node: true,
-        browser: true,
-    },
-    reportUnusedDisableDirectives: true,
-    extends: [
-        'standard',
-        'plugin:import/recommended',
-        'plugin:eslint-comments/recommended',
-        'plugin:jsonc/recommended-with-jsonc',
-        'plugin:yml/standard',
-        'plugin:markdown/recommended',
-    ],
-    ignorePatterns: [
-        '*.min.*',
-        '*.d.ts',
-        'CHANGELOG.md',
-        'dist',
-        'LICENSE*',
-        'output',
-        'out',
-        'coverage',
-        'public',
-        'temp',
-        'package-lock.json',
-        'pnpm-lock.yaml',
-        'yarn.lock',
-        '__snapshots__',
-        // ignore for in lint-staged
-        '*.css',
-        '*.png',
-        '*.ico',
-        '*.toml',
-        '*.patch',
-        '*.txt',
-        '*.crt',
-        '*.key',
-        'Dockerfile',
-        // force include
-        '!.github',
-        '!.vitepress',
-        '!.vscode',
-        // force exclude
-        '.vitepress/cache',
-    ],
-    plugins: [
-        'html',
-        'unicorn',
-        'antfu',
-        'no-only-tests',
-        'unused-imports',
-    ],
-    settings: {
-        'import/resolver': {
-            node: { extensions: ['.js', '.mjs'] },
-        },
-    },
-    overrides: [
-        {
-            files: ['*.json', '*.json5', '*.jsonc'],
-            parser: 'jsonc-eslint-parser',
-            rules: {
-                'jsonc/array-bracket-spacing': ['error', 'never'],
-                'jsonc/comma-dangle': ['error', 'never'],
-                'jsonc/comma-style': ['error', 'last'],
-                'jsonc/indent': ['error', 4],
-                'jsonc/key-spacing': ['error', { beforeColon: false, afterColon: true }],
-                'jsonc/no-octal-escape': 'error',
-                'jsonc/object-curly-newline': ['error', { multiline: true, consistent: true }],
-                'jsonc/object-curly-spacing': ['error', 'always'],
-                'jsonc/object-property-newline': ['error', { allowMultiplePropertiesPerLine: true }],
-            },
-        },
-        {
-            files: ['*.yaml', '*.yml'],
-            parser: 'yaml-eslint-parser',
-            rules: {
-                'spaced-comment': 'off',
-            },
-        },
-        {
-            files: ['package.json'],
-            parser: 'jsonc-eslint-parser',
-            rules: {
-                'jsonc/sort-keys': [
-                    'error',
-                    {
-                        pathPattern: '^$',
-                        order: [
-                            'publisher',
-                            'name',
-                            'displayName',
-                            'type',
-                            'version',
-                            'private',
-                            'packageManager',
-                            'description',
-                            'author',
-                            'license',
-                            'funding',
-                            'homepage',
-                            'repository',
-                            'bugs',
-                            'keywords',
-                            'categories',
-                            'sideEffects',
-                            'exports',
-                            'main',
-                            'module',
-                            'unpkg',
-                            'jsdelivr',
-                            'types',
-                            'typesVersions',
-                            'bin',
-                            'icon',
-                            'files',
-                            'engines',
-                            'activationEvents',
-                            'contributes',
-                            'scripts',
-                            'peerDependencies',
-                            'peerDependenciesMeta',
-                            'dependencies',
-                            'optionalDependencies',
-                            'devDependencies',
-                            'pnpm',
-                            'overrides',
-                            'resolutions',
-                            'husky',
-                            'simple-git-hooks',
-                            'lint-staged',
-                            'eslintConfig',
-                        ],
-                    },
-                    {
-                        pathPattern: '^(?:dev|peer|optional|bundled)?[Dd]ependencies$',
-                        order: { type: 'asc' },
-                    },
-                    {
-                        pathPattern: '^exports.*$',
-                        order: [
-                            'types',
-                            'require',
-                            'import',
-                        ],
-                    },
-                ],
-            },
-        },
-        {
-            files: ['*.d.ts'],
-            rules: {
-                'import/no-duplicates': 'off',
-            },
-        },
-        {
-            files: ['*.js', '*.cjs', '*.jsx'],
-            rules: {
-                '@typescript-eslint/no-var-requires': 'off',
-                '@typescript-eslint/no-require-imports': 'off',
-            },
-        },
-        {
-            files: ['*.ts', '*.tsx', '*.mts', '*.cts'],
-            rules: {
-                'no-void': ['error', { allowAsStatement: true }],
-            },
-        },
-        {
-            files: ['scripts/**/*.*', 'cli.*'],
-            rules: {
-                'no-console': 'off',
-            },
-        },
-        {
-            files: ['*.test.ts', '*.test.js', '*.spec.ts', '*.spec.js'],
-            rules: {
-                'no-unused-expressions': 'off',
-                'no-only-tests/no-only-tests': 'error',
-            },
-        },
-        {
-            // Code blocks in markdown file
-            files: ['**/*.md/*.*'],
-            rules: {
-                '@typescript-eslint/no-redeclare': 'off',
-                '@typescript-eslint/no-unused-vars': 'off',
-                '@typescript-eslint/no-use-before-define': 'off',
-                '@typescript-eslint/no-var-requires': 'off',
-                '@typescript-eslint/comma-dangle': 'off',
-                '@typescript-eslint/consistent-type-imports': 'off',
-                '@typescript-eslint/no-namespace': 'off',
-                '@typescript-eslint/no-require-imports': 'off',
-                'import/no-unresolved': 'off',
-                'no-alert': 'off',
-                'no-console': 'off',
-                'no-restricted-imports': 'off',
-                'unused-imports/no-unused-imports': 'off',
-                'unused-imports/no-unused-vars': 'off',
-                'no-undef': 'off',
-                'no-unused-expressions': 'off',
-                'no-unused-vars': 'off',
-                'antfu/no-cjs-exports': 'off',
-                'antfu/no-ts-export-equal': 'off',
-            },
-        },
-    ],
-    rules: {
-        // import
-        'import/order': 'error',
-        'import/first': 'error',
-        'import/no-mutable-exports': 'error',
-        'import/no-unresolved': 'off',
-        'import/no-absolute-path': 'off',
-        'import/no-named-as-default-member': 'off',
-        'import/no-named-as-default': 'off',
-        'import/namespace': 'off',
-        'import/newline-after-import': ['error', { count: 1, considerComments: true }],
-
-        // unused imports
-        'unused-imports/no-unused-imports': 'error',
-        'unused-imports/no-unused-vars': [
-            'warn',
-            {
-                vars: 'all',
-                varsIgnorePattern: '^_',
-                args: 'after-used',
-                argsIgnorePattern: '^_',
-            },
-        ],
-
-        // Common
-        'semi': ['error', 'never'],
-        'curly': ['error', 'multi-or-nest', 'consistent'],
-        'quotes': ['error', 'single', { avoidEscape: true }],
-        'quote-props': ['error', 'consistent-as-needed'],
-        'no-unused-vars': 'warn',
-        'no-param-reassign': 'off',
-        'array-bracket-spacing': ['error', 'never'],
-        'brace-style': ['error', 'stroustrup', { allowSingleLine: true }],
-        'block-spacing': ['error', 'always'],
-        'camelcase': 'off',
-        'comma-spacing': ['error', { before: false, after: true }],
-        'comma-style': ['error', 'last'],
-        'comma-dangle': ['error', 'always-multiline'],
-        'no-constant-condition': 'warn',
-        'no-debugger': 'error',
-        'no-console': ['error', { allow: ['warn', 'error'] }],
-        'no-cond-assign': ['error', 'always'],
-        'func-call-spacing': ['error', 'never'],
-        'key-spacing': ['error', { beforeColon: false, afterColon: true }],
-        'indent': ['error', 4, { SwitchCase: 1, VariableDeclarator: 1, outerIIFEBody: 1 }],
-        'no-restricted-syntax': ['error', 'DebuggerStatement', 'LabeledStatement', 'WithStatement'],
-        'object-curly-spacing': ['error', 'always'],
-        'no-return-await': 'off',
-        'space-before-function-paren': [
-            'error',
-            {
-                anonymous: 'always',
-                named: 'never',
-                asyncArrow: 'always',
-            },
-        ],
-        'no-use-before-define': ['error', { functions: false, classes: false, variables: true }],
-        'no-restricted-globals': [
-            'error',
-            { name: 'global', message: 'Use `globalThis` instead.' },
-            { name: 'self', message: 'Use `globalThis` instead.' },
-        ],
-        'no-restricted-properties': [
-            'error',
-            { property: '__proto__', message: 'Use `Object.getPrototypeOf` or `Object.setPrototypeOf` instead.' },
-            { property: '__defineGetter__', message: 'Use `Object.defineProperty` instead.' },
-            { property: '__defineSetter__', message: 'Use `Object.defineProperty` instead.' },
-            { property: '__lookupGetter__', message: 'Use `Object.getOwnPropertyDescriptor` instead.' },
-            { property: '__lookupSetter__', message: 'Use `Object.getOwnPropertyDescriptor` instead.' },
-        ],
-
-        // ES6
-        'no-var': 'error',
-        'prefer-const': [
-            'error',
-            {
-                destructuring: 'all',
-                ignoreReadBeforeAssign: true,
-            },
-        ],
-        'prefer-arrow-callback': [
-            'error',
-            {
-                allowNamedFunctions: false,
-                allowUnboundThis: true,
-            },
-        ],
-        'object-shorthand': [
-            'error',
-            'always',
-            {
-                ignoreConstructors: false,
-                avoidQuotes: true,
-            },
-        ],
-        'prefer-exponentiation-operator': 'error',
-        'prefer-rest-params': 'error',
-        'prefer-spread': 'error',
-        'prefer-template': 'error',
-        'template-curly-spacing': 'error',
-        'arrow-parens': ['error', 'as-needed', { requireForBlockBody: true }],
-        'generator-star-spacing': 'off',
-        'spaced-comment': ['error', 'always', {
-            line: {
-                markers: ['/'],
-                exceptions: ['/', '#'],
-            },
-            block: {
-                markers: ['!'],
-                exceptions: ['*'],
-                balanced: true,
-            },
-        }],
-
-        // Best Practice
-        'array-callback-return': 'error',
-        'block-scoped-var': 'error',
-        'consistent-return': 'off',
-        'complexity': 'off',
-        'eqeqeq': ['error', 'smart'],
-        'no-alert': 'warn',
-        'no-case-declarations': 'error',
-        'no-multi-spaces': 'error',
-        'no-multi-str': 'error',
-        'no-with': 'error',
-        'no-void': 'error',
-        'no-useless-escape': 'off',
-        'no-invalid-this': 'error',
-        'vars-on-top': 'error',
-        'require-await': 'off',
-        'no-return-assign': 'off',
-        'operator-linebreak': ['error', 'before'],
-        'max-statements-per-line': ['error', { max: 1 }],
-
-        // unicorns
-        // Pass error message when throwing errors
-        'unicorn/error-message': 'error',
-        // Uppercase regex escapes
-        'unicorn/escape-case': 'error',
-        // Array.isArray instead of instanceof
-        'unicorn/no-instanceof-array': 'error',
-        // Prevent deprecated `new Buffer()`
-        'unicorn/no-new-buffer': 'error',
-        // Keep regex literals safe!
-        'unicorn/no-unsafe-regex': 'off',
-        // Lowercase number formatting for octal, hex, binary (0x1'error' instead of 0X1'error')
-        'unicorn/number-literal-case': 'error',
-        // includes over indexOf when checking for existence
-        'unicorn/prefer-includes': 'error',
-        // String methods startsWith/endsWith instead of more complicated stuff
-        'unicorn/prefer-string-starts-ends-with': 'error',
-        // textContent instead of innerText
-        'unicorn/prefer-text-content': 'error',
-        // Enforce throwing type error when throwing error while checking typeof
-        'unicorn/prefer-type-error': 'error',
-        // Use new when throwing error
-        'unicorn/throw-new-error': 'error',
-        // Enforce consistent brace style for case clauses
-        'unicorn/switch-case-braces': 'error',
-        // Disallow awaiting non-promise values
-        'unicorn/no-unnecessary-await': 'error',
-        // Prefer using a logical operator over a ternary
-        'unicorn/prefer-logical-operator-over-ternary': 'error',
-        // Prefer using the node: protocol when importing Node.js builtin modules
-        'unicorn/prefer-node-protocol': 'error',
-        // Prefer using number properties like `Number.isNaN` rather than `isNaN`
-        'unicorn/prefer-number-properties': 'error',
-
-        'eslint-comments/disable-enable-pair': 'off',
-
-        // Enforce Node.js-style error-first callback pattern is followed
-        'n/prefer-global/buffer': ['error', 'never'],
-        'n/no-callback-literal': 'off',
-
-        'sort-imports': [
-            'error',
-            {
-                ignoreCase: false,
-                ignoreDeclarationSort: true,
-                ignoreMemberSort: false,
-                memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single'],
-                allowSeparatedGroups: false,
-            },
-        ],
-
-        // yml
-        'yml/quotes': ['error', { prefer: 'single', avoidEscape: false }],
-        'yml/no-empty-document': 'off',
-
-        // antfu
-        'antfu/if-newline': 'error',
-        'antfu/import-dedupe': 'error',
-
-        // standard
-        // fix until https://github.com/standard/eslint-config-standard/pull/263 is accepted
-        'no-mixed-operators': ['error', {
-            groups: [
-                ['==', '!=', '===', '!==', '>', '>=', '<', '<='],
-                ['&&', '||', '?:'],
-                ['in', 'instanceof'],
-            ],
-            allowSamePrecedence: true,
-        }],
-    },
-}
+export * from './src/eslint-comments.js'
+export * from './src/js.js'
+export * from './src/jsonc.js'
+export * from './src/markdown.js'
+export * from './src/presets.js'
+export * from './src/shared.js'
+export * from './src/typescript.js'
+export * from './src/vue.js'
+export * from './src/yml.js'

package/package.json

@@ -1,52 +1,70 @@
 {
   "name": "@ivanmaxlogiudice/eslint-config",
-  "version": "0.1.10",
-  "description": "Personal ESLint configuration",
-  "author": "Iván Máximiliano, Lo Giudice <ivanmaxlogiudice@gmail.com>",
+  "version": "1.0.0-beta.0",
+  "packageManager": "pnpm@8.6.2",
+  "description": "Personal ESLint config",
+  "type": "module",
   "license": "MIT",
-  "homepage": "https://ivanmaxlogiudice.com/",
+  "homepage": "https://github.com/ivanmaxlogiudice/eslint-config#readme",
+  "bugs": {
+    "url": "https://github.com/ivanmaxlogiudice/eslint-config/issues"
+  },
   "repository": {
     "type": "git",
-    "url": "https://github.com/ivanlogiudice/eslint-config.git",
-    "directory": "packages/eslint-config"
-  },
-  "bugs": {
-    "url": "https://github.com/ivanlogiudice/eslint-config/issues"
+    "url": "git+https://github.com/ivanmaxlogiudice/eslint-config.git"
   },
-  "keywords": [
-    "eslint",
-    "config",
-    "javascript",
-    "js"
-  ],
   "files": [
-    "index.js"
+    "index.js",
+    "src"
   ],
+  "main": "./index.js",
+  "module": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    "types": "./index.d.ts",
+    "require": "./index.js",
+    "import": "./index.js"
+  },
   "publishConfig": {
     "access": "public"
   },
   "peerDependencies": {
-    "eslint": ">=8.37.0"
+    "eslint": "^8.0.0"
   },
   "dependencies": {
+    "@eslint/js": "^8.43.0",
+    "@typescript-eslint/eslint-plugin": "^5.59.11",
+    "@typescript-eslint/parser": "^5.59.11",
     "eslint-config-standard": "^17.1.0",
+    "eslint-define-config": "^1.20.0",
     "eslint-plugin-antfu": "^0.39.5",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-html": "^7.1.0",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jsonc": "^2.8.0",
+    "eslint-plugin-jsonc": "^2.9.0",
     "eslint-plugin-markdown": "^3.0.0",
     "eslint-plugin-n": "^16.0.0",
     "eslint-plugin-no-only-tests": "^3.1.0",
-    "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-unicorn": "^47.0.0",
     "eslint-plugin-unused-imports": "^2.0.0",
-    "eslint-plugin-yml": "^1.7.0",
+    "eslint-plugin-vue": "^9.14.1",
+    "eslint-plugin-yml": "^1.8.0",
+    "globals": "^13.20.0",
     "jsonc-eslint-parser": "^2.3.0",
+    "local-pkg": "^0.4.3",
+    "vue-eslint-parser": "^9.3.1",
     "yaml-eslint-parser": "^1.2.2"
   },
   "devDependencies": {
-    "eslint": "^8.42.0",
+    "@types/node": "^20.3.1",
+    "bumpp": "^9.1.1",
+    "eslint": "^8.43.0",
     "typescript": "^5.1.3"
+  },
+  "engines": {
+    "node": ">=16.14.0"
+  },
+  "scripts": {
+    "lint": "eslint . --fix",
+    "release": "bumpp && pnpm publish"
   }
 }

package/src/eslint-comments.js

@@ -0,0 +1,17 @@
+import commentsPlugin from 'eslint-plugin-eslint-comments'
+
+/** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+export const eslintComments = [
+    {
+        plugins: {
+            'eslint-comments': commentsPlugin,
+        },
+        rules: {
+            ...commentsPlugin.configs.recommended.rules,
+            
+            'eslint-comments/disable-enable-pair': ['error', { 
+                allowWholeFile: true, 
+            }],
+        },
+    },
+]