Merge pull request #191 from demvsystems/keep-configs-simple-add-vue

Adding vue package and updating other packages

Author: unre4l

.gitignore

@@ -23,3 +23,4 @@ yarn-error.log*
 .env.production.local
 
 .eslintcache
+.idea

.npmrc

@@ -1,2 +1 @@
-strict-peer-dependencies=false
-engine-strict=true
+auto-install-peers=true

.nvmrc

@@ -0,0 +1 @@
+18

README.md

@@ -5,60 +5,114 @@
 ## Whats included?
 *the configuration is splitted into logical components so that you only have to include the things you need.*
 
-### liebe/base
-- eslint-config-airbnb-base
-- eslint-config-airbnb-typescript
-- eslint-import-resolver-typescript
-- eslint-plugin-eslint-comments
-- eslint-plugin-import
-- eslint-plugin-simple-import-sort
-- eslint-plugin-unicorn
-- eslint-plugin-promise
-- eslint-plugin-json
-- eslint-plugin-editorconfig
-
-### liebe/testing
-- eslint-plugin-jest
-
-### liebe/all
-- **Includes all the mentioned above**
+  - @eslint-config-liebe/eslint-config-base
+  - @eslint-config-liebe/eslint-config-jest
+  - @eslint-config-liebe/eslint-config-vitest
+  - @eslint-config-liebe/eslint-config-typescript
+  - @eslint-config-liebe/eslint-config-vue
+
 
 ## Installation
 In order to work around [a known limitation in ESLint](https://github.com/eslint/eslint/issues/3458), we recommend you to use this package alongside `@rushstack/eslint-patch`, so that you don't have to install too many dependencies:
 ```sh
-npm i -D eslint-config-liebe@latest @rushstack/eslint-patch
+npm i -D @rushstack/eslint-patch
+```
 
-or
+Eslint configs are installed with:
 
-yarn add -D eslint-config-liebe@latest @rushstack/eslint-patch
+```shell
+npm i -D @eslint-config-liebe/eslint-config-base
+npm i -D @eslint-config-liebe/eslint-config-jest
+npm i -D @eslint-config-liebe/eslint-config-vitest
+npm i -D @eslint-config-liebe/eslint-config-typescript
+npm i -D @eslint-config-liebe/eslint-config-vue
 ```
 
 ## Usage
 
-Include the configs you need in your .eslintrc:
+Include the configs you need in your `.eslintrc` and link your local `tsconfig.json` in case of typescript. The order is important!
 ```.eslintrc.js
 require("@rushstack/eslint-patch/modern-module-resolution")
 
 module.exports = {
   extends: [
-    'liebe/base',
-    'liebe/testing',
+    '@eslint-config-liebe/base',
+    // '@eslint-config-liebe/jest',
+    '@eslint-config-liebe/vitest',
+    '@eslint-config-liebe/typescript',
+    '@eslint-config-liebe/vue',
+  ],
+  root: true,
+  parserOptions: {
+    project: 'tsconfig.json',
+  },
+}
+```
+
+Extend a tsconfig from either
+- @eslint-config-liebe/eslint-config-typescript
+- @eslint-config-liebe/eslint-config-vue
+
+in your local `tsconfig.json`. `include`, `types`, `paths` and `baseUrl` are common properties which should be individually set.
+
+```tsconfig.json
+{
+  "extends": "./node_modules/@eslint-config-liebe/eslint-config-typescript/tsconfig.json",
+  "compilerOptions": {
+    "baseUrl": "./resources/js",
+    "paths": {
+      "@/*": [
+        "*"
+      ]
+    },
+    "types": [
+      "node",
+      "vitest/globals",
+      "vite/client",
+    ],
+  },
+  "include": [
+    "resources/mix/*.js",
+    "resources/js/**/*.js",
+    "resources/js/**/*.ts",
+    "resources/js/**/*.vue"
   ]
 }
+
 ```
 
-or just
+## Local development in other projects
 
-```.eslintrc.js
-require("@rushstack/eslint-patch/modern-module-resolution")
+[yalc](https://github.com/wclr/yalc) can add your current state of `eslint-config-liebe` in another project to be tested there.
 
-module.exports = {
-  extends: [
-    'liebe/all',
-  ]
-}
+In `eslint-config-liebe` project root run:
+
+```shell
+yalc publish package/base
+yalc publish package/jest
+yalc publish package/vitest
+yalc publish package/typescript
+yalc publish package/vue
+```
+
+In any local project root run to copy the package:
+
+```shell
+yalc add @eslint-config-liebe/[email protected]
+yalc add @eslint-config-liebe/[email protected]
+yalc add @eslint-config-liebe/[email protected]
+yalc add @eslint-config-liebe/[email protected]
+yalc add @eslint-config-liebe/[email protected]
 ```
 
+You may run to install the added packages' dependencies:
+
+```shell
+npm i # or similar
+```
+
+Instead of `yalc add` there is `yalc link` to add a symbolic link rather then copying the package files.
+
 ## Changelog
 Please look at [CHANGELOG](CHANGELOG.md) or [Releases](https://github.com/Tjark-Kuehl/eslint-config-liebe/releases) for information on what has changed recently.
 

package.json

@@ -41,7 +41,7 @@
     "commitlint": "17.6.3",
     "eslint": "8.40.0",
     "husky": "8.0.3",
-    "semantic-release": "^20",
+    "semantic-release": "^21.0.2",
     "semantic-release-monorepo": "7.0.5"
   },
   "packageManager": "[email protected]"

packages/base/rules/base.js renamed to packages/base/configs/base.js

@@ -6,23 +6,18 @@ module.exports = {
     // forces quotes around nearly everything, but keeps the option of writing numbers as object keys
     // https://eslint.org/docs/rules/quote-props
     'quote-props': ['error', 'consistent-as-needed', { keywords: false, unnecessary: true, numbers: false }],
-
     // disallow usage outside of loops for an easier unstanding of the code
     // https://eslint.org/docs/rules/no-plusplus
     'no-plusplus': ['error', { allowForLoopAfterthoughts: true }],
-
     // increases the max length of a line to 120 which seems more reasonable and ignores urls
     // https://eslint.org/docs/rules/max-len
-    'max-len': ['error', { code: 120, ignoreUrls: true }],
-
+    'max-len': ['error', { code: 120, ignoreUrls: true, ignorePattern: '^import .*' }],
     // this just seems to be a legacy rule, disable it to force good variable names
     // https://eslint.org/docs/rules/no-underscore-dangle
     'no-underscore-dangle': 'error',
-
     // disable because its handled by simple-import-sort
     // https://eslint.org/docs/rules/sort-imports
     'sort-imports': 'off',
-
     // assignments on function parameters seem to be a really bad practise as it can create weird behavior
     // we enabled it for commonly used names in Array.reduce() tho, so we can still write it in a short way
     // https://eslint.org/docs/rules/no-param-reassign
@@ -41,7 +36,6 @@ module.exports = {
         ],
       },
     ],
-
     // disallow declaration of variables that are not used in the code
     // https://eslint.org/docs/rules/no-unused-vars
     'no-unused-vars': [
@@ -52,24 +46,26 @@ module.exports = {
         ignoreRestSiblings: true,
       },
     ],
-
     // we dont want to disallow this rule because the code is way cleaner
     // however we would still advice to avoid this syntax
     // https://eslint.org/docs/rules/no-restricted-syntax
     'no-restricted-syntax': 'warn',
-
     // too restrictive, writing ugly code to defend against a very unlikely scenario
     // https://eslint.org/docs/rules/no-prototype-builtins
     'no-prototype-builtins': 'off',
-
     // use function hoisting to improve code readability
     // https://eslint.org/docs/rules/no-use-before-define
     'no-use-before-define': [
       'error',
       { functions: false, classes: true, variables: true },
     ],
-
     // https://eslint.org/docs/rules/no-continue
     'no-continue': 'off',
+    'object-curly-newline': ['error', {
+      ObjectExpression: { minProperties: 10, multiline: true, consistent: true },
+      ObjectPattern: { minProperties: 10, multiline: true, consistent: true },
+      ImportDeclaration: { minProperties: 10, multiline: true, consistent: true },
+      ExportDeclaration: { minProperties: 10, multiline: true, consistent: true },
+    }],
   },
 };

packages/base/configs/eslintComments.js

@@ -0,0 +1,15 @@
+module.exports = {
+  extends: [
+    'plugin:eslint-comments/recommended',
+  ],
+  rules: {
+    // Disabled as it's already covered by the `unicorn/no-abusive-eslint-disable` rule.
+    'eslint-comments/no-unlimited-disable': 'off',
+    'eslint-comments/disable-enable-pair': [
+      'error',
+      {
+        allowWholeFile: true,
+      },
+    ],
+  },
+};

packages/base/rules/import.js renamed to packages/base/configs/import.js

@@ -5,9 +5,7 @@ module.exports = {
   rules: {
     // disable because its handled by simple-import-sort
     'import/order': 'off',
-
     'import/no-anonymous-default-export': ['error', { allowObject: true }],
-
     'import/extensions': [
       'error',
       'never',
@@ -20,7 +18,6 @@ module.exports = {
         },
       },
     ],
-
     /**
      * We recommend you do not use the following rules, as TypeScript
      * provides the same checks as part of standard type checking
@@ -29,27 +26,15 @@ module.exports = {
      */
     'import/named': 'off',
     'import/no-named-as-default-member': 'off',
-
     // we agree with the opinion of basarat that the discoverability is poor
     // https://basarat.gitbook.io/typescript/main-1/defaultisbad
     'import/prefer-default-export': 'off',
     'import/no-default-export': 'error',
-
-    // we would prefer named exports over namespace exports
-    // TODO: extract into different config due to bad performance
-    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/namespace.md
+    // we would prefer named exports over namespace exports, disabled due to performance
     'import/namespace': 'off',
-
-    // forbid cyclical dependencies between modules
-    // TODO: extract into different config due to bad performance
+    // forbid cyclical dependencies between modules, disabled due to performance
     // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-cycle.md
-    'import/no-cycle': [
-      'off',
-      {
-        ignoreExternal: true,
-        maxDepth: '∞',
-      },
-    ],
+    'import/no-cycle': 'off',
   },
   overrides: [
     {