Merge pull request GregRos#60 from sp3ctum/feature/project-maintenance

Various project maintenance related improvements

.github/workflows/pr.yaml

@@ -1,28 +1,28 @@
 name: Node.js CI
 on:
-  pull_request:
-    branches:
-      - master
+    pull_request:
+        branches:
+            - master
 jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version:
-          - 16.x
-    steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
-        with:
-          node-version: '16'
-          cache: npm
-          registry-url: https://registry.npmjs.org
-      - run: npm install
-      - run: npm run build
-      - run: npm run lint:check
-      - run: npm test
-      - name: Coveralls
-        uses: coverallsapp/github-action@master
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+    build:
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                node-version:
+                    - 16.x
+        steps:
+            - uses: actions/checkout@v2
+            - name: Use Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v2
+              with:
+                  node-version: "16"
+                  cache: npm
+                  registry-url: https://registry.npmjs.org
+            - run: npm install
+            - run: npm run build
+            - run: npm run lint:check
+            - run: npm test
+            - name: Coveralls
+              uses: coverallsapp/github-action@master
+              with:
+                  github-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/push.yaml

@@ -1,56 +1,56 @@
 name: Node.js CI
 on:
-  push:
-    branches:
-      - master
-  workflow_dispatch:
+    push:
+        branches:
+            - master
+    workflow_dispatch:
 
 permissions:
-  contents: read
-  pages: write
-  id-token: write
+    contents: read
+    pages: write
+    id-token: write
 
 concurrency:
-  group: "pages"
-  cancel-in-progress: false
+    group: "pages"
+    cancel-in-progress: false
 
 jobs:
-  build_deploy:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version:
-          - 16.x
-    steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
-        with:
-          node-version: '16'
-          cache: npm
-          registry-url: https://registry.npmjs.org
-      - run: npm install
-      - run: npm run build
-      - run: npm run lint:check
-      - run: npm test
-      - name: Coveralls
-        uses: coverallsapp/github-action@master
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-      - run: node_modules/.bin/typedoc --out docs
-      - name: Setup Pages
-        uses: actions/configure-pages@v3
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v2
-        with:
-          path: 'docs'
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v2
-      - name: publish
-        run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+    build_deploy:
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                node-version:
+                    - 16.x
+        steps:
+            - uses: actions/checkout@v2
+            - name: Use Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v2
+              with:
+                  node-version: "16"
+                  cache: npm
+                  registry-url: https://registry.npmjs.org
+            - run: npm install
+            - run: npm run build
+            - run: npm run lint:check
+            - run: npm test
+            - name: Coveralls
+              uses: coverallsapp/github-action@master
+              with:
+                  github-token: ${{ secrets.GITHUB_TOKEN }}
+            - run: node_modules/.bin/typedoc --out docs
+            - name: Setup Pages
+              uses: actions/configure-pages@v3
+            - name: Upload artifact
+              uses: actions/upload-pages-artifact@v2
+              with:
+                  path: "docs"
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v2
+            - name: publish
+              run: npm publish
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.istanbul.yml

@@ -1,13 +1,13 @@
 instrumentation:
-  root: .
-  extensions:
-    - .js
-  default-excludes: true
-  excludes:
-    - "**/*.no-cover.js"
-    - "**/test/**" #no need to instrument this test code! Things references by it remain covered.
-    - "**/functions/**" #many indicators are not utilized so let's ignore them.
-    - "**/implementation/issues.js" #contains things like exception throws, not executable code
-    - "**/basics/result.js" #should not be instrumented
-    - ".obsidian/**" #not executable code
-    - ".github/**" #not executable code
+    root: .
+    extensions:
+        - .js
+    default-excludes: true
+    excludes:
+        - "**/*.no-cover.js"
+        - "**/test/**" #no need to instrument this test code! Things references by it remain covered.
+        - "**/functions/**" #many indicators are not utilized so let's ignore them.
+        - "**/implementation/issues.js" #contains things like exception throws, not executable code
+        - "**/basics/result.js" #should not be instrumented
+        - ".obsidian/**" #not executable code
+        - ".github/**" #not executable code

LICENSE.md

@@ -4,4 +4,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -104,9 +104,9 @@ Dealing with failure is hard, whether you’re realizing you can never be a fath
 
 `parjs` handles it by using the SHF or 😕😬💀 system, which I just made up. It recognizes three kinds of failures:
 
-* 😕 **S**oft failures — A parser quickly says it’s not applicable to the input. Used to parse alternative inputs.
-* 😬 **H**ard failures — Parsing failed unexpectedly. Can only be handled by special combinators.
-* 💀 **F**atal failure — Happen when you decide and tell the parser to [halt and catch fire](<https://en.wikipedia.org/wiki/Halt_and_Catch_Fire_(computing)>). They can’t be handled.
+-   😕 **S**oft failures — A parser quickly says it’s not applicable to the input. Used to parse alternative inputs.
+-   😬 **H**ard failures — Parsing failed unexpectedly. Can only be handled by special combinators.
+-   💀 **F**atal failure — Happen when you decide and tell the parser to [halt and catch fire](<https://en.wikipedia.org/wiki/Halt_and_Catch_Fire_(computing)>). They can’t be handled.
 
 Parsing failures bubble up through combinators unless they’re handled, just like exceptions. Handling a failure always means backtracking to before it happened.
 

documentation/development.md

@@ -0,0 +1,16 @@
+# Development instructions
+
+This project is using [Yarn](https://yarnpkg.com/) as a package manager. The recommendation is to install the latest version of Yarn globally on your system. The version of yarn used for development is specified in the package.json file. The latest versions of yarn will choose the correct version to use automatically.
+
+Common development commands:
+
+```sh
+# install dependencies
+yarn
+
+# build (must be done before testing)
+yarn build
+
+# test (remember to build first to make sure the code is up to date)
+yarn build && yarn test
+```