Add env property types

Author: Shinigami92

.eslintrc.js

@@ -80,7 +80,23 @@ module.exports = defineConfig({
       'warn',
       {
         minLength: 3,
-        skipWords: ['backtick', 'backticks', 'ecma']
+        skipWords: [
+          'amd',
+          'applescript',
+          'atomtest',
+          'backtick',
+          'backticks',
+          'browserify',
+          'commonjs',
+          'ecma',
+          'embertest',
+          'globals',
+          'greasemonkey',
+          'nashorn',
+          'phantomjs',
+          'prototypejs',
+          'webextensions'
+        ]
       }
     ],
 

.vscode/settings.json

@@ -1,5 +1,19 @@
 {
-  "cSpell.words": ["Quadflieg", "backticks", "readonly", "typeof"],
+  "cSpell.words": [
+    "Quadflieg",
+    "applescript",
+    "atomtest",
+    "backticks",
+    "embertest",
+    "greasemonkey",
+    "nashorn",
+    "prototypejs",
+    "qunit",
+    "readonly",
+    "serviceworker",
+    "typeof",
+    "webextensions"
+  ],
   "eslint.validate": ["javascript", "typescript"],
   "typescript.tsdk": "node_modules/typescript/lib"
 }

src/env.ts

@@ -1,7 +1,119 @@
 /**
+ * An environment provides predefined global variables.
  *
+ * @see [Environments](https://eslint.org/docs/user-guide/configuring/language-options#specifying-environments)
  */
-export interface Env {
-  es6?: boolean;
+export interface Environments extends Partial<Record<string, boolean>> {
+  /*
+   * Browser global variables.
+   */
+  browser?: boolean;
+  /*
+   * Node.js global variables and Node.js scoping.
+   */
   node?: boolean;
+  /*
+   * CommonJS global variables and CommonJS scoping (use this for browser-only code that uses Browserify/WebPack).
+   */
+  commonjs?: boolean;
+  /*
+   * Globals common to both Node.js and Browser.
+   */
+  'shared-node-browser'?: boolean;
+  /*
+   * Enable all ECMAScript 6 features except for modules (this automatically sets the ecmaVersion parser option to 6).
+   */
+  es6?: boolean;
+  /*
+   * Adds all ECMAScript 2017 globals and automatically sets the ecmaVersion parser option to 8.
+   */
+  es2017?: boolean;
+  /*
+   * Adds all ECMAScript 2020 globals and automatically sets the ecmaVersion parser option to 11.
+   */
+  es2020?: boolean;
+  /*
+   * Adds all ECMAScript 2021 globals and automatically sets the ecmaVersion parser option to 12.
+   */
+  es2021?: boolean;
+  /*
+   * Web workers global variables.
+   */
+  worker?: boolean;
+  /*
+   * Defines `require()` and `define()` as global variables as per the amd spec.
+   */
+  amd?: boolean;
+  /*
+   * Adds all of the Mocha testing global variables.
+   */
+  mocha?: boolean;
+  /*
+   * Adds all of the Jasmine testing global variables for version 1.3 and 2.0.
+   */
+  jasmine?: boolean;
+  /*
+   * Jest global variables.
+   */
+  jest?: boolean;
+  /*
+   * PhantomJS global variables.
+   */
+  phantomjs?: boolean;
+  /*
+   * Protractor global variables.
+   */
+  protractor?: boolean;
+  /*
+   * QUnit global variables.
+   */
+  qunit?: boolean;
+  /*
+   * jQuery global variables.
+   */
+  jquery?: boolean;
+  /*
+   * Prototype.js global variables.
+   */
+  prototypejs?: boolean;
+  /*
+   * ShellJS global variables.
+   */
+  shelljs?: boolean;
+  /*
+   * Meteor global variables.
+   */
+  meteor?: boolean;
+  /*
+   * MongoDB global variables.
+   */
+  mongo?: boolean;
+  /*
+   * AppleScript global variables.
+   */
+  applescript?: boolean;
+  /*
+   * Java 8 Nashorn global variables.
+   */
+  nashorn?: boolean;
+  /*
+   * Service Worker global variables.
+   */
+  serviceworker?: boolean;
+  /*
+   * Atom test helper globals.
+   */
+  atomtest?: boolean;
+  /*
+   * Ember test helper globals.
+   */
+  embertest?: boolean;
+  /*
+   * WebExtensions globals.
+   */
+  webextensions?: boolean;
+  /*
+   * GreaseMonkey globals.
+   */
+  greasemonkey?: boolean;
 }

src/index.ts

@@ -1,4 +1,4 @@
-import type { Env } from './env';
+import type { Environments } from './env';
 import type { Overrides } from './overrides';
 import type { ParserOptions } from './parser-options';
 import type { Rules } from './rules';
@@ -10,7 +10,12 @@ import type { Settings } from './settings';
 export interface EslintConfig {
   root?: boolean;
   ignorePatterns?: string[];
-  env?: Env;
+  /**
+   * An environment provides predefined global variables.
+   *
+   * @see [Environments](https://eslint.org/docs/user-guide/configuring/language-options#specifying-environments)
+   */
+  env?: Environments;
   extends?: string[];
   parser?: string;
   parserOptions?: ParserOptions;