@open-xchange/linter-presets 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [0.1.2] - 2024-07-12
+
+- added: [ESLint] option `restricted.nativeDecorators`
+
+## [0.1.1] - 2024-07-11
+
+- changed: [ESLint] option `stylistic.semi` as enum (always/never/off)
+
 ## [0.1.0] - 2024-07-10
 
 - chore: converted source code to TypeScript

package/README.md

@@ -38,7 +38,7 @@ Usage example:
 // stylelint.config.js
 import { stylelint } from "@open-xchange/linter-presets"
 
-export default eslint.configure({
+export default stylelint.configure({
   /* config options */
 })
 ```

package/dist/eslint/config/stylistic.js

@@ -78,7 +78,7 @@ export default function stylistic(options) {
                 "@stylistic/quote-props": ["error", "as-needed"],
                 "@stylistic/quotes": (quotes === "off") ? "off" : ["error", quotes, { avoidEscape: true }],
                 "@stylistic/rest-spread-spacing": "error",
-                "@stylistic/semi": ["error", semi ? "always" : "never"],
+                "@stylistic/semi": (semi === "off") ? "off" : ["error", semi],
                 "@stylistic/semi-spacing": "error",
                 "@stylistic/semi-style": "error",
                 "@stylistic/space-before-blocks": "error",

package/dist/eslint/env/project.js

@@ -1,23 +1,3 @@
-/*
- * @copyright Copyright (c) Open-Xchange GmbH, Germany <info@open-xchange.com>
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with OX App Suite. If not, see <https://www.gnu.org/licenses/agpl-3.0.txt>.
- *
- * Any use of the work other than as authorized under this license or copyright law is prohibited.
- *
- */
 import noAmdModuleDirective from "../rules/no-amd-module-directive.js";
 import noInvalidModules from "../rules/no-invalid-modules.js";
 // exports ====================================================================

package/dist/eslint/index.js

@@ -54,7 +54,7 @@ export function configure(options) {
     // resolve stylistic configuration options
     const stylisticOptions = {
         indent: 2,
-        semi: false,
+        semi: "never",
         quotes: "single",
         dangle: "always",
         ...options?.stylistic,

package/dist/eslint/rules/no-amd-module-directive.js

@@ -1,23 +1,3 @@
-/*
- * @copyright Copyright (c) Open-Xchange GmbH, Germany <info@open-xchange.com>
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with OX App Suite. If not, see <https://www.gnu.org/licenses/agpl-3.0.txt>.
- *
- * Any use of the work other than as authorized under this license or copyright law is prohibited.
- *
- */
 import { ESLintUtils } from "@typescript-eslint/utils";
 // exports ====================================================================
 export default ESLintUtils.RuleCreator.withoutDocs({

package/dist/eslint/rules/no-invalid-modules.js

@@ -1,23 +1,3 @@
-/*
- * @copyright Copyright (c) Open-Xchange GmbH, Germany <info@open-xchange.com>
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with OX App Suite. If not, see <https://www.gnu.org/licenses/agpl-3.0.txt>.
- *
- * Any use of the work other than as authorized under this license or copyright law is prohibited.
- *
- */
 import { createRequire } from "node:module";
 import { posix, dirname, extname } from "node:path";
 import { packageUpSync } from "package-up";

package/dist/eslint/shared/env-utils.d.ts

@@ -29,10 +29,15 @@ export interface StylisticOptions {
      */
     indent?: number;
     /**
-     * Specifies whether to require semicolons following all statements. By
-     * default, semicolons must be omitted if possible according to ASI rules.
+     * Specifies how to treat semicolons.
+     *
+     * - "always": Require semicolons following all statements.
+     * - "never": Require to omit semicolons according to ASI rules.
+     * - "off": Semicolons will not be checked.
+     *
+     * Default value is "never".
      */
-    semi?: boolean;
+    semi?: "always" | "never" | "off";
     /**
      * The type of the string delimiter character. Default value is "single".
      */
@@ -115,9 +120,24 @@ export interface EnvRestrictedItems {
 export interface EnvRestrictedOverride extends EnvFilesOptions, EnvRestrictedItems {
 }
 /**
- * Configuration options for restricted imports and globals.
+ * Configuration options for banned globals, imports, properties, and syntax
+ * constructs in the environment.
  */
 export interface EnvRestrictedOptions extends EnvRestrictedItems {
+    /**
+     * Whether the environment supports native decorators. In this case, it
+     * will be required to replace TypeScript decorated `private` methods with
+     * native `#private` methods.
+     *
+     * Default value is `false` (TypeScript's experimental decorators cannot be
+     * used with native `#private` fields).
+     */
+    nativeDecorators?: boolean;
+    /**
+     * Overrides for specific subsets of files in the environment. All
+     * restricted items of overrides will be merged with the common restricted
+     * items defined for the entire environment.
+     */
     overrides?: EnvRestrictedOverride[];
 }
 export interface EnvRestrictedRulesResult {

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

@@ -1,19 +1,4 @@
 // constants ==================================================================
-/**
- * Global symbols to be banned in all source code files.
- */
-const RESTRICTED_GLOBALS = [
-    { name: "isFinite", message: "Use 'Number.isFinite' instead." },
-    { name: "isNaN", message: "Use 'Number.isNaN' instead." },
-];
-/**
- * Syntax constructs to be banned in all source code files.
- */
-const RESTRICTED_SYNTAX = [
-    { selector: ":matches(PropertyDefinition, MethodDefinition[kind!='constructor'])[accessibility='public']", message: "Remove 'public' keyword." },
-    { selector: ":matches(PropertyDefinition, MethodDefinition[kind!='constructor'])[accessibility='private'][decorators.length=0]", message: "Use #private syntax instead." },
-    { selector: "MethodDefinition[kind='constructor'] TSParameterProperty[accessibility]", message: "Use explicit class properties." },
-];
 /**
  * Shared options for the core rule `no-unused-vars`, and the plugin rule
  * `@typescript-eslint/no-unused-vars`.
@@ -76,6 +61,15 @@ function createRulesRecord(generator) {
  *  The generated linter rules to forbid the restricted items.
  */
 export function generateRestrictedRules(fixed, options) {
+    const RESTRICTED_GLOBALS = [
+        { name: "isFinite", message: "Use 'Number.isFinite' instead." },
+        { name: "isNaN", message: "Use 'Number.isNaN' instead." },
+    ];
+    const RESTRICTED_SYNTAX = [
+        { selector: ":matches(PropertyDefinition, MethodDefinition[kind!='constructor'])[accessibility='public']", message: "Remove 'public' keyword." },
+        { selector: ":matches(PropertyDefinition, MethodDefinition[kind!='constructor'])[accessibility='private']" + (options?.nativeDecorators ? "" : "[decorators.length=0]"), message: "Use #private syntax instead." },
+        { selector: "MethodDefinition[kind='constructor'] TSParameterProperty[accessibility]", message: "Use explicit class properties." },
+    ];
     // restricted items for all files in the environment
     const items = {
         globals: concatArrays(RESTRICTED_GLOBALS, fixed.globals, options?.globals),

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

@@ -1,23 +1,3 @@
-/*
- * @copyright Copyright (c) Open-Xchange GmbH, Germany <info@open-xchange.com>
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with OX App Suite. If not, see <https://www.gnu.org/licenses/agpl-3.0.txt>.
- *
- * Any use of the work other than as authorized under this license or copyright law is prohibited.
- *
- */
 import { posix, sep } from "node:path";
 import { lstatSync } from "node:fs";
 import pm from "picomatch";

package/doc/eslint/README.md

@@ -57,7 +57,7 @@ export default [
     ignores: ["dist/*", "external/**/*.yaml"],
     language: { ecmaVersion: 2024, sourceType: "commonjs" },
     license: resolve("./license.txt"),
-    stylistic: { quotes: "double", semi: true },
+    stylistic: { quotes: "double", semi: "always" },
   }),
 ]
 ```

package/doc/eslint/env/browser.md

@@ -32,8 +32,23 @@ The option `restricted` is an object with the following properties:
 | `imports` | `EnvRestrictedName[]` | `[]` | Banned modules that must not be imported. Each entry is an object with string properties `name` and `message`. |
 | `properties` | `EnvRestrictedProperty[]` | `[]` | Banned object properties. Each entry is an object with string properties `object`, `property`, and `message`). |
 | `syntax` | `EnvRestrictedSyntax[]` | `[]` | Banned syntax constructs by [AST selectors](https://eslint.org/docs/latest/extend/selectors). Each entry is an object with string properties `selector` and `message`. |
+| `nativeDecorators` | `boolean` | `false` | Whether the environment supports native decorators. In this case, it will be required to replace decorated TypeScript `private` methods with native `#private` methods (TypeScript's experimental decorators cannot be used with native `#private` fields). |
 | `overrides` | `EnvRestrictedOverride[]` | `[]` | Overrides for specific subsets of files in the environment. Each entry is an object with the common properties `files` (required) and `ignores`, and the properties `globals`, `imports`, `properties`, and `syntax` to specify restricted items (see above). All restricted items of overrides will be merged with the common restricted items defined for the entire environment. |
 
+The environment `env.browser` already defines the following built-in restrictions:
+
+| Type | Name | Description |
+| - | - | - |
+| Globals | [`isFinite`](https://devdocs.io/javascript/global_objects/isfinite) | Use [`Number.isFinite`](https://devdocs.io/javascript/global_objects/number/isfinite) instead. |
+| | [`isNaN`](https://devdocs.io/javascript/global_objects/isnan) | Use [`Number.isNaN`](https://devdocs.io/javascript/global_objects/number/isnan) instead. |
+| | [Confusing browser globals](https://github.com/facebook/create-react-app/tree/main/packages/confusing-browser-globals) | Globals such as `name` and `event` should not be used to catch typos in function parameters etc. |
+| Properties | [`Object.hasOwn`](https://devdocs.io/javascript/global_objects/object/hasown) | Not yet supported by all browsers. |
+| Syntax | TypeScript `public` class field modifier | Can be omitted (except for constructors of classes deriving from a class with protected constructor). |
+| | TypeScript `private` class field modifier | Use native `#private` class fields. |
+| | [TypeScript parameter properties](https://www.typescriptlang.org/docs/handbook/2/classes.html#parameter-properties) | Use explicit class properties. |
+| | [Static class initialization blocks](https://www.typescriptlang.org/docs/handbook/2/classes.html#static-blocks-in-classes) | Not yet supported by all browsers. |
+| | Module exports of [TypeScript const enumerations](https://devdocs.io/typescript~5.1/enums#enums-at-compile-time) | Not compatible with bundlers running in isolated modules mode (ESBuild). |
+
 ## Example
 
 ```js

package/doc/eslint/env/node.md

@@ -25,6 +25,16 @@ function node(options: EnvNodeOptions): Linter.FlatConfig[]
 
 This option allows to specify banned globals, imports, object properties, and syntax constructs. See [documentation in `env.browser`](./browser.md#option-restricted) for a detailed description.
 
+The environment `env.node` already defines the following built-in restrictions:
+
+| Type | Name | Description |
+| - | - | - |
+| Globals | [`isFinite`](https://devdocs.io/javascript/global_objects/isfinite) | Use [`Number.isFinite`](https://devdocs.io/javascript/global_objects/number/isfinite) instead. |
+| | [`isNaN`](https://devdocs.io/javascript/global_objects/isnan) | Use [`Number.isNaN`](https://devdocs.io/javascript/global_objects/number/isnan) instead. |
+| Syntax | TypeScript `public` class field modifier | Can be omitted (except for constructors of classes deriving from a class with protected constructor). |
+| | TypeScript `private` class field modifier | Use native `#private` class fields. |
+| | [TypeScript parameter properties](https://www.typescriptlang.org/docs/handbook/2/classes.html#parameter-properties) | Use explicit class properties. |
+
 ## Example
 
 ```js

package/package.json

@@ -1,6 +1,7 @@
 {
+    "$schema": "https://json.schemastore.org/package",
     "name": "@open-xchange/linter-presets",
-    "version": "0.1.0",
+    "version": "0.1.2",
     "description": "Configuration presets for ESLint and StyleLint",
     "repository": {
         "url": "https://gitlab.open-xchange.com/fspd/npm-packages/linter-presets"
@@ -62,7 +63,6 @@
     "devDependencies": {
         "@types/confusing-browser-globals": "1.0.3",
         "@types/eslint__js": "8.42.3",
-        "@types/json-schema": "7.0.15",
         "@types/picomatch": "3.0.0",
         "@typescript-eslint/utils": "7.16.0",
         "eslint": "9.6.0",

package/renovate.json

@@ -0,0 +1,10 @@
+{
+    "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+    "extends": [
+        "config:recommended"
+    ],
+    "lockFileMaintenance": {
+        "enabled": true
+    },
+    "configMigration": true
+}