JSPM

  • Created
  • Published
  • Downloads 42
  • Score
    100M100P100Q66967F
  • License MIT

A sharable ESLint config for TypeScript and IsaacScript projects.

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (eslint-config-isaacscript) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    eslint-config-isaacscript

    npm version

    This is a sharable configuration for ESLint that is intended to be used in TypeScript and IsaacScript projects.

    This package is consumed by the isaacscript-lint meta-linting package. It is recommended that instead of consuming this package directly, you instead list isaacscript-lint as a dependency, as it includes all of the corresponding plugins and so on.

    For TypeScript projects, set up your .eslintrc.cjs file to extend from the config like this:

    // This is the configuration file for ESLint, the TypeScript linter:
    // https://eslint.org/docs/user-guide/configuring
    module.exports = {
      extends: [
        // The linter base is the shared IsaacScript config:
        // https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-config-isaacscript/base.js
        "eslint-config-isaacscript/base",
      ],
    
      // Don't bother linting the compiled output.
      ignorePatterns: ["**/dist/**"],
    
      parserOptions: {
        // ESLint needs to know about the project's TypeScript settings in order for TypeScript-specific
        // things to lint correctly. We do not point this at "./tsconfig.json" because certain files
        // (such at this file) should be linted but not included in the actual project output.
        project: "./tsconfig.eslint.json",
      },
    
      rules: {},
    };

    Please see the IsaacScript webpage for more information.