v5.4.9

.eslintignore

@@ -1,6 +1,16 @@
 # don't ever lint node_modules
 node_modules
-# don't lint build output (make sure it's set to your correct build folder name)
+package-lock.json
+# don't lint build output
+build
 dist
-# don't lint nyc coverage output
-coverage
+# don't lint coverage output
+coverage
+# don't lint workflows etc
+.github
+.idea
+.vscode
+# unsupported file types
+*.yaml
+*.yml
+*.md

.eslintrc.yaml

@@ -0,0 +1,109 @@
+---
+# docs at: https://eslint.org/docs/latest/use/configure/configuration-files
+env:
+  browser: true
+  es2021: true
+  react-native/react-native: true
+extends:
+  - airbnb
+  - airbnb-typescript
+  - airbnb/hooks
+  - eslint:recommended
+  - plugin:@typescript-eslint/recommended
+  - plugin:@typescript-eslint/stylistic
+  - plugin:eslint-comments/recommended
+  - plugin:import/errors
+  - plugin:import/recommended
+  - plugin:import/typescript
+  - plugin:import/warnings
+  - plugin:jsdoc/recommended
+  - plugin:json/recommended
+  - plugin:jsx-a11y/recommended
+  - plugin:react-hooks/recommended
+  - plugin:react-native/all
+  - plugin:react/recommended
+  - prettier
+globals:
+  JSX: true
+parser: '@typescript-eslint/parser'
+parserOptions:
+  ecmaFeatures:
+    jsx: true
+  ecmaVersion: latest
+  project: ./tsconfig.json
+  sourceType: module
+plugins:
+  - '@typescript-eslint'
+  - eslint-comments
+  - eslint-plugin-json
+  - import
+  - jsdoc
+  - jsx-a11y
+  - react
+  - react-hooks
+  - react-native
+rules:
+  '@typescript-eslint/array-type':
+    - error
+    - default: 'generic'
+      readonly: 'generic'
+  '@typescript-eslint/explicit-function-return-type': error
+  '@typescript-eslint/explicit-module-boundary-types': error
+  '@typescript-eslint/no-explicit-any':
+    - error
+    - fixToUnknown: false
+      ignoreRestArgs: false
+  '@typescript-eslint/no-shadow': error
+  '@typescript-eslint/no-use-before-define': error
+  camelcase: error
+  comma-dangle:
+    - error
+    - always-multiline
+  comma-style:
+    - error
+    - last
+  import/extensions:
+    - error
+    - never
+  import/no-unresolved: error
+  jsdoc/check-indentation: error
+  jsdoc/no-bad-blocks: error
+  jsdoc/require-description: error
+  jsdoc/require-file-overview: error
+  jsdoc/require-throws: error
+  jsx-quotes:
+    - error
+    - prefer-single
+  linebreak-style:
+    - error
+    - unix
+  max-lines:
+    - error
+    - 300
+  max-lines-per-function:
+    - warn
+    - max: 20
+  no-console: error
+  no-duplicate-imports: error
+  no-multi-spaces: error
+  no-shadow: error
+  no-template-curly-in-string: error
+  no-trailing-spaces: error
+  no-undef: error
+  no-use-before-define: warn
+  react-native/no-inline-styles: warn
+  react/jsx-filename-extension:
+    - error
+    - extensions:
+        - .ts
+        - .tsx
+        - .js
+        - .jsx
+  react/prop-types: error
+  sort-imports: warn
+  sort-keys:
+    - error
+    - asc
+    - caseSensitive: true
+      minKeys: 2
+      natural: true

.github/workflows/ci.yaml

@@ -0,0 +1,130 @@
+---
+# file format documented at:
+# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  # TODO: check project builds/compiles correctly? maybe with tsc?
+  # TODO: add tests including coverage (jest and mocha/chai?)
+
+  lint_src_files:
+    name: Lint source files
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - run: npm ci
+      - name: Lint source files with Prettier
+        run: >
+          npx prettier --check
+          .
+          --config
+          .prettierrc.yaml
+          --ignore-path
+          .prettierignore
+      - name: Lint source files with ESLint
+        run: >
+          npx eslint
+          .
+          --config
+          .eslintrc.yaml
+          --ignore-path
+          .eslintignore
+
+  check-npm-dependencies:
+    name: Check npm dependencies
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - run: npm ci
+      - name: Scan for known vulnerabilities in dependencies with npm audit
+        run: >
+          npm audit
+          --audit-level
+          critical
+      - name: Check for unused and missing dependencies with depcheck
+        run: >
+          npx depcheck
+          --ignores
+          typescript,prettier
+      - name: Check for outdated packages with npm outdated
+        run: npm outdated
+      - name: Check for outdated packages with npm-check-updates
+        run: npx npm-check-updates
+
+  find_todos:
+    name: Search for TODOs etc
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Search for TODO, FIXME, and BUG statements in source files
+        run: >
+          if grep
+          --recursive
+          --extended-regexp
+          --with-filename
+          --line-number
+          --color=always
+          "TODO|FIXME|BUG"
+          ./src;
+          then exit 1;
+          else
+          echo "No TODO, FIXME, or BUG statements found in source files.";
+          fi
+
+  typos_spell_check:
+    name: Check spelling with typos
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check spelling with typos
+        uses: crate-ci/typos@master
+        with:
+          config: .typos.toml
+
+  lint_markdown_files:
+    name: Lint Markdown files
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: articulate/actions-markdownlint@v1
+        with:
+          files: '*.md'
+          ignore: '**/node_modules'
+
+  lint_yaml_files:
+    name: Lint YAML files
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ibiqlik/action-yamllint@v3
+
+  lint_shell_script_files:
+    name: Lint shell scripts
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: azohra/shell-linter@latest
+
+  commitlint:
+    name: Enforce Conventional Commits
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: >
+          Check the commits conform to the Conventional
+          Commits specification with commitlint
+        uses: wagoid/commitlint-github-action@v5
+
+# TODO: check PRs have all changes (squashed) in(to) 1 commit
+# TODO: make semver automatically bump version num and update changelog
+# TODO: publish new release if version num bumped and CI passes

.github/workflows/publish.yml → .github/workflows/publish.yaml

@@ -1,3 +1,4 @@
+---
 name: "🚀 publish"
 
 on:
@@ -15,4 +16,4 @@ jobs:
           registry-url: https://registry.npmjs.org/
       - run: npm publish
         env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_ACCESS_TOKEN}}
+          NODE_AUTH_TOKEN: ${{secrets.NPM_ACCESS_TOKEN}}

.gitignore

@@ -1,4 +1,6 @@
 node_modules
-
-package-lock.json
-.vscode/*
+#package-lock.json
+# package-lock.json should be in source control.
+# see here: https://stackoverflow.com/questions/44206782/do-i-commit-the-package-lock-json-file-created-by-npm-5
+.vscode/*
+.idea

.npmignore

@@ -1,4 +1,4 @@
 .github/
 node_modules/
-
+examples
 package-lock.json

.prettierignore

@@ -0,0 +1,16 @@
+# don't ever lint node_modules
+node_modules
+package-lock.json
+# don't lint build output
+build
+dist
+# don't lint coverage output
+coverage
+# don't lint workflows etc
+.github
+.idea
+.vscode
+# unsupported file types
+*.yaml
+*.yml
+*.md