eslint-config-beslogic 5.2.2 → 5.2.3

package/CHANGELOG.md

@@ -1,8 +1,14 @@
 # Changelog
 
+## 5.2.3
+
+- `unicorn/prevent-abbreviations` in `react` preset allow "Prop" abbreviation to allow "PropTypes" constants
+- Added `"incremental": true` and `"strictNullChecks": true` to shared `tsconfig.json`
+- Fixed type-checking issues in source so that pure-JS projects with `"checkJs": true` don't fail type-checking
+
 ## 5.2.2
 
-- Don't sort alphabetically by default in `@stylistic/jsx-sort-props`
+- Don't sort alphabetically in `@stylistic/jsx-sort-props` in non-extra-strict preset
 
 ## 5.2.1
 

package/angular.mjs

@@ -21,7 +21,11 @@ const typescriptVersion = getModuleVersion("typescript", 99)
 const typeDeclarationOverride = beslogicTypeScript.find(
   config => config.name === "beslogic/typescript/type-declaration"
 )
+if (!typeDeclarationOverride) {
+  throw new TypeError("beslogic/typescript/type-declaration config not found in typescript.mjs")
+}
 
+/** @type {[import('@eslint/core').Severity, ...(string | { selector: string, message: string })[]]} */
 export const noRestrictedSyntax = [
   ...noRestrictedSyntaxJS,
   // TODO: Possibly implement that ourselves?

package/extra-strict.mjs

@@ -32,11 +32,12 @@ export const explicitModuleBoundaryType = [
   }
 ]
 
+/** @type {[import('@eslint/core').Severity, ...(string | { selector: string, message: string })[]]} */
 export const noRestrictedSyntax = [
   ...noRestrictedSyntaxTS,
   // TODO: This would really be better as its own rule.
   // My understanding is that it only negatively affects published libs,
-  // and even then there's way o work around it.
+  // and even then there's ways to work around it.
   // Ban `const` enums: https://typescript-eslint.io/troubleshooting/faqs/general/#how-can-i-ban-specific-language-feature
   {
     "selector": "TSEnumDeclaration[const=true]",
@@ -53,10 +54,13 @@ export default defineConfig(
       "**/*.tsx"
     ],
     "rules": {
-      "@stylistic/jsx-sort-props": ["error", {
-        ...jsxSortPropsConfig,
-        "noSortAlphabetically": false
-      }],
+      "@stylistic/jsx-sort-props": [
+        "error",
+        {
+          ...jsxSortPropsConfig,
+          "noSortAlphabetically": false
+        }
+      ],
 
       // This is caught when noImplicitThis is enabled, which we assume in this config
       // https://typescript-eslint.io/rules/no-invalid-this/

package/javascript.mjs

@@ -33,6 +33,7 @@ export const restrictedGlobals = [
   }
 ]
 
+/** @type {[import('@eslint/core').Severity, ...(string | { selector: string, message: string })[]]} */
 export const noRestrictedSyntax = [
   "error",
   "WithStatement",
@@ -88,6 +89,8 @@ export const noMagicNumbersConfig = {
     }
     : {}
 }
+
+/** @type {[import('@eslint/core').Severity, Record<string, string | boolean>]} */
 export const noUnusedVariables = [
   "error",
   {
@@ -101,6 +104,7 @@ export const noUnusedVariables = [
 ]
 // Same as S00107
 // Projects with dependency Injection (Angular) also need more params in their constructor
+/** @type {[import('@eslint/core').Severity, { max: number }]} */
 export const maxParams = [
   "error",
   { "max": 7 }
@@ -207,6 +211,9 @@ export default defineConfig(
   sonarjs.configs.recommended,
   eslintPluginUnicorn.configs["flat/all"],
   regexp.configs["flat/recommended"],
+  // @ts-ignore
+  // - https://github.com/un-ts/eslint-plugin-import-x/issues/439
+  // - https://github.com/typescript-eslint/typescript-eslint/issues/11543
   importX.flatConfigs.recommended,
   comments.recommended,
   {

package/lib/utils.mjs

@@ -31,16 +31,16 @@ export const resolveModuleLocation = (/** @type {string} */ nodeModule) => {
 }
 
 export const jestNoRestrictedSyntax = (
-  /** @type {(string | number | { selector: string; })[]} */ noRestrictedSyntax
-) =>
-  noRestrictedSyntax.filter(
-    entry =>
-      typeof entry === "number"
-      || typeof entry === "string"
-      // Exclude from jest tests for compatibility with
-      // `jest/valid-describe-callback` and `jest/no-test-return-statement`
-      || !entry.selector.startsWith("ArrowFunctionExpression")
-  )
+  /** @type {readonly (number | string | {readonly selector: string})[]} */ noRestrictedSyntax
+  // eslint-disable-next-line @stylistic/no-extra-parens -- https://github.com/eslint-stylistic/eslint-stylistic/issues/1088
+) => /** @type {import('@eslint/config-helpers').RuleConfig} */ (noRestrictedSyntax.filter(
+  entry =>
+    typeof entry === "number"
+    || typeof entry === "string"
+    // Exclude from jest tests for compatibility with
+    // `jest/valid-describe-callback` and `jest/no-test-return-statement`
+    || !entry.selector.startsWith("ArrowFunctionExpression")
+))
 
 // Matching Jest's own default file patterns: https://jestjs.io/docs/configuration#testmatch-arraystring
 export const jestFilePatterns = [
@@ -86,6 +86,7 @@ export const idLenghtConfig = {
   ]
 }
 
+// eslint-disable-next-line unicorn/prevent-abbreviations -- Props allowed in React
 export const jsxSortPropsConfig = {
   // Keeping special props first, and not hiding props under big multiline
   // both help a lot with readability and semantics

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-beslogic",
-  "version": "5.2.2",
+  "version": "5.2.3",
   "description": "ESLint rules, plugins and configs used at Beslogic",
   "main": "index.js",
   "type": "module",
@@ -8,8 +8,8 @@
   "scripts": {
     "eslint-unstable-flag": "set TIMING=1 && eslint . --flag unstable_config_lookup_from_file",
     "eslint": "set TIMING=1 && eslint . --flag v10_config_lookup_from_file",
-    "lint": "dprint check && npm run eslint",
-    "lint:fix": "npm run eslint -- --fix && dprint fmt",
+    "lint": "dprint check && npm run eslint && tsc",
+    "lint:fix": "npm run eslint -- --fix && dprint fmt && tsc",
     "upgrade": "npx npm-check-updates -u & npm i",
     "prepack": "type .gitignore* > .npmignore",
     "postinstall": "node ./lib/patch-dependencies.mjs",

package/react.mjs

@@ -16,8 +16,9 @@ import beslogicTypeScript from "./typescript.mjs"
 const typeDeclarationOverride = beslogicTypeScript.find(
   config => config.name === "beslogic/typescript/type-declaration"
 )
-
-if (!typeDeclarationOverride) throw new TypeError("**/*.d.ts not found in typescript.mjs")
+if (!typeDeclarationOverride) {
+  throw new TypeError("beslogic/typescript/type-declaration config not found in typescript.mjs")
+}
 
 const preventAbbreviationsConfig = { ...preventAbbreviationsConfigJS }
 // React props
@@ -25,6 +26,9 @@ preventAbbreviationsConfig.allowList.props = true
 preventAbbreviationsConfig.allowList.Props = true
 preventAbbreviationsConfig.allowList.ref = true
 preventAbbreviationsConfig.allowList.Ref = true
+preventAbbreviationsConfig.allowList.PropTypes = true
+// Apparently Trying to set "PropTypes" doesn't work
+preventAbbreviationsConfig.allowList.Prop = true
 // useState's set method using the previous state
 // Note: It's still better to name it like prevSomething
 preventAbbreviationsConfig.allowList.prev = true
@@ -96,7 +100,10 @@ export default defineConfig(
        * Stylistic overrides https://eslint.style/rules
        */
       "react/jsx-sort-props": "off",
-      "@stylistic/jsx-sort-props": ["error", jsxSortPropsConfig],
+      "@stylistic/jsx-sort-props": [
+        "error",
+        jsxSortPropsConfig
+      ],
 
       /*
        * react overrides (https://github.com/yannickcr/eslint-plugin-react#list-of-supported-rules)

package/tsconfig.4.3.json

@@ -5,12 +5,14 @@
   "compilerOptions": {
     "strict": true,
     "checkJs": true,
+    "incremental": true, // Performance improvement during dev through incremental checking
     "newLine": "LF", // Now default in TypeScript 5.0
     "forceConsistentCasingInFileNames": true, // Now default in TypeScript 5.0
     "resolveJsonModule": true,
     "noFallthroughCasesInSwitch": true,
     "noImplicitOverride": true,
     "noImplicitReturns": true,
+    "strictNullChecks": true, // Stop hiding null/undefined types, *even* with strict=false !
     // This makes index accesses even stricter. You may not want it in your project.
     // You should probably disable it at least in tests.
     "noUncheckedIndexedAccess": true,

package/tsconfig.json

@@ -12,5 +12,9 @@
     "jsx": "react-jsx",
     "allowJs": true,
     "noImplicitAny": false,
+    // Some issues in upstream .d.ts imports
+    "skipLibCheck": true,
+    // Necessary as long as we still test old-style Angular decorators
+    "experimentalDecorators": true,
   },
 }

package/typescript.mjs

@@ -11,6 +11,7 @@ import { maxParams, noMagicNumbersConfig as noMagicNumbersConfigJS, noRestricted
 import beslogicJest from "./jest.mjs"
 import { jestFilePatterns, jestNoRestrictedSyntax } from "./lib/utils.mjs"
 
+/** @type {[import('@eslint/core').Severity, ...(string | { selector: string, message: string })[]]} */
 export const noRestrictedSyntax = [
   ...noRestrictedSyntaxJS,
   {