Merge pull request #8 from mdingena/v3

Version 3.0

Author: mdingena

.eslintignore

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

.eslintrc

@@ -0,0 +1,41 @@
+{
+  "root": true,
+  "env": { "node": true },
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": ["./tsconfig.json", "./scripts/tsconfig.json"]
+  },
+  "plugins": ["@typescript-eslint", "import"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:import/recommended",
+    "plugin:import/typescript",
+    "prettier"
+  ],
+  "settings": {
+    "import/resolver": {
+      "typescript": {
+        "extensions": [".js"],
+        "extensionAlias": {
+          ".js": [".ts"]
+        },
+        "project": ["./tsconfig.json"]
+      }
+    }
+  },
+  "rules": {
+    "no-return-await": "off",
+    "@typescript-eslint/return-await": ["error", "always"],
+    "import/no-unresolved": "error",
+    "import/extensions": ["error", "never", { "js": "always" }],
+    "import/order": [
+      "warn",
+      {
+        "alphabetize": { "order": "asc", "caseInsensitive": false },
+        "groups": ["type", ["builtin", "external", "internal"], "parent", "sibling", "index", "object"],
+        "newlines-between": "always"
+      }
+    ]
+  }
+}

.github/workflows/lint-compile-test.yml

@@ -3,26 +3,25 @@ name: Lint, compile and test
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ['main']
   pull_request:
-    branches: [ "main" ]
+    branches: ['main']
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
         node-version: [20.x]
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm install
-    - run: npm run lint
-    - run: npm run compile
-    - run: npm run test
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install --force
+      - run: npm run lint
+      - run: npm run compile
+      - run: npm run test

.gitignore

@@ -1,4 +1,147 @@
 package-lock.json
-node_modules/
-dist/
 scripts/spawnInfodump.json
+
+# asdf
+
+.tool-versions
+
+# eslint
+
+.eslintcache
+
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log\*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+\*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+\*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+
+typings/
+
+# TypeScript cache
+
+\*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+\*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variables file
+
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.cache
+
+# Next.js build output
+
+.next
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+.cache/
+
+# Comment in the public line in if your project uses Gatsby and _not_ Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port

.husky/pre-commit

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

.lintstagedrc

@@ -1,3 +1,4 @@
 {
-  "**/*.{js,ts,jsx,tsx,json,css,html}": "prettier --write"
+  "src/**/*.{js,ts}": ["eslint --cache --fix"],
+  "+(*.md|src/**/*.{js,ts,json,md})": ["prettier --write"]
 }

.npmignore

@@ -1,4 +1,3 @@
 package-lock.json
 node_modules/
 src/
-tests/

.prettierignore

@@ -1 +1 @@
-build/
+dist/

.prettierrc

@@ -1,5 +1,6 @@
 {
   "arrowParens": "avoid",
+  "jsxSingleQuote": true,
   "printWidth": 120,
   "quoteProps": "preserve",
   "semi": true,

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "node_modules/typescript/lib"
+}