@open-xchange/linter-presets 0.3.0 → 0.3.2

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # 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)
+- 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/)

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 ==================================================================
 /**
@@ -43,6 +45,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,
@@ -52,15 +62,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/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
@@ -55,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" },
   }),
 ]
 ```
@@ -81,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.0",
+    "version": "0.3.2",
     "description": "Configuration presets for ESLint and StyleLint",
     "repository": {
         "url": "https://gitlab.open-xchange.com/fspd/npm-packages/linter-presets"
@@ -55,7 +55,7 @@
         "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",