chore(docs): added eslint to lint documentation code blocks (#2920)

* docs: added rule for code length * chore: fixes based on vale errors * changed to use eslint * fixes using eslint * added github action for documentation eslint * changed allowed max-length * fixed incorrect heading level * removed comment
2022-12-30 18:44:46 +02:00
parent 99add15fc3
commit d1b4b11ff6
67 changed files with 2611 additions and 1735 deletions
@@ -0,0 +1,121 @@
+module.exports = {
+  root: true,
+  parser: "@babel/eslint-parser",
+  parserOptions: {
+    requireConfigFile: false,
+    ecmaFeatures: {
+      experimentalDecorators: true,
+    },
+  },
+  plugins: ["prettier", "markdown"],
+  extends: [
+    "eslint:recommended",
+    "google",
+    "plugin:prettier/recommended",
+    "plugin:markdown/recommended",
+    "plugin:react/recommended",
+    "plugin:react/jsx-runtime",
+  ],
+  settings: {
+    react: {
+        version: "detect"
+    }
+  },
+  rules: {
+    "no-undef": "off",
+    "no-unused-expressions": "off",
+    "no-unused-vars": "off",
+    "no-unused-labels": "off",
+    "no-console": "off",
+    curly: ["error", "all"],
+    "new-cap": "off",
+    "require-jsdoc": "off",
+    "no-unused-expressions": "off",
+    "no-unused-vars": "off",
+    camelcase: "off",
+    "no-invalid-this": "off",
+    "max-len": [
+      "error",
+      {
+        code: 75,
+      },
+    ],
+    semi: ["error", "never"],
+    quotes: [
+      "error",
+      "double",
+      {
+        allowTemplateLiterals: true,
+      },
+    ],
+    "comma-dangle": [
+      "error",
+      {
+        arrays: "always-multiline",
+        objects: "always-multiline",
+        imports: "always-multiline",
+        exports: "always-multiline",
+        functions: "never",
+      },
+    ],
+    "object-curly-spacing": ["error", "always"],
+    "arrow-parens": ["error", "always"],
+    "linebreak-style": 0,
+    "no-confusing-arrow": [
+      "error",
+      {
+        allowParens: false,
+      },
+    ],
+    "space-before-function-paren": [
+      "error",
+      {
+        anonymous: "always",
+        named: "never",
+        asyncArrow: "always",
+      },
+    ],
+    "space-infix-ops": "off",
+    "eol-last": ["error", "always"],
+    "react/prop-types": "off",
+    "react/jsx-no-undef": "off"
+  },
+  env: {
+    es6: true,
+    node: true,
+  },
+  ignorePatterns: [
+    'docs/content/references/**',
+    'docs/content/advanced/backend/subscribers/events-list.md'
+  ],
+  overrides: [
+    {
+      files: ["docs/content/**/*.md", "docs/content/**/*.mdx"],
+      processor: "markdown/markdown",
+    },
+    {
+      files: [
+        "docs/content/**/*.md/*.js",
+        "docs/content/**/*.mdx/*.js",
+        "docs/content/**/*.md/*.jsx",
+        "docs/content/**/*.mdx/*.jsx",
+      ],
+    },
+    {
+      files: [
+        "docs/content/**/*.md/*.ts",
+        "docs/content/**/*.mdx/*.ts",
+        "docs/content/**/*.md/*.tsx",
+        "docs/content/**/*.mdx/*.tsx",
+      ],
+      plugins: ["@typescript-eslint/eslint-plugin"],
+      extends: ["plugin:@typescript-eslint/recommended"],
+      parser: "@typescript-eslint/parser",
+      rules: {
+        "@typescript-eslint/no-unused-vars": "off",
+        "@typescript-eslint/no-empty-function": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+      },
+    },
+  ],
+}