biome.jsonc

{
  "$schema": "https://biomejs.dev/schemas/2.4.0/schema.json",
  "vcs": {
    "enabled": false,
    "clientKind": "git",
    "useIgnoreFile": true,
    "defaultBranch": "beta"
  },

  "formatter": {
    "enabled": true,
    "useEditorconfig": true,
    "indentStyle": "space",
    "lineWidth": 120
  },

  "files": {
    "ignoreUnknown": true,
    // Adding folders to the ignore list is GREAT for performance because it prevents biome from descending into them
    // and having to verify whether each individual file is ignored
    "includes": [
      "**",
      "!.github/**/*.*", // workaround due to bug/design limitation, should be `"!.github"`
      ".github/**/*.ts",
      ".github/**/*.mts",
      "!!.vscode",
      "!!build",
      "!!coverage",
      "!!dist",
      "!!docs",
      "!public/**/*.*", // workaround due to bug/design limitation, should be `"!public"`
      "public/service-worker.js",
      "!!typedoc",
      "!pnpm-lock.yml",
      // this file is too big
      "!src/data/tms.ts"
    ]
  },

  "assist": {
    "actions": {
      "source": {
        "organizeImports": {
          "level": "on",
          "options": {
            "groups": [":ALIAS:", ":NODE:", ":PACKAGE_WITH_PROTOCOL:", ":PACKAGE:", ":PATH:"]
          }
        }
      }
    }
  },

  "linter": {
    "enabled": true,
    "rules": {
      "recommended": true, // see https://biomejs.dev/linter/javascript/rules/#recommended-rules and https://biomejs.dev/linter/css/rules/#recommended-rules
      "correctness": {
        "noUndeclaredVariables": "off", // handled by TypeScript
        "noUnusedVariables": "error",
        "noSwitchDeclarations": "error",
        "noVoidTypeReturn": "error",
        "noUnusedImports": {
          "level": "error",
          "fix": "safe",
          "options": {}
        },
        "noUnusedFunctionParameters": "error",
        "noUnusedLabels": "error",
        "noPrivateImports": "error",
        "noUndeclaredDependencies": "error",
        "useJsonImportAttributes": "off", // "Import attributes are only supported when the '--module' option is set to 'esnext', 'node18', 'nodenext', or 'preserve'. ts(2823)"
        "useSingleJsDocAsterisk": "error",
        "noUnusedPrivateClassMembers": "error"
      },
      "style": {
        "useEnumInitializers": "off", // large enums like Moves/Species would make this cumbersome
        "useBlockStatements": "error",
        "useConst": "error",
        "useImportType": "error",
        "noNonNullAssertion": "off", // TODO: fix all non-null assertions in non-test files and turn this on
        "noParameterAssign": "info", // TODO: refactor and make "error"
        "useExponentiationOperator": "off", // Too typo-prone and easy to mixup with standard multiplication (* vs **)
        "useDefaultParameterLast": "error",
        "useSingleVarDeclarator": "error",
        "useNodejsImportProtocol": "error",
        "useTemplate": "off", // string concatenation is faster: https://stackoverflow.com/questions/29055518/are-es6-template-literals-faster-than-string-concatenation
        "noInferrableTypes": "off", // Explicit > Implicit
        "useConsistentArrayType": "error", // Standardize on `T[]`
        "useFilenamingConvention": {
          "level": "error",
          "options": {
            "filenameCases": ["kebab-case"],
            "requireAscii": true,
            "strictCase": false
          }
        },
        "useAsConstAssertion": "error",
        "noUnusedTemplateLiteral": "error",
        "useNumberNamespace": "error",
        "noUselessElse": "error",
        "noCommonJs": "error",
        "noRestrictedTypes": {
          "level": "error",
          "options": {
            "types": {
              "integer": {
                "message": "This is an alias for 'number' that can provide false impressions of what values can actually be contained in this variable. Use 'number' instead.",
                "use": "number"
              }
            }
          }
        },
        "useConsistentMemberAccessibility": {
          "level": "off", // TODO: refactor and make this an error
          "options": {
            "accessibility": "explicit"
          }
        },
        "useShorthandAssign": "error",
        "useGroupedAccessorPairs": "error",
        "useObjectSpread": "error",
        "useNumericSeparators": "off", // TODO: enable?
        "noNamespace": "error",
        "noDefaultExport": "error",
        "noShoutyConstants": "error",
        "noSubstr": "error",
        "noYodaExpression": "error",
        "useThrowNewError": "error",
        "useThrowOnlyError": "error",
        "useTrimStartEnd": "error",
        "useForOf": "error",
        "useConsistentObjectDefinitions": "error",
        "useConsistentBuiltinInstantiation": "error",
        "useCollapsedIf": "error",
        "useCollapsedElseIf": "error",
        "noNegationElse": "error",
        "noParameterProperties": "error", // a step toward enabling `erasableSyntaxOnly` in `tsconfig.json`
        "useAtIndex": "error",
        "useReadonlyClassProperties": "error",
        "useExplicitLengthCheck": "info", // TODO: refactor and make "error"
        "noNestedTernary": "error"
      },
      "suspicious": {
        "noDoubleEquals": "error",
        "noExplicitAny": "off", // TODO: Refactor and make this an error
        "noAssignInExpressions": "error",
        "noPrototypeBuiltins": "error",
        "noFallthroughSwitchClause": "error", // Prevents accidental automatic fallthroughs in switch cases (use disable comment if needed)
        "noImplicitAnyLet": "error",
        "noRedeclare": "error",
        "noGlobalIsNan": "error",
        "noAsyncPromiseExecutor": "warn", // TODO: Refactor and make this an error
        "useDefaultSwitchClauseLast": "error",
        "noVar": "error",
        "noDocumentCookie": "off", // Firefox has minimal support for the "Cookie Store API"
        "noConstantBinaryExpressions": "error",
        "noTsIgnore": "error",
        "useIterableCallbackReturn": {
          "level": "error",
          "options": {
            "checkForEach": false
          }
        },
        "useErrorMessage": "error",
        "useGuardForIn": "error",
        "useNumberToFixedDigitsArgument": "error",
        "noEvolvingTypes": "error",
        "noNonNullAssertedOptionalChain": "error",
        "noImportCycles": "error" // overlaps with depcruiser but this will allow diagnostics to be shown in the IDE
      },
      "complexity": {
        "noExcessiveCognitiveComplexity": "info",
        "useLiteralKeys": "off",
        "noForEach": "off", // Foreach vs for of is not that simple.
        "noUselessSwitchCase": "off", // Explicit > Implicit
        "noUselessConstructor": "error",
        "noBannedTypes": "error",
        "useRegexLiterals": "off", // Was broken for some reason; TODO: re-enable
        "noThisInStatic": "error",
        "noUselessThisAlias": "error",
        "noUselessTernary": "error",
        "useIndexOf": "error",
        "noVoid": "error",
        "useWhile": "error",
        "noUselessStringConcat": "error",
        "noUselessUndefined": "error"
      },
      "nursery": {
        "noShadow": "error",
        "useExplicitType": "off", // TODO: refactor and make "error"
        "noFloatingPromises": "warn", // TODO: refactor and make "error"
        "noMisusedPromises": "warn", // TODO: refactor and make "error"
        "useExhaustiveSwitchCases": "error",
        "noUnnecessaryConditions": "off", // TODO: enable when the false positives are fixed
        "useArraySortCompare": "error",
        "useFind": "error",
        "noParametersOnlyUsedInRecursion": "error",
        "useSpread": "error",
        "noProto": "error",
        "noMultiStr": "error",
        "useRegexpExec": "error",
        "noReturnAssign": "error",
        "noMultiAssign": "error"
      },
      "performance": {
        "noNamespaceImport": "error",
        "noDelete": "error",
        "noAwaitInLoops": "off", // Necessary for our codebase
        "noBarrelFile": "error"
      }
    }
  },
  "javascript": {
    "formatter": {
      "operatorLinebreak": "before"
    },
    "parser": {
      "jsxEverywhere": false
    }
  },
  "css": {
    "formatter": {
      "enabled": false
    }
  },
  "overrides": [
    {
      "includes": ["**/test/**"],
      "javascript": { "globals": [] },
      "linter": {
        "rules": {
          "performance": {
            "noDelete": "off", // TODO: evaluate if this is necessary for the test(s) to function
            "noNamespaceImport": "off"
          },
          "style": {
            "noNonNullAssertion": "off" // tests are able to make assumptions about the game state that normally can't be made
          },
          "nursery": {
            "noFloatingPromises": "error"
          }
        }
      }
    },
    {
      // This section is to improve the bug tester workflow
      "includes": ["src/overrides.ts"],
      "linter": {
        "rules": {
          "correctness": {
            "noUnusedImports": "off"
          },
          "style": {
            "useImportType": "off"
          }
        }
      }
    },
    {
      "includes": ["src/plugins/i18n.ts", "**/vite.config.ts", "**/vitest.config.ts"],
      "linter": {
        "rules": {
          "style": {
            "noDefaultExport": "off"
          }
        }
      }
    }
  ]
}