chore: add editorconfig checks to eslint (#1043)

* chore: add editorconfig checks to eslint

Signed-off-by: Jan Kowalleck <[email protected]>

* tidy

Signed-off-by: Jan Kowalleck <[email protected]>

* tidy

Signed-off-by: Jan Kowalleck <[email protected]>

---------

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

.eslintignore

@@ -9,6 +9,7 @@
 /docs/.venv/**
 /examples/**/dist/**
 
+/res/schema/
 
 !/src/**
 !/libs/**

.eslintrc.js

@@ -21,58 +21,70 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
 
 /**
  * @type {import('eslint').Linter.Config}
- * @see {@link https://eslint.org/}
+ * @see https://eslint.org/
  */
 module.exports = {
   root: true,
   plugins: [
     /* see https://github.com/lydell/eslint-plugin-simple-import-sort#readme */
     'simple-import-sort',
     /* see https://github.com/Stuk/eslint-plugin-header#readme */
-    'header'
+    'header',
+    /* see https://github.com/phanect/eslint-plugin-editorconfig */
+    'editorconfig'
   ],
   env: {
     commonjs: true,
     browser: true,
     node: true
   },
+  extends: [
+    /* see https://github.com/phanect/eslint-plugin-editorconfig */
+    'plugin:editorconfig/all'
+  ],
   rules: {
     // region sort imports/exports
     /* disable other sorters in favour of `simple-import-sort` */
-    'import/order': 0,
-    'sort-imports': 0,
+    'import/order': 'off',
+    'sort-imports': 'off',
     /* see https://github.com/lydell/eslint-plugin-simple-import-sort/ */
     'simple-import-sort/imports': 'error',
     'simple-import-sort/exports': 'error',
     // endregion sort imports/exports
     // region license-header
     /* see https://github.com/Stuk/eslint-plugin-header#readme */
-    'header/header': ['error', './.license-header.js']
+    'header/header': ['error', './.license-header.js'],
     // endregion license-header
+    // indent is managed by plugin '*standard'
+    'editorconfig/indent': 'off'
   },
   overrides: [
+    {
+      files: ['*.node.*'],
+      env: { browser: false, node: true }
+    },
+    {
+      files: ['*.web.*'],
+      env: { browser: true, node: false }
+    },
     {
       files: ['*.spec.*', '*.test.*'],
       env: {
         mocha: true,
-        commonjs: true,
         node: true,
         browser: false // change, when mocha is enabled for browser
       }
     },
     {
       files: ['*.ts'],
-      extends: [
-        /* see https://github.com/standard/ts-standard */
-        'standard-with-typescript'
-      ],
       plugins: [
         /* see https://github.com/microsoft/tsdoc */
         'eslint-plugin-tsdoc'
       ],
-      parserOptions: {
-        project: './tsconfig.json'
-      },
+      extends: [
+        /* see https://github.com/standard/ts-standard */
+        'standard-with-typescript'
+      ],
       rules: {
         // region override rules from plugin 'standard-with-typescript'
         /* @see https://typescript-eslint.io/rules/consistent-type-imports/ */
@@ -91,20 +103,23 @@ module.exports = {
         /* see https://github.com/microsoft/tsdoc */
         'tsdoc/syntax': 'error'
         // endregion docs
+      },
+      parserOptions: {
+        project: './tsconfig.json'
       }
     },
     {
       files: ['*.js', '*.mjs', '*.cjs'],
+      plugins: [
+        /* see https://github.com/gajus/eslint-plugin-jsdoc/ */
+        'jsdoc'
+      ],
       extends: [
         /* see https://www.npmjs.com/package/eslint-config-standard */
         'standard',
         /* see https://github.com/gajus/eslint-plugin-jsdoc */
         'plugin:jsdoc/recommended'
       ],
-      plugins: [
-        /* see https://github.com/gajus/eslint-plugin-jsdoc/ */
-        'jsdoc'
-      ],
       rules: {
         /* see https://github.com/gajus/eslint-plugin-jsdoc */
         'jsdoc/no-undefined-types': 'error',

package.json

@@ -76,11 +76,13 @@
     "@types/mocha": "^10",
     "@types/node": "ts5.4",
     "@types/spdx-expression-parse": "^3",
+    "@typescript-eslint/eslint-plugin": "6.21.0",
     "c8": "^8||^9",
     "deepmerge": "^4.2.2",
     "eslint": "8.57.0",
     "eslint-config-standard": "17.1.0",
     "eslint-config-standard-with-typescript": "43.0.1",
+    "eslint-plugin-editorconfig": "4.0.3",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-jsdoc": "48.2.2",
     "eslint-plugin-simple-import-sort": "12.0.0",

res/schema/.editorconfig

@@ -1,11 +1,9 @@
 
 # fix settings for files that are copied over, to keep them as is
-[*.SNAPSHOT.xsd]
-indent_size = 4
-indent_style = space
-trim_trailing_whitespace = false
-[*.SNAPSHOT.schema.json]
-indent_size = 2
-indent_style = space
-trim_trailing_whitespace = false
-
+[*.SNAPSHOT.*]
+charset = unset
+end_of_line = unset
+insert_final_newline = unset
+trim_trailing_whitespace = unset
+indent_style = unset
+indent_size = unset