@foray1010/eslint-config 7.3.0 → 7.3.3

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [7.3.3](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@7.3.2...@foray1010/eslint-config@7.3.3) (2022-08-24)
+
+**Note:** Version bump only for package @foray1010/eslint-config
+
+## [7.3.2](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@7.3.1...@foray1010/eslint-config@7.3.2) (2022-08-24)
+
+### Bug Fixes
+
+- **eslint-config:** disable jsdoc/valid-types ([d1e4e17](https://github.com/foray1010/common-presets/commit/d1e4e17d097adecb3da790248b16a23cfdce34ff))
+- **eslint-config:** do not force react preset to use module ([477f15c](https://github.com/foray1010/common-presets/commit/477f15cd3f8ebdacbe3ab72aaa190054c1300610))
+- import eslint-config-prettier via plugin:prettier/recommended ([53b038b](https://github.com/foray1010/common-presets/commit/53b038bf5ab1f14d87edd4d230fd1f4aa4ae6232))
+- remove unused ignore patterns ([11d05bf](https://github.com/foray1010/common-presets/commit/11d05bf3e7cb001d1260f885089500e1ddf5fb02))
+
+## [7.3.1](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@7.3.0...@foray1010/eslint-config@7.3.1) (2022-07-28)
+
+### Bug Fixes
+
+- **eslint-config:** allow arrow function in object ([2b7549b](https://github.com/foray1010/common-presets/commit/2b7549ba63f8b9697300becb99504b736c833c23))
+
 ## [7.3.0](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@7.2.0...@foray1010/eslint-config@7.3.0) (2022-07-28)
 
 ### Features

package/README.md

@@ -18,18 +18,45 @@ Z for looser rules
 
 ## Installation
 
-1. `yarn add -DE eslint prettier @foray1010/eslint-config`
+1. `yarn add -DE @foray1010/eslint-config eslint prettier`
 
-1. Create an `.eslintrc.yml` in the project root
+1. Create an `.eslintrc.cjs` in the project root
 
-   ```yml
-   # for general purpose, support TypeScript
-   extends:
-     - '@foray1010/eslint-config'
+   For general purpose, support TypeScript
 
-   # for frontend React project, support TypeScript
-   extends:
-     - '@foray1010/eslint-config/react'
+   ```js
+   'use strict'
+
+   module.exports = {
+     root: true,
+     extends: ['@foray1010/eslint-config'],
+   }
+   ```
+
+   For frontend React projects, support TypeScript
+
+   ```js
+   'use strict'
+
+   module.exports = {
+     root: true,
+     extends: ['@foray1010/eslint-config/react'],
+   }
+   ```
+
+   For TS projects in monorepo, mark the `tsconfigRootDir` to use the correct `tsconfig.json`
+
+   ```js
+   'use strict'
+
+   module.exports = {
+     root: true,
+     extends: ['@foray1010/eslint-config'],
+     parserOptions: {
+       // Make sure the correct `tsconfig.json` is found in monorepo
+       tsconfigRootDir: __dirname,
+     },
+   }
    ```
 
 1. Use default eslintignore via npm script

package/eslintignore

@@ -4,4 +4,3 @@ build/
 coverage/
 dist/
 node_modules/
-out/

package/index.js

@@ -1,5 +1,6 @@
 'use strict'
 
+/** @type {import('eslint').Linter.Config} */
 module.exports = {
   extends: ['./presets/base.js', './presets/node.js'],
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@foray1010/eslint-config",
-  "version": "7.3.0",
+  "version": "7.3.3",
   "homepage": "https://github.com/foray1010/common-presets/tree/master/packages/eslint-config#readme",
   "bugs": "https://github.com/foray1010/common-presets/issues",
   "repository": {
@@ -19,8 +19,11 @@
     "*.md",
     "eslintignore"
   ],
+  "scripts": {
+    "type:check": "tsc"
+  },
   "dependencies": {
-    "@foray1010/common-presets-utils": "^5.0.1",
+    "@foray1010/common-presets-utils": "^5.0.2",
     "@typescript-eslint/eslint-plugin": "^5.13.0",
     "@typescript-eslint/parser": "^5.13.0",
     "confusing-browser-globals": "^1.0.10",
@@ -38,6 +41,11 @@
     "eslint-plugin-simple-import-sort": "^7.0.0",
     "eslint-plugin-testing-library": "^5.3.1"
   },
+  "devDependencies": {
+    "@types/confusing-browser-globals": "1.0.0",
+    "@types/eslint": "8.4.6",
+    "typescript": "4.7.4"
+  },
   "peerDependencies": {
     "eslint": "^8.0.0",
     "prettier": "^2.0.0"
@@ -48,5 +56,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1a8bec3ae717a3e1d87041091475f3346476b1a3"
+  "gitHead": "8f4681aea3421297bffa13e0bbbf7f6dba20ca70"
 }

package/presets/base.js

@@ -1,9 +1,11 @@
 'use strict'
 
+// @ts-expect-error
 const { hasDep, isESM } = require('@foray1010/common-presets-utils')
 
 const { testFileGlobs } = require('./utils/testUtil')
 
+/** @type {import('eslint').Linter.RulesRecord} */
 const esmRules = {
   'import/extensions': [
     'error',
@@ -12,14 +14,15 @@ const esmRules = {
   ],
 }
 
+/** @type {import('eslint').Linter.Config} */
 module.exports = {
   extends: [
     'eslint:recommended',
     'plugin:eslint-comments/recommended',
     'plugin:import/recommended',
     'plugin:jsdoc/recommended',
+    // included eslint-config-prettier
     'plugin:prettier/recommended',
-    'eslint-config-prettier',
   ],
   parserOptions: {
     ecmaVersion: 2020,
@@ -83,14 +86,10 @@ module.exports = {
     ],
     // do not enforce JSDoc for internal methods
     'jsdoc/require-jsdoc': 'off',
+    // does not work well with TypeScript https://github.com/gajus/eslint-plugin-jsdoc/issues/145
+    'jsdoc/valid-types': 'off',
     // avoid assigning anonymous function to object key which is harder to trace when debug
-    'object-shorthand': [
-      'error',
-      'always',
-      {
-        avoidExplicitReturnArrows: true,
-      },
-    ],
+    'object-shorthand': ['error', 'always'],
     // auto sort export statements
     'simple-import-sort/exports': 'error',
     // auto sort import statements
@@ -137,7 +136,8 @@ module.exports = {
               'plugin:@typescript-eslint/recommended',
               'plugin:@typescript-eslint/recommended-requiring-type-checking',
               'plugin:import/typescript',
-              'eslint-config-prettier',
+              // included eslint-config-prettier
+              'plugin:prettier/recommended',
             ],
             parser: '@typescript-eslint/parser',
             parserOptions: {

package/presets/browser.js

@@ -2,6 +2,7 @@
 
 const restrictedGlobals = require('confusing-browser-globals')
 
+/** @type {import('eslint').Linter.Config} */
 module.exports = {
   extends: ['plugin:compat/recommended'],
   plugins: ['eslint-plugin-compat'],

package/presets/node.js

@@ -1,5 +1,6 @@
 'use strict'
 
+/** @type {import('eslint').Linter.Config} */
 module.exports = {
   plugins: ['eslint-plugin-n'],
   env: {

package/presets/react.js

@@ -2,15 +2,16 @@
 
 const { testFileGlobs } = require('./utils/testUtil')
 
+/** @type {import('eslint').Linter.Config} */
 module.exports = {
   extends: [
     'plugin:react/recommended',
     'plugin:react/jsx-runtime',
     'plugin:react-hooks/recommended',
-    'eslint-config-prettier',
+    // included eslint-config-prettier
+    'plugin:prettier/recommended',
   ],
   parserOptions: {
-    sourceType: 'module',
     ecmaFeatures: {
       jsx: true,
     },

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "@foray1010/tsconfig",
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": true
+  }
+}