Merge pull request #27 from wardellbagby/wardell/improve-dx

Author: thadguidry

.eslintrc.js

@@ -0,0 +1,32 @@
+module.exports = {
+  plugins: ["@typescript-eslint", "prettier"],
+  ignorePatterns: ["dist/**/*", "**/node_modules/**"],
+  extends: ["standard-with-typescript", "prettier"],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: true,
+  },
+  rules: {
+    "prettier/prettier": "error",
+    "@typescript-eslint/naming-convention": "off",
+    "@typescript-eslint/restrict-template-expressions": "off",
+    "@typescript-eslint/strict-boolean-expressions": "off",
+  },
+  overrides: [
+    {
+      files: "**/*.js",
+      parserOptions: {
+        project: null,
+      },
+    },
+    {
+      files: "**/*.spec.ts",
+      rules: {
+        "@typescript-eslint/no-dynamic-delete": "off",
+        "@typescript-eslint/no-var-requires": "off",
+      },
+    },
+  ],
+  root: true,
+};

.github/workflows/bundle-check.yml

@@ -0,0 +1,25 @@
+name: "Bundle Check"
+on:
+  pull_request:
+    branches:
+      - "master"
+jobs:
+  check:
+    name: "Bundle Check"
+    runs-on: "ubuntu-22.04"
+    steps:
+      - name: "Checkout the current branch"
+        uses: "actions/checkout@v3"
+      - name: "Setup Node"
+        uses: "actions/setup-node@v3"
+        with:
+          node-version: 18
+      - name: "Install Node modules"
+        run: "npm ci"
+      - name: "Generate new bundle"
+        run: "npm run package"
+      - name: "Verify new bundle matches existing"
+        run: "git diff --exit-code --name-only dist/"
+      - name: "Show message instructing how to commit new bundle"
+        if: failure()
+        run: echo "::error title=Bundle has changed::The bundle has changed since the last commit and the new changes must be committed as part of this PR. Please run 'npm run package' and commit the results to your PR alongside your existing changes."

.github/workflows/lint.yml

@@ -0,0 +1,20 @@
+name: 'Lint'
+on:
+  pull_request:
+    branches:
+      - 'master'
+jobs:
+  lint:
+    name: 'Lint'
+    runs-on: 'ubuntu-22.04'
+    steps:
+      - name: 'Checkout the current branch'
+        uses: 'actions/checkout@v3'
+      - name: 'Setup Node'
+        uses: 'actions/setup-node@v3'
+        with:
+          node-version: 18
+      - name: 'Install Node modules'
+        run: 'npm ci'
+      - name: 'Run lint'
+        run: 'npm run lint'

README.md

@@ -38,7 +38,22 @@ npm run package
 
 and committing the resulting changes that will be in the `dist/` folder.
 
+### Formatting and linting
+
+This project uses [ESLint](https://eslint.org/) for linting and [Prettier](https://prettier.io/) for source code formatting. You can run the lint checks by running:
+
+```shell
+npm run lint
+```
+
+If you have lint errors that are automatically fixable, you can fix those by running:
+
+```shell
+npm run lint:fix
+```
+
 ## Releasing
+
 Releases are done by creating a new tag and pushing that tag to the repo. A new
 release can be made via the following: