@foray1010/eslint-config 10.0.0 → 10.0.2

package/CHANGELOG.md

@@ -3,6 +3,19 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [10.0.2](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@10.0.1...@foray1010/eslint-config@10.0.2) (2023-03-23)
+
+### Bug Fixes
+
+- **eslint-config:** disable some eslint-plugin-import rules due to not support flat config ([3a84a7d](https://github.com/foray1010/common-presets/commit/3a84a7d10e0bdd8b81ce115ad509e46eee2330c5))
+
+## [10.0.1](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@10.0.0...@foray1010/eslint-config@10.0.1) (2023-03-23)
+
+### Bug Fixes
+
+- **eslint-config:** fix wrong assumption, `files` only does not filter ([661d0c6](https://github.com/foray1010/common-presets/commit/661d0c6bd05f688c8f6956fb26844e597c851dc4))
+- **eslint-config:** should not use ignores in config, and allow user defined ignores ([05b0ca0](https://github.com/foray1010/common-presets/commit/05b0ca09a76ed677c903b654cef3eeef7773610e))
+
 ## [10.0.0](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@9.2.0...@foray1010/eslint-config@10.0.0) (2023-03-23)
 
 ### ⚠ BREAKING CHANGES

package/README.md

@@ -26,16 +26,11 @@ Z for looser rules
 
      ```js
      import {
-       eslintFilesConfig,
        eslintIgnoresConfig,
        eslintNodeConfig,
      } from '@foray1010/eslint-config'
 
-     const config = [
-       ...eslintIgnoresConfig,
-       ...eslintFilesConfig,
-       ...eslintNodeConfig,
-     ]
+     const config = [...eslintIgnoresConfig, ...eslintNodeConfig]
      export default config
      ```
 
@@ -43,16 +38,11 @@ Z for looser rules
 
      ```js
      import {
-       eslintFilesConfig,
        eslintIgnoresConfig,
        eslintBrowserConfig,
      } from '@foray1010/eslint-config'
 
-     const config = [
-       ...eslintIgnoresConfig,
-       ...eslintFilesConfig,
-       ...eslintBrowserConfig,
-     ]
+     const config = [...eslintIgnoresConfig, ...eslintBrowserConfig]
      export default config
      ```
 
@@ -60,16 +50,11 @@ Z for looser rules
 
      ```js
      import {
-       eslintFilesConfig,
        eslintIgnoresConfig,
        eslintReactConfig,
      } from '@foray1010/eslint-config'
 
-     const config = [
-       ...eslintIgnoresConfig,
-       ...eslintFilesConfig,
-       ...eslintReactConfig,
-     ]
+     const config = [...eslintIgnoresConfig, ...eslintReactConfig]
      export default config
      ```
 
@@ -78,7 +63,6 @@ Z for looser rules
      ```js
      import {
        applyConfig,
-       eslintFilesConfig,
        eslintIgnoresConfig,
        eslintNodeConfig,
        eslintReactConfig,
@@ -86,10 +70,10 @@ Z for looser rules
 
      const config = [
        ...eslintIgnoresConfig,
-       ...eslintFilesConfig,
        ...applyConfig(
          {
-           ignorePrefixes: ['src'],
+           filePrefixes: '.',
+           ignores: ['src/**'],
          },
          eslintNodeConfig,
        ),

package/bases/base.mjs

@@ -12,7 +12,11 @@ import eslintPluginSimpleImportSort from 'eslint-plugin-simple-import-sort'
 import eslintPluginUnicorn from 'eslint-plugin-unicorn'
 import globals from 'globals'
 
-import { testFileGlobs, typeScriptFileGlobs } from '../constants.mjs'
+import {
+  testFileGlobs,
+  typeScriptFileGlobs,
+  typeScriptTestFileGlobs,
+} from '../constants.mjs'
 
 /** @type {import('eslint').Linter.FlatConfig} */
 const cjsConfig = {
@@ -139,6 +143,10 @@ const baseConfig = [
           noUselessIndex: false,
         },
       ],
+      // turn off these rules as they do not support flat config: https://github.com/import-js/eslint-plugin-import/issues/2556
+      'import/namespace': 'off',
+      'import/no-named-as-default': 'off',
+      'import/no-named-as-default-member': 'off',
       // prefer explicitly convert type for readability
       'no-implicit-coercion': 'error',
       // make sure private class members are in-use
@@ -354,8 +362,7 @@ const baseConfig = [
           },
         },
         {
-          files: typeScriptFileGlobs,
-          ignores: testFileGlobs.map((glob) => `!${glob}`),
+          files: typeScriptTestFileGlobs,
           plugins: {
             '@typescript-eslint': eslintPluginTypescriptEslint,
             jest: eslintPluginJest,

package/bases/prettier.mjs

@@ -1,5 +1,4 @@
 import eslintConfigPrettier from 'eslint-config-prettier'
-// eslint-disable-next-line import/namespace, import/no-named-as-default, import/no-named-as-default-member
 import eslintPluginPrettier from 'eslint-plugin-prettier'
 
 /** @type {import('eslint').Linter.FlatConfig[]} */

package/constants.mjs

@@ -1,8 +1,15 @@
+export const supportedFilesGlob = '**/*.{cjs,cts,js,mjs,mts,ts,tsx}'
 export const testFileGlobs = [
-  '**/__fixtures__/**',
-  '**/__mocks__/**',
-  '**/__tests__/**',
+  '**/__fixtures__/**/*.{cjs,cts,js,mjs,mts,ts,tsx}',
+  '**/__mocks__/**/*.{cjs,cts,js,mjs,mts,ts,tsx}',
+  '**/__tests__/**/*.{cjs,cts,js,mjs,mts,ts,tsx}',
   '**/*.{spec,test}.{cjs,cts,js,mjs,mts,ts,tsx}',
 ]
 
 export const typeScriptFileGlobs = ['**/*.{cts,mts,ts,tsx}']
+export const typeScriptTestFileGlobs = [
+  '**/__fixtures__/**/*.{cts,mts,ts,tsx}',
+  '**/__mocks__/**/*.{cts,mts,ts,tsx}',
+  '**/__tests__/**/*.{cts,mts,ts,tsx}',
+  '**/*.{spec,test}.{cts,mts,ts,tsx}',
+]

package/index.mjs

@@ -28,5 +28,4 @@ export const eslintReactConfig = [
   ...prettierConfig,
 ]
 
-export { default as eslintFilesConfig } from './bases/files.mjs'
 export { default as eslintIgnoresConfig } from './bases/ignores.mjs'

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@foray1010/eslint-config",
-  "version": "10.0.0",
+  "version": "10.0.2",
   "homepage": "https://github.com/foray1010/common-presets/tree/master/packages/eslint-config#readme",
   "bugs": "https://github.com/foray1010/common-presets/issues",
   "repository": {
@@ -22,7 +22,7 @@
   "dependencies": {
     "@eslint-community/eslint-plugin-eslint-comments": "^3.2.1",
     "@eslint/js": "^8.36.0",
-    "@foray1010/common-presets-utils": "^7.0.0",
+    "@foray1010/common-presets-utils": "^7.0.1",
     "@typescript-eslint/eslint-plugin": "^5.56.0",
     "@typescript-eslint/parser": "^5.56.0",
     "confusing-browser-globals": "^1.0.10",
@@ -58,5 +58,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "ee22f073ee1702354310091b7c3a5ec18a930bec"
+  "gitHead": "c532946a18c6a773dd05bb8be2c90e905181e165"
 }

package/utils/applyConfig.mjs

@@ -1,15 +1,22 @@
 import path from 'node:path'
 
+import { supportedFilesGlob } from '../constants.mjs'
+
 /**
  * Extend the flat configs with default files and ignores
  * @param {{
- *   readonly filePrefixes?: string[] | undefined,
- *   readonly ignorePrefixes?: string[] | undefined
+ *   readonly filePrefixes: string | string[],
+ *   readonly ignores?: string | string[] | undefined
  * }} options
  * @param {readonly import('eslint').Linter.FlatConfig[]} flatConfigs
  * @returns {readonly import('eslint').Linter.FlatConfig[]}
  */
 export function applyConfig(options, flatConfigs) {
+  const filePrefixes = [options.filePrefixes].flat()
+  if (filePrefixes.length === 0) {
+    throw new TypeError('filePrefixes must not be empty')
+  }
+
   // Do not allow string such as "eslint:recommended" because it cannot be overridden by files/ignores
   for (const config of flatConfigs) {
     if (typeof config === 'string') {
@@ -18,35 +25,29 @@ export function applyConfig(options, flatConfigs) {
       )
     }
 
-    const keys = Object.keys(config)
-    if (
-      keys.length === 1 &&
-      (keys.includes('files') || keys.includes('ignores'))
-    ) {
-      throw new TypeError('Do not use `files` or `ignores` only')
+    if (Object.keys(config).includes('ignores')) {
+      throw new TypeError('Do not use `ignores` in config')
     }
   }
 
   return flatConfigs.map((config) => {
-    const files = generateCombinations(options.filePrefixes, config.files)
-    const ignores = generateCombinations(options.ignorePrefixes, config.ignores)
+    const files = generateCombinations(filePrefixes, config.files)
     return {
       ...config,
       ...(files ? { files } : {}),
-      ...(ignores ? { ignores } : {}),
+      ...(options.ignores ? { ignores: options.ignores } : {}),
     }
   })
 }
 
 /**
- * @param {string[] | undefined} prefixes
+ * @param {string[]} prefixes
  * @param {string | string[] | undefined} originalGlobs
  * @returns {string | string[] | undefined}
  */
 function generateCombinations(prefixes, originalGlobs) {
-  if (!prefixes || prefixes.length === 0) return originalGlobs
   if (!originalGlobs || originalGlobs.length === 0) {
-    return prefixes.map((prefix) => path.join(prefix, '**'))
+    return prefixes.map((prefix) => path.join(prefix, supportedFilesGlob))
   }
 
   const originalGlobList = [originalGlobs].flat()

package/bases/files.mjs

@@ -1,8 +0,0 @@
-/** @type {readonly import('eslint').Linter.FlatConfig[]} */
-const filesConfig = [
-  {
-    // replace `eslint --ext=cjs,cts,js,mjs,mts,ts,tsx` in legacy config
-    files: ['**/*.{cjs,cts,js,mjs,mts,ts,tsx}'],
-  },
-]
-export default filesConfig