feat: repo initialization

This initializes the repository with the first version of koa-errors.

.coveralls.yml

@@ -0,0 +1 @@
+repo_token: jyEn0tYE7FhGSuklIHyqYBH4PI2rw5lup

.eslintrc

@@ -0,0 +1,9 @@
+{
+    "extends": ["standard"],
+    "rules": {
+        "no-unused-expressions": "off",
+        "comma-dangle": ["error", "always-multiline"],
+        "no-multi-spaces": ["error", { "ignoreEOLComments": true }],
+        "no-console": "error"
+    }
+}

.github/workflows/pr-check.yml

@@ -0,0 +1,49 @@
+# This workflow will do a clean install of node dependencies,
+# build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+
+    - run: node --version
+    - run: npm --version
+
+    - name: Install pnpm
+      run: npm i -g pnpm
+
+    - name: Install npm dependencies
+      run: pnpm install
+
+    - name: Lint the code
+      run: pnpm run lint
+
+    - name: Run tests
+      run: pnpm run test:coverage:ci
+      env:
+        CI: true
+
+    - name: Coveralls
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}

.npmrc

@@ -0,0 +1 @@
+save-prefix=~

.nvmrc

@@ -0,0 +1 @@
+16.13.0

CONTRIBUTING.md

@@ -0,0 +1,139 @@
+# How to Contribute
+
+## Pull Requests
+
+Generally we like to see pull requests that:
+
+-   Maintain the existing code style
+-   Are focused on a single change (i.e. avoid large refactoring or style adjustments in untouched code if not the primary goal of the pull request)
+-   Have [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
+-   Have tests
+-   Do not decrease the current code coverage
+
+## Git Strategy
+
+Use a squash rebase workflow using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), and [trunk based branching](https://trunkbaseddevelopment.com).
+
+Squashing "atomic" commits and rebasing them onto main results in a curated git log/history. We might think of squashing commits as an editing exercise, like the changes we might make while proof reading a message, paper, or article before publishing it. This curation is intended to produce a consistent narrative in the git logs, free of implementation details, such as those that are produced while manually testing and revising code.
+
+Following are some questions we might ask to assess the quality of the commit messages that are submitted in a pull-request (PR).
+
+- Do the commits follow [conventions](https://www.conventionalcommits.org/en/v1.0.0/)
+- Are the commits easy to understand and reason about? Do they contribute to a greater narrative?
+- Will future you be able to reason about the git history by reading through these commit messages?
+- Will a new team member without any context, and with no access to you be able to reason about the git history by reading through these commit messages?
+- Can we connect the commits to the requirements/bug/feature/ticket they are developed for?
+- Would it be easy to debug using `git bisect`?
+- If there are conflicts, are they easy to resolve?
+
+Following are some examples:
+
+#### Fetch from an appropriate origin
+
+```Shell
+git fetch
+git checkout main
+```
+
+#### Create a bug/feature branch
+
+`git checkout -b [BRANCH_NAME]`
+
+#### Do your work
+
+Consider writing "atomic" commits (a commit per unit of work) so it's easier to remember what you did at the end of this workflow
+
+#### When you're ready to submit a PR, rebase from main
+
+```Shell
+git fetch
+git rebase origin/main
+```
+
+#### Find the commit hash (SHA) for commit _before_ the first commit you made on this branch
+
+```Shell
+git log --oneline
+
+# OR if seeing the author and time helps:
+git log --pretty=format:'%C(yellow)%h %C(cyan)%an: %C(reset)%s%C(blue)%d %C(green)%cr%C(reset)'
+```
+
+In the following example, my first commit on this branch is: 09bab93, so the commit I'm looking for is, 907835a.
+
+```
+4b0d519 (HEAD -> features/init) chore: adds private-true to package.json
+533eb56 chore: adds linting rules
+b8591b9 chore: adds ADR for screaming architecture
+0441e8f chore: adds ADR folder to the root-folders ADR
+fdf0ffa chore: adds the src directory, and a README stub
+9352acf chore: adds ADR for root folder organization
+b9d5521 chore: adds ADR directory and README
+9c0601b chore: adds package.lock
+167e102 chore: adds gitignore
+09bab93 chore: initializes the repo
+907835a (origin/main, origin/HEAD, main) chore: creates README
+fe56cd3 chore: creates repo
+```
+
+#### Perform an interactive rebase to that commit
+
+`git rebase -i [SHA]`
+
+Leave the top entry as "pick", and change the rest of the "pick"'s to "squash". After you `:wq`, you will be given an opportunity to rewrite the commit message.
+
+When you're done the following:
+```
+pick 09bab93 chore: initializes the repo
+pick 167e102 chore: adds gitignore
+pick 9c0601b chore: adds package.lock
+pick b9d5521 chore: adds ADR directory and README
+pick 9352acf chore: adds ADR for root folder organization
+pick fdf0ffa chore: adds the src directory, and a README stub
+pick 0441e8f chore: adds ADR folder to the root-folders ADR
+pick b8591b9 chore: adds ADR for screaming architecture
+pick 533eb56 chore: adds linting rules
+pick 4b0d519 chore: adds private:true to package.json
+# Rebase 907835a..4b0d519 onto 907835a (10 commands)
+#
+# Commands: ...
+```
+
+Would look like this:
+```
+pick 09bab93 chore: initializes the repo
+squash 167e102 chore: adds gitignore
+squash 9c0601b chore: adds package.lock
+squash b9d5521 chore: adds ADR directory and README
+squash 9352acf chore: adds ADR for root folder organization
+squash fdf0ffa chore: adds the src directory, and a README stub
+squash 0441e8f chore: adds ADR folder to the root-folders ADR
+squash b8591b9 chore: adds ADR for screaming architecture
+squash 533eb56 chore: adds linting rules
+squash 4b0d519 chore: adds private:true to package.json
+# Rebase 907835a..4b0d519 onto 907835a (10 commands)
+#
+# Commands: ...
+```
+
+After which you would be presented with a commit message editor populated with all of the commit messages that are being squashed together.
+
+> If you want to prepare your commit message ahead of time, the following command will copy to the clipboard, the commit messages since a commit hash: `git log --pretty=format:'%n%C(red)## %s%C(reset)%n%b' -n $(git rev-list 907835a..HEAD --count --reverse) | pbcopy` where 907835a is the commit hash you would use in the above squashing.
+
+#### Push
+
+```Shell
+git branch --set-upstream-to=origin/`git symbolic-ref --short HEAD`
+git push
+
+# You need to force push if you pushed previously
+git push --force
+```
+
+#### If changes occur on main before pushing or merging to main, rebase again
+
+```Shell
+git fetch
+git rebase origin/main
+git push #? --force
+```

README.md

@@ -1,2 +1,44 @@
 # koa-errors
-koa middleware for handling error states (i.e. 500 errors)
+
+![tests](https://github.com/RobotsAndPencils/koa-errors/workflows/tests/badge.svg)
+[![Coverage Status](https://coveralls.io/repos/github/RobotsAndPencils/koa-errors/badge.svg?branch=main)](https://coveralls.io/github/RobotsAndPencils/koa-errors?branch=main)
+
+`@robotsandpencils/koa-errors` is a simple koa middleware for handling error states (i.e. 500 errors). It's primary usage is to produce human, and program readable 500 errors that only include stack traces in development environments.
+
+## Usage
+
+### Node
+
+```Shell
+$ npm install --save @robotsandpencils/koa-errors
+```
+
+```JavaScript
+const { e500 } = require('@robotsandpencils/koa-errors')
+const Koa = require('koa')
+const Router = require('koa-router')
+
+const app = new Koa()
+const router = new Router()
+
+app.on('error', (err, ctx) => {
+  console.log('uncaught_koa_error', err, ctx)
+})
+
+app.use(e500({
+  showStack: process.env.NODE_ENV === 'local',
+}))
+
+router.get('/boom', async (ctx) => {
+  throw new Error('BOOM!')
+})
+
+app.use(router.routes())
+app.listen(3000)
+```
+
+## Arguments
+
+`@robotsandpencils/koa-errors` accepts the following arguments:
+
+-   **showStack**: whether or not to show the stack trace in the response body. Always set this to false in publically accessible environments, such as production.

index.js

@@ -0,0 +1,5 @@
+const blueprint = require('@polyn/blueprint')
+const immutable = require('@polyn/immutable')
+const { e500 } = require('./src/500')({ blueprint, immutable })
+
+module.exports = { e500 }

package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@robotsandpencils/koa-errors",
+  "version": "0.1.0",
+  "description": "Error handler middleware for koa",
+  "private": true,
+  "main": "index.js",
+  "scripts": {
+    "lint": "eslint .",
+    "pre-push": "node pre-push.js",
+    "test": "node test.js",
+    "test:coverage": "nyc node test.js",
+    "test:coverage:ci": "mkdir -p ./coverage && touch ./coverage/lcov.info && nyc pnpm run test:ci && nyc report --reporter=text-lcov > ./coverage/lcov.info",
+    "test:coveralls": "nyc pnpm run test:ci && nyc report --reporter=text-lcov | coveralls",
+    "test:ci": "node test.js -r tap,summary"
+  },
+  "pre-push": [
+    "lint",
+    "test",
+    "pre-push"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/RobotsAndPencils/koa-errors.git"
+  },
+  "author": "Andy Wright <andes.collab@gmail.com> (https://github.com/losandes)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/RobotsAndPencils/koa-errors/issues"
+  },
+  "homepage": "https://github.com/RobotsAndPencils/koa-errors#readme",
+  "keywords": [
+    "koa",
+    "error",
+    "middleware"
+  ],
+  "devDependencies": {
+    "@polyn/logger": "~0.5.2",
+    "coveralls": "~3.1.1",
+    "eslint": "~8.1.0",
+    "eslint-config-standard": "~16.0.3",
+    "eslint-plugin-import": "~2.25.2",
+    "eslint-plugin-node": "~11.1.0",
+    "eslint-plugin-promise": "~5.1.1",
+    "nyc": "~15.0.1",
+    "pre-push": "~0.1.1",
+    "supposed": "~1.1.1",
+    "unexpected": "~11.14.0"
+  },
+  "dependencies": {
+    "@polyn/blueprint": "~2.5.4",
+    "@polyn/immutable": "~1.0.11"
+  }
+}