Add ESLint (#167)

Author: MattiasBuelens

.github/workflows/lint.yml

@@ -0,0 +1,24 @@
+name: Lint
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+jobs:
+  pr-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+          submodules: true
+      - name: Use Node.js 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run check-format
+      - run: npm run lint

docusaurus.config.ts

@@ -269,7 +269,9 @@ const config: Config = {
     parseFrontMatter: async (params) => {
       const result = await params.defaultParseFrontMatter(params);
       const { frontMatter } = result;
-      let { docPluginId, docPath } = parseDocPath(params.filePath);
+      const parsedDocPath = parseDocPath(params.filePath);
+      const { docPluginId } = parsedDocPath;
+      let { docPath } = parsedDocPath;
       if (docPath.startsWith('external/')) {
         // Add a slug to all external doc pages
         frontMatter.slug ??= docPath
@@ -464,10 +466,6 @@ function isMarkdownUrl(href: string): boolean {
   return /\.mdx?(?:#|$)/.test(href);
 }
 
-function hasProtocol(url: string): boolean {
-  return /^(?:\w*:|\/\/)/.test(url);
-}
-
 function externalDocUrl(docPath: string): string {
   const [, projectName, externalDocPath] = docPath.match(/\bexternal\/([^/]+)\/(.+)$/);
   return `https://github.com/THEOplayer/${projectName}/blob/-/${externalDocPath}`;

eslint.config.mjs

@@ -0,0 +1,47 @@
+import globals from 'globals';
+import pluginJs from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import pluginReact from 'eslint-plugin-react';
+import reactCompiler from 'eslint-plugin-react-compiler';
+import reactHooks from 'eslint-plugin-react-hooks';
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+  {
+    files: ['**/*.{js,mjs,cjs,ts,jsx,tsx}'],
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+      },
+    },
+    plugins: {
+      'react-compiler': reactCompiler,
+      'react-hooks': reactHooks,
+    },
+    settings: {
+      react: {
+        version: 'detect',
+      },
+    },
+  },
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended,
+  pluginReact.configs.flat.recommended,
+  pluginReact.configs.flat['jsx-runtime'],
+  {
+    rules: {
+      'react-compiler/react-compiler': 'error',
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-namespace': 'off',
+      '@typescript-eslint/no-require-imports': 'off',
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          varsIgnorePattern: '^_|^React$',
+        },
+      ],
+      ...reactHooks.configs.recommended.rules,
+    },
+  },
+];