@open-xchange/linter-presets 0.2.0 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [0.3.1] - 2024-08-01
+
+- added: [ESLint] default ignore globs (`dist`, `gitlab-ci`, and others)
+- changed: [ESLint] default values of `stylistic` option (indent 4 spaces, always semicolons, double quotes)
+
+## [0.3.0] - 2024-08-01
+
+- chore: [ESLint] [major bump of `typescript-eslint` to v8](https://typescript-eslint.io/blog/announcing-typescript-eslint-v8/)
+- removed: [ESLint] environment `env.tsconfig` (always using `projectService` of `typescript-eslint` instead)
+- changed: [ESLint] pattern for unused variables is now `^_.` (instead `^_`) to detect dangling underscore imports
+
 ## [0.2.0] - 2024-07-31
 
 - chore: bump dependencies

package/dist/eslint/config/ts.js

@@ -17,6 +17,7 @@ export default function ts() {
         // suppress warning for new TypeScript versions
         languageOptions: {
             parserOptions: {
+                projectService: true,
                 warnOnUnsupportedTypeScriptVersion: false,
             },
         },
@@ -32,7 +33,6 @@ export default function ts() {
             "@typescript-eslint/consistent-type-exports": "error",
             "@typescript-eslint/consistent-type-imports": ["error", { disallowTypeAnnotations: false }],
             "@typescript-eslint/default-param-last": "error",
-            "@typescript-eslint/dot-notation": "error",
             "@typescript-eslint/explicit-function-return-type": ["error", {
                     allowExpressions: true,
                     allowTypedFunctionExpressions: true,
@@ -40,12 +40,11 @@ export default function ts() {
                     allowConciseArrowFunctionExpressionsStartingWithVoid: true,
                 }],
             "@typescript-eslint/no-array-constructor": "error",
-            "@typescript-eslint/no-array-delete": "error",
             "@typescript-eslint/no-duplicate-type-constituents": "error",
             "@typescript-eslint/no-empty-function": ["error", {
                     allow: ["private-constructors", "protected-constructors", "decoratedFunctions", "overrideMethods"],
                 }],
-            "@typescript-eslint/no-empty-interface": "off",
+            "@typescript-eslint/no-empty-object-type": ["error", { allowInterfaces: "always" }],
             "@typescript-eslint/no-explicit-any": "off",
             "@typescript-eslint/no-import-type-side-effects": "error",
             "@typescript-eslint/no-invalid-this": "error",
@@ -56,19 +55,11 @@ export default function ts() {
             "@typescript-eslint/no-redeclare": "error",
             "@typescript-eslint/no-shadow": ["error", { ignoreOnInitialization: true }],
             "@typescript-eslint/no-unnecessary-template-expression": "error",
-            "@typescript-eslint/no-unsafe-enum-comparison": "error",
-            "@typescript-eslint/no-unsafe-function-type": "error",
-            "@typescript-eslint/no-unsafe-unary-minus": "error",
             "@typescript-eslint/no-unused-vars": ["error", NO_UNUSED_VARS_OPTIONS],
             "@typescript-eslint/no-useless-constructor": "error",
-            "@typescript-eslint/no-wrapper-object-types": "error",
-            "@typescript-eslint/only-throw-error": "error",
-            "@typescript-eslint/prefer-find": "error",
             "@typescript-eslint/prefer-literal-enum-member": "error",
-            "@typescript-eslint/prefer-nullish-coalescing": "off",
-            "@typescript-eslint/prefer-promise-reject-errors": "error",
+            "@typescript-eslint/prefer-nullish-coalescing": ["error", { ignorePrimitives: true }],
             "@typescript-eslint/prefer-readonly": "error",
-            "@typescript-eslint/require-await": "error",
             "@typescript-eslint/restrict-template-expressions": "off",
             "@typescript-eslint/return-await": ["error", "always"],
             "@typescript-eslint/switch-exhaustiveness-check": "error",

package/dist/eslint/index.d.ts

@@ -1,6 +1,5 @@
 import type { TSESLint } from "@typescript-eslint/utils";
 import type { LanguageOptions, StylisticOptions } from "./shared/env-utils.js";
-import tsconfig from "./env/tsconfig.js";
 import node from "./env/node.js";
 import browser from "./env/browser.js";
 import jest from "./env/jest.js";
@@ -40,7 +39,6 @@ export interface ConfigureOptions {
  * A collection with all available environment presets.
  */
 export declare const env: {
-    tsconfig: typeof tsconfig;
     node: typeof node;
     browser: typeof browser;
     jest: typeof jest;

package/dist/eslint/index.js

@@ -9,7 +9,6 @@ import imports from "./config/imports.js";
 import promises from "./config/promises.js";
 import jsdoc from "./config/jsdoc.js";
 import stylistic from "./config/stylistic.js";
-import tsconfig from "./env/tsconfig.js";
 import node from "./env/node.js";
 import browser from "./env/browser.js";
 import jest from "./env/jest.js";
@@ -23,7 +22,6 @@ import eslint from "./env/eslint.js";
  * A collection with all available environment presets.
  */
 export const env = {
-    tsconfig,
     node,
     browser,
     jest,
@@ -45,6 +43,14 @@ export const env = {
  *  An array of configuration objects to be added to the flat configuration.
  */
 export function configure(options) {
+    const ignores = [
+        "*/.yarn/*",
+        "dist/*",
+        "vite.config.ts.*.mjs",
+        "gitlab-ci/*",
+        ".gitlab-ci.yml",
+        ...(options?.ignores ?? []),
+    ];
     // resolve language configuration options
     const languageOptions = {
         ecmaVersion: 2022,
@@ -54,15 +60,15 @@ export function configure(options) {
     };
     // resolve stylistic configuration options
     const stylisticOptions = {
-        indent: 2,
-        semi: "never",
-        quotes: "single",
+        indent: 4,
+        semi: "always",
+        quotes: "double",
         dangle: "always",
         ...options?.stylistic,
     };
     return [
         // ignore certain files and folders
-        ...(options?.ignores?.length ? [{ ignores: options.ignores }] : []),
+        { ignores },
         // module types and standard rules for all JS/TS source files
         ...base(languageOptions),
         // default configuration for JavaScript files

package/dist/eslint/rules/no-amd-module-directive.d.ts

@@ -1,3 +1,3 @@
 import { type TSESLint } from "@typescript-eslint/utils";
-declare const _default: TSESLint.RuleModule<"UNEXPECTED_DIRECTIVE" | "UNEXPECTED_DIRECTIVE_FIX", [], TSESLint.RuleListener>;
+declare const _default: TSESLint.RuleModule<"UNEXPECTED_DIRECTIVE" | "UNEXPECTED_DIRECTIVE_FIX", [], unknown, TSESLint.RuleListener>;
 export default _default;

package/dist/eslint/rules/no-invalid-hierarchy.d.ts

@@ -21,5 +21,5 @@ export interface RuleNoInvalidHierarchyPackage {
 export type RuleNoInvalidHierarchyOptions = Record<string, RuleNoInvalidHierarchyPackage>;
 type RuleOptions = [RuleNoInvalidHierarchyOptions];
 type RuleMessageIds = "UNEXPECTED_OPTIONAL_STATIC" | "INVALID_PACKAGE_HIERARCHY";
-declare const _default: ESLintUtils.RuleModule<RuleMessageIds, RuleOptions, ESLintUtils.RuleListener>;
+declare const _default: ESLintUtils.RuleModule<RuleMessageIds, RuleOptions, unknown, ESLintUtils.RuleListener>;
 export default _default;

package/dist/eslint/rules/no-invalid-modules.d.ts

@@ -6,5 +6,5 @@ export interface RuleNoInvalidModulesOptions {
     external?: string[];
 }
 type RuleOptions = [Required<RuleNoInvalidModulesOptions>];
-declare const _default: ESLintUtils.RuleModule<"SOURCE_FILE_NOT_FOUND", RuleOptions, ESLintUtils.RuleListener>;
+declare const _default: ESLintUtils.RuleModule<"SOURCE_FILE_NOT_FOUND", RuleOptions, unknown, ESLintUtils.RuleListener>;
 export default _default;

package/dist/eslint/shared/env-utils.js

@@ -4,9 +4,9 @@
  * `@typescript-eslint/no-unused-vars`.
  */
 export const NO_UNUSED_VARS_OPTIONS = {
-    varsIgnorePattern: "^_",
-    argsIgnorePattern: "^_",
-    destructuredArrayIgnorePattern: "^_",
+    varsIgnorePattern: "^_.",
+    argsIgnorePattern: "^_.",
+    destructuredArrayIgnorePattern: "^_.",
     caughtErrors: "all",
     ignoreRestSiblings: true,
 };
@@ -22,7 +22,7 @@ export const NO_UNUSED_VARS_OPTIONS = {
  *  The concatenated and flattened array.
  */
 function flatten(...entries) {
-    return entries.flatMap(array => array || []);
+    return entries.flatMap(array => array ?? []);
 }
 /**
  * Creates a rules record for all restricted items.
@@ -141,7 +141,7 @@ export function restrictedRules(envOptions, fixed) {
  *  custom rule settings, otherwise `undefined`.
  */
 export function customRules(envOptions, rules) {
-    return (rules || envOptions.rules) && createConfig(envOptions, {
+    return (rules ?? envOptions.rules) && createConfig(envOptions, {
         rules: { ...rules, ...envOptions.rules },
     });
 }

package/doc/eslint/README.md

@@ -32,19 +32,29 @@ function configure(options?: ConfigureOptions): Linter.FlatConfig[]
 
 | Name | Type | Default | Description |
 | - | - | - | - |
-| `ignores` | `string[]` | `[]` | Glob patterns with all files and folders to be ignored by ESLint. |
+| `ignores` | `string[]` | `[]` | Glob patterns with all files and folders to be ignored by ESLint. This package already defines a few standard ignore globs (see below). |
 | `license` | `string` | `""` | Full path to the template file containing the license header to be used in all source files. |
 | `language` | `LanguageOptions` | | Configuration options for language and project setup. |
 | `language.ecmaVersion` | `number` | `2022` | The ECMAScript version to be used in the project (version or year). |
 | `language.sourceType` | `"module"\|"commonjs"` | `"module"` | Specifies how to treat `.js`, `.jsx`, `.ts`, and `.tsx` files. |
 | `language.nativeDecorators` | `boolean` | `false` | Whether to support native ES decorators in JavaScript code (via Babel plugin). Does not affect TypeScript code which uses an own parser aware of the decorator syntax. |
 | `stylistic` | `StylisticOptions` | | Configuration options for code style. |
-| `stylistic.indent` | `number` | `2` | Default indentation size (number of space characters). Will be applied to JavaScript, TypeScript, JSON, and YAML files, as well as JSX markup. |
-| `stylistic.semi` | `boolean` | `false` | Specifies whether to require semicolons following all statements (`true`), or to force to omit semicolons if possible according to ASI rules (`false`). |
-| `stylistic.quotes` | `"single"\|"double"\|"off"` | `"single"` | The type of the string delimiter character. |
+| `stylistic.indent` | `number` | `4` | Default indentation size (number of space characters). Will be applied to JavaScript, TypeScript, JSON, and YAML files, as well as JSX markup. |
+| `stylistic.semi` | `"always"\|"never"\|"off"` | `"always"` | Specifies whether to require semicolons following all statements (`"always"`), or to force to omit semicolons if possible according to ASI rules (`"never"`). |
+| `stylistic.quotes` | `"single"\|"double"\|"off"` | `"double"` | The type of the string delimiter character. |
 | `stylistic.dangle` | `"always"\|"never"\|"off"` | `"always"` | Specifies how to treat dangling commas in multiline lists. |
 | `rules` | `Linter.RulesRecord` | `{}` | Additional linter rules to be added to the global configuration. |
 
+#### Built-in Ignore Globs
+
+This package defines ignore globs for the following files and directories:
+
+- `*/.yarn/*` (internal setup files of Yarn v2+)
+- `dist/*` (standard build output directory)
+- `vite.config.ts.*.mjs` (intermediate files of Vite dev server)
+- `gitlab-ci/*` (GitLab CI configuration files)
+- `.gitlab-ci.yml` (GitLab CI configuration files)
+
 #### `configure` Example
 
 ```js
@@ -73,7 +83,6 @@ The names of the environment presets are linked to detailed descriptions.
 
 | Name | Description |
 | - | - |
-| [`env.tsconfig`](./env/tsconfig.md) | TypeScript project setup (per `tsconfig.json` file). |
 | [`env.node`](./env/node.md) | Modules running in NodeJS. |
 | [`env.browser`](./env/browser.md) | Modules running in browsers. |
 | [`env.react`](./env/react.md) | Modules using [React](https://react.dev/) library. |

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@open-xchange/linter-presets",
-    "version": "0.2.0",
+    "version": "0.3.1",
     "description": "Configuration presets for ESLint and StyleLint",
     "repository": {
         "url": "https://gitlab.open-xchange.com/fspd/npm-packages/linter-presets"
@@ -55,19 +55,19 @@
         "eslint-plugin-vitest": "0.5.4",
         "eslint-plugin-yml": "1.14.0",
         "find-up": "7.0.0",
-        "globals": "15.8.0",
+        "globals": "15.9.0",
         "picomatch": "4.0.2",
         "stylelint-config-standard": "36.0.1",
         "stylelint-config-standard-less": "3.0.1",
         "stylelint-config-standard-scss": "13.1.0",
         "stylelint-plugin-license-header": "1.0.3",
-        "typescript-eslint": "7.18.0"
+        "typescript-eslint": "8.0.0"
     },
     "devDependencies": {
         "@types/confusing-browser-globals": "1.0.3",
         "@types/eslint__js": "8.42.3",
         "@types/picomatch": "3.0.0",
-        "@typescript-eslint/utils": "7.18.0",
+        "@typescript-eslint/utils": "8.0.0",
         "eslint": "9.8.0",
         "husky": "9.1.4",
         "jest": "29.7.0",

package/dist/eslint/env/tsconfig.d.ts

@@ -1,21 +0,0 @@
-import type { TSESLint } from "@typescript-eslint/utils";
-import type { EnvBaseOptions } from "../shared/env-utils.js";
-/**
- * Configuration options for the environment preset "env.tsconfig".
- */
-export interface EnvTSConfigOptions extends EnvBaseOptions {
-    /**
-     * The path to the TypeScript project configuration file (`tsconfig.json`).
-     */
-    project: string;
-}
-/**
- * Creates configuration objects for TypeScript projects.
- *
- * @param envOptions
- *  Configuration options for the environment.
- *
- * @returns
- *  An array of configuration objects to be added to the flat configuration.
- */
-export default function tsconfig(envOptions: EnvTSConfigOptions): TSESLint.FlatConfig.ConfigArray;

package/dist/eslint/env/tsconfig.js

@@ -1,24 +0,0 @@
-import { concatConfigs, createConfig, customRules } from "../shared/env-utils.js";
-// functions ==================================================================
-/**
- * Creates configuration objects for TypeScript projects.
- *
- * @param envOptions
- *  Configuration options for the environment.
- *
- * @returns
- *  An array of configuration objects to be added to the flat configuration.
- */
-export default function tsconfig(envOptions) {
-    return concatConfigs(
-    // path to project configuration file
-    createConfig(envOptions, {
-        languageOptions: {
-            parserOptions: {
-                project: envOptions.project,
-            },
-        },
-    }), 
-    // custom rules
-    customRules(envOptions));
-}

package/doc/eslint/env/tsconfig.md

@@ -1,35 +0,0 @@
-# Environment `env.tsconfig`
-
-Creates configuration objects for TypeScript projects (registers a `tsconfig.json` file in the project).
-
-## Signature
-
-```ts
-function tsconfig(options: EnvTSConfigOptions): Linter.FlatConfig[]
-```
-
-## Options
-
-| Name | Type | Default | Description |
-| - | - | - | - |
-| `files` | `string[]` | _required_ | Glob patterns for source files to be included. |
-| `ignores` | `string[]` | `[]` | Glob patterns for source files matching `files` to be ignored. |
-| `project` | `string` | _required_ | The absolute path to the TypeScript project configuration file (`tsconfig.json`). |
-| `rules` | `Linter.RulesRecord` | `{}` | Additional linter rules to be added to the configuration. |
-
-## Example
-
-```js
-// eslint.config.js
-import { utils, eslint } from "@open-xchange/linter-presets"
-
-const resolve = utils.resolver(import.meta.url)
-
-export default [
-  ...eslint.configure({ /* ... */ }),
-  ...eslint.env.tsconfig({
-    files: ["src/**/*.ts"],
-    project: resolve("src/tsconfig.json"),
-  }),
-]
-```