@open-xchange/linter-presets 0.3.1 → 0.3.2

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [0.3.2] - 2024-08-01
+
+- added: [ESLint] restore environment `env.tsconfig` to workaround VSCode issues
+
 ## [0.3.1] - 2024-08-01
 
 - added: [ESLint] default ignore globs (`dist`, `gitlab-ci`, and others)

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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,24 @@
+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/dist/eslint/index.d.ts

@@ -8,6 +8,7 @@ import codecept from "./env/codecept.js";
 import react from "./env/react.js";
 import project from "./env/project.js";
 import eslint from "./env/eslint.js";
+import tsconfig from "./env/tsconfig.js";
 /**
  * Configuration options for linting the entire project with ESLint.
  */
@@ -47,6 +48,7 @@ export declare const env: {
     react: typeof react;
     project: typeof project;
     eslint: typeof eslint;
+    tsconfig: typeof tsconfig;
 };
 /**
  * Generates ESLint configuration objects targeting the source files in the

package/dist/eslint/index.js

@@ -17,6 +17,7 @@ import codecept from "./env/codecept.js";
 import react from "./env/react.js";
 import project from "./env/project.js";
 import eslint from "./env/eslint.js";
+import tsconfig from "./env/tsconfig.js";
 // environment presets ========================================================
 /**
  * A collection with all available environment presets.
@@ -30,6 +31,7 @@ export const env = {
     react,
     project,
     eslint,
+    tsconfig,
 };
 // functions ==================================================================
 /**

package/doc/eslint/README.md

@@ -65,10 +65,10 @@ const resolve = utils.resolver(import.meta.url)
 
 export default [
   ...eslint.configure({
-    ignores: ["dist/*", "external/**/*.yaml"],
+    ignores: ["external/**/*.yaml"],
     language: { ecmaVersion: 2024, sourceType: "commonjs" },
     license: resolve("./license.txt"),
-    stylistic: { quotes: "double", semi: "always" },
+    stylistic: { quotes: "single", semi: "never" },
   }),
 ]
 ```
@@ -91,3 +91,4 @@ The names of the environment presets are linked to detailed descriptions.
 | [`env.codecept`](./env/codecept.md) | E2E tests with [CodeceptJS](https://codecept.io/). |
 | [`env.eslint`](./env/eslint.md) | Implementation of custom ESLint rules. |
 | [`env.project`](./env/project.md) | Project setup and module imports. |
+| [`env.tsconfig`](./env/tsconfig.md) | TypeScript project setup (per `tsconfig.json` file). Provided in case VSCode fails to use the new project service correctly. |

package/doc/eslint/env/tsconfig.md

@@ -0,0 +1,36 @@
+# Environment `env.tsconfig`
+
+Creates configuration objects for TypeScript projects (registers a `tsconfig.json` file in the project).
+
+Usually, this environment preset should not be necessary, as the new [project service](https://typescript-eslint.io/blog/announcing-typescript-eslint-v8#project-service) of `typescript-eslint` is enabled by default. However, the ESLint plugin of VSCode sometimes fails to lint files in certain subdirectories and complains about the project service not covering the file to be linted. In these cases, manually setting up this environment preset will help.
+
+## 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"),
+  }),
+]

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@open-xchange/linter-presets",
-    "version": "0.3.1",
+    "version": "0.3.2",
     "description": "Configuration presets for ESLint and StyleLint",
     "repository": {
         "url": "https://gitlab.open-xchange.com/fspd/npm-packages/linter-presets"