Merge pull request #2 from aboutbits/improve-package

Improve package

Author: lukasvice

.eslintignore

@@ -0,0 +1,2 @@
+/dist
+/node_modules

.eslintrc.json

@@ -1,41 +1,69 @@
 {
+  "root": true,
   "parser": "@typescript-eslint/parser",
   "env": {
-    "node": true,
     "browser": true,
-    "es6": true,
-    "commonjs": true
+    "es2020": true
   },
   "plugins": [
     "@typescript-eslint",
     "import",
+    "react",
+    "react-hooks",
     "prettier",
     "formatjs"
   ],
   "extends": [
+    "eslint:recommended",
     "plugin:@typescript-eslint/recommended",
-    "plugin:prettier/recommended",
+    "plugin:react/recommended",
+    "plugin:react/jsx-runtime",
     "plugin:import/recommended",
     "plugin:import/typescript",
-    "plugin:jest/recommended"
+    "plugin:prettier/recommended"
   ],
-  "parserOptions": {
-    "sourceType": "module",
-    "ecmaVersion": 2018
+  "settings": {
+    "react": {
+      "version": "detect"
+    }
   },
   "rules": {
+    "react-hooks/rules-of-hooks": "error",
+    "react-hooks/exhaustive-deps": "warn",
     "@typescript-eslint/no-unused-vars": "error",
     "@typescript-eslint/member-delimiter-style": "off",
     "@typescript-eslint/explicit-function-return-type": "off",
-    "formatjs/enforce-default-message": ["error", "literal"],
-    "formatjs/enforce-placeholders": "error",
-    "formatjs/no-multiple-whitespaces": "error",
-    "formatjs/enforce-id": "error",
     "import/order": [
       "error",
       {
-        "groups": ["builtin", "external", "unknown", "parent", "sibling", "index"]
+        "groups": [
+          "builtin",
+          "external",
+          "unknown",
+          "parent",
+          "sibling",
+          "index"
+        ]
+      }
+    ],
+    "formatjs/enforce-default-message": ["error", "literal"],
+    "formatjs/enforce-placeholders": "error",
+    "formatjs/no-multiple-whitespaces": "error",
+    "formatjs/enforce-id": "error"
+  },
+  "overrides": [
+    {
+      "files": ["*.js"],
+      "env": {
+        "node": true
       }
-    ]
-  }
+    },
+    {
+      "files": ["*.test.ts", "*.test.tsx"],
+      "env": {
+        "jest": true
+      },
+      "extends": ["plugin:jest/recommended"]
+    }
+  ]
 }

.githooks/pre-commit

@@ -4,3 +4,4 @@ set -e
 set -o pipefail
 
 npm run lint
+npm run typecheck

.github/workflows/main.yml

@@ -9,12 +9,11 @@ jobs:
   checks:
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
-          node-version: '16.x'
-          registry-url: 'https://registry.npmjs.org'
-      - uses: actions/cache@v2
+          node-version: 16
+      - uses: actions/cache@v3
         with:
           path: ~/.npm
           key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}

.github/workflows/release-package.yml

@@ -7,7 +7,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: actions/create-release@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -16,10 +16,9 @@ jobs:
           release_name: Release ${{ github.ref }}
           draft: false
           prerelease: false
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v3
         with:
-          node-version: '16.x'
-          registry-url: 'https://registry.npmjs.org'
+          node-version: 16
       - run: npm ci
       - run: npm publish
         env:

.gitignore

@@ -9,3 +9,6 @@
 /node_modules
 /dist
 /translations-template.json
+
+# ESLint
+.eslintcache