Fix linting (#12)

* * add .editorconfig
* fix linting, extend from pixi eslint config and add react linter
* fix TS configuration
* install prettier
* add automatic react transform

* apply linting/prettier to codebase

* tweak things

* add nvmrc

* add husky lint-staged

* update PR GH actions

* fix type checking and remove unnecessary React imports / disabled eslint rules

* ignore eslint cache

* remove prettier:check as it doesn't like the final eslint rules

* switch back to 125 length and 4 indent

---------

Co-authored-by: Alex Prokop <[email protected]>

.editorconfig

@@ -0,0 +1,10 @@
+# This file is for unifying the coding style for different editors and IDEs.
+# More information at http://EditorConfig.org
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2

.eslintrc.js

@@ -0,0 +1,31 @@
+module.exports = {
+    root: true,
+    extends: ['@pixi/eslint-config', 'plugin:react/recommended', 'plugin:react/jsx-runtime'],
+    parserOptions: {
+        project: ['tsconfig.eslint.json'],
+        tsconfigRootDir: __dirname,
+    },
+    settings: {
+        jsdoc: {
+            mode: 'typescript',
+            tagNamePreference: {
+                method: 'method',
+                function: 'function',
+                extends: 'extends',
+                typeParam: 'typeParam',
+                api: 'api',
+            },
+        },
+    },
+    ignorePatterns: ['build', 'node_modules'],
+    rules: {
+        'no-empty-function': 0,
+        'no-prototype-builtins': 0,
+        'spaced-comment': [1, 'always', { markers: ['/'] }],
+        '@typescript-eslint/triple-slash-reference': [1, { path: 'always' }],
+        '@typescript-eslint/consistent-type-imports': [1, { disallowTypeAnnotations: false }],
+        '@typescript-eslint/no-parameter-properties': 1,
+        '@typescript-eslint/type-annotation-spacing': 1,
+        '@typescript-eslint/ban-ts-comment': ['error', { 'ts-ignore': 'allow-with-description' }],
+    },
+};

.github/workflows/pr.yml

@@ -10,7 +10,7 @@ jobs:
             - uses: actions/checkout@v3
             - uses: actions/setup-node@v3
               with:
-                  node-version: '16'
+                  node-version: '18'
                   cache: 'npm'
             - run: npm ci
             - run: npm run types

.gitignore

@@ -20,3 +20,4 @@ yarn-debug.log*
 yarn-error.log*
 .vscode
 .idea
+.eslintcache

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged

.nvmrc

@@ -0,0 +1 @@
+v18

.prettierignore

@@ -0,0 +1,12 @@
+**/.docusaurus
+**/.git
+**/.github
+**/.idea
+**/node_modules
+*.frag
+*.vert
+/build
+
+# TODO: just temporarily ignore these
+/blog
+/docs

.prettierrc

@@ -0,0 +1,7 @@
+{
+    "singleQuote": true,
+    "trailingComma": "all",
+    "useTabs": false,
+    "tabWidth": 4,
+    "printWidth": 125
+}

babel.config.js

@@ -1,3 +1,11 @@
 module.exports = {
-  presets: [require.resolve('@docusaurus/core/lib/babel/preset')]
-}
+    presets: [
+        require.resolve('@docusaurus/core/lib/babel/preset'),
+        [
+            require.resolve('@babel/preset-react'),
+            {
+                runtime: 'automatic',
+            },
+        ],
+    ],
+};