@mountainpass/problem-document 0.0.39 → 0.0.42

package/.cspell.json

@@ -0,0 +1,126 @@
+{
+  "language": "en-GB",
+  "words": [
+    "MarkMcCulloh",
+    "vscode-projen",
+    "dbaeumer",
+    "vscode-eslint",
+    "streetsidesoftware",
+    "code-spell-checker",
+    "adam-bender",
+    "commit-message-editor",
+    "commitlint",
+    "cli",
+    "config-conventional",
+    "mountainpass",
+    "cool-bits-for-projen",
+    "types",
+    "http-status-codes",
+    "jest",
+    "node",
+    "typescript-eslint",
+    "eslint-plugin",
+    "parser",
+    "cspell",
+    "eslint-config-prettier",
+    "eslint-import-resolver-node",
+    "eslint-import-resolver-typescript",
+    "eslint-plugin-import",
+    "eslint-plugin-jsdoc",
+    "eslint-plugin-prettier",
+    "eslint-plugin-unicorn",
+    "eslint",
+    "husky",
+    "jest-junit",
+    "json-schema",
+    "npm-check-updates",
+    "prettier",
+    "projen",
+    "standard-version",
+    "ts-jest",
+    "ts-node",
+    "typescript",
+    "projenrc",
+    "docgen",
+    "unbump",
+    "lcov",
+    "cobertura",
+    "applypatch-msg",
+    "pre-applypatch",
+    "post-applypatch",
+    "pre-commit",
+    "pre-merge-commit",
+    "prepare-commit-msg",
+    "commit-msg",
+    "post-commit",
+    "pre-rebase",
+    "post-checkout",
+    "post-merge",
+    "pre-push",
+    "pre-receive",
+    "update",
+    "proc-receive",
+    "post-receive",
+    "post-update",
+    "reference-transaction",
+    "push-to-checkout",
+    "pre-auto-gc",
+    "post-rewrite",
+    "sendemail-validate",
+    "fsmonitor-watchman",
+    "p4-changelist",
+    "p4-prepare-changelist",
+    "p4-post-changelist",
+    "p4-pre-submit",
+    "post-index-change"
+  ],
+  "dictionaryDefinitions": [
+    {
+      "name": "project-words",
+      "path": "./.project-words.txt",
+      "addWords": true
+    }
+  ],
+  "dictionaries": [
+    "project-words"
+  ],
+  "ignorePaths": [
+    "docs",
+    ".commitlintrc.json",
+    ".eslintrc.json",
+    ".gitattributes",
+    ".github/pull_request_template.md",
+    ".github/workflows/build.yml",
+    ".github/workflows/pull-request-lint.yml",
+    ".github/workflows/release.yml",
+    ".github/workflows/upgrade-main.yml",
+    ".gitignore",
+    ".husky/commit-msg",
+    ".husky/pre-commit",
+    ".husky/pre-push",
+    ".mergify.yml",
+    ".npmignore",
+    ".prettierignore",
+    ".prettierrc.json",
+    ".projen/deps.json",
+    ".projen/files.json",
+    ".projen/tasks.json",
+    ".vscode/extensions.json",
+    "CODE_OF_CONDUCT.md",
+    "LICENSE",
+    "package.json",
+    "tsconfig.dev.json",
+    "tsconfig.json",
+    ".cspell.json"
+  ],
+  "overrides": [
+    {
+      "language": "en",
+      "filename": "CODE_OF_CONDUCT.md",
+      "words": [
+        "socio-economic"
+      ]
+    }
+  ],
+  "//": "~~ Generated by projen. To modify, edit .projenrc.js and run \"npx projen\"."
+}

package/.gitattributes

@@ -2,17 +2,18 @@
 
 *.snap linguist-generated
 /.commitlintrc.json linguist-generated
+/.cspell.json linguist-generated
 /.eslintrc.json linguist-generated
 /.gitattributes linguist-generated
-/.github/dependabot.yml linguist-generated
 /.github/pull_request_template.md linguist-generated
-/.github/workflows/auto-approve.yml linguist-generated
 /.github/workflows/build.yml linguist-generated
 /.github/workflows/pull-request-lint.yml linguist-generated
 /.github/workflows/release.yml linguist-generated
+/.github/workflows/upgrade-main.yml linguist-generated
 /.gitignore linguist-generated
 /.husky/commit-msg linguist-generated
 /.husky/pre-commit linguist-generated
+/.husky/pre-push linguist-generated
 /.mergify.yml linguist-generated
 /.npmignore linguist-generated
 /.prettierignore linguist-generated
@@ -21,6 +22,8 @@
 /.projen/deps.json linguist-generated
 /.projen/files.json linguist-generated
 /.projen/tasks.json linguist-generated
+/.vscode/extensions.json linguist-generated
+/CODE_OF_CONDUCT.md linguist-generated
 /LICENSE linguist-generated
 /package.json linguist-generated
 /tsconfig.dev.json linguist-generated

package/.husky/commit-msg

@@ -1,3 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
+npx --no -- cspell lint --show-suggestions "${1}"
 npx --no -- commitlint --edit "${1}"

package/.husky/pre-commit

@@ -1,4 +1,3 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
-npm run test:update
-npm run eslint
+git diff --name-only --staged | npx cspell lint --dot --gitignore --show-suggestions --no-must-find-files --file-list stdin

package/.husky/pre-push

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+npm run test
+npm run eslint

package/.project-words.txt

@@ -0,0 +1,2 @@
+Hubber
+deps

package/.projenrc.ts

@@ -1,35 +1,58 @@
-import { MountainPassTypeScriptProject } from "@mountainpass/projen-typescript-library";
-// import { typescript, JsonFile, TextFile } = require("projen");
+import {
+  CodeOfConduct,
+  GitHubber,
+  NpmReleaser,
+  Organisational,
+  Recommended,
+} from "@mountainpass/cool-bits-for-projen";
+import { NpmAccess } from "projen/lib/javascript";
+import { TypeScriptProject } from "projen/lib/typescript";
 
-const project = new MountainPassTypeScriptProject({
+const gitHubber = new GitHubber({
   name: "problem-document",
-  deps: [] /* Runtime dependencies of this module. */,
+  username: "mountain-pass",
+});
+
+const npmReleaser = new NpmReleaser(gitHubber, {
+  scope: "mountainpass",
+  access: NpmAccess.PUBLIC,
+  release: true,
+});
+
+const organisational = new Organisational({
+  organisation: {
+    name: "Mountain Pass",
+    email: "info@mountain-pass.com.au",
+    url: "https://mountain-pass.com.au",
+  },
+});
+
+const project = new TypeScriptProject({
+  ...gitHubber.nodeProjectOptions(),
+  ...organisational.nodeProjectOptions(),
+  ...npmReleaser.nodeProjectOptions(),
+  ...Recommended.defaultProjectOptions,
   description:
     "A basic RFC7807 Problem Details document with basic type checking and autocomplete" /* The description is just a string that helps people understand the purpose of the package. */,
+  deps: [] /* Runtime dependencies of this module. */,
   devDeps: [
     "http-status-codes",
     "@types/http-status-codes",
-    "@mountainpass/projen-typescript-library",
-    // "typedoc@^0.22.15"
-    // "eslint-config-standard": "^16.0.2",
-    // "eslint-plugin-chai-friendly": "^0.7.1",
-    // "eslint-plugin-eslint-comments": "^3.2.0",
-    // "eslint-plugin-import": "^2.22.1",
-    // "eslint-plugin-istanbul": "^0.1.2",
-    // "eslint-plugin-json": "^3.0.0",
-    // "eslint-plugin-markdown": "^2.1.0",
-    // "eslint-plugin-md": "^1.0.19",
-    // "eslint-plugin-node": "^11.1.0",
-    // "eslint-plugin-promise": "^5.1.0",
-    // "eslint-plugin-security": "^1.4.0",
+    "@mountainpass/cool-bits-for-projen",
   ] /* Build dependencies for this module. */,
   keywords: ["problem-details", "rfc7807"],
-  repositoryUrl: `https://github.com/mountain-pass/problem-document.git`,
-  author: "Mountain Pass",
-  authorAddress: "info@mountain-pass.com.au",
   defaultReleaseBranch: "main",
+  projenrcTs: true,
+});
+
+const recommended = new Recommended(project, {
+  cSpellOptions: { language: "en-GB", ignorePaths: ["docs"] },
 });
 
-project.addContributors("Tom Howard <tom@mountainpass.com.au>");
+new CodeOfConduct(
+  project,
+  { contactMethod: "tom@mountain-pass.com.au" },
+  { cSpell: recommended.cSpell }
+);
 
 project.synth();

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+tom@mountain-pass.com.au.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

package/README.md

@@ -1,13 +1,71 @@
 # problem-document
 
-A basic RFC7807 Problem Details document with basic type checking and autocomplete A basic RFC7807 Problem Details document with basic type checking and autocomplete
+A basic [RFC7807](https://datatracker.ietf.org/doc/html/rfc7807) Problem Details document with basic type checking and autocomplete
 
+[![License](https://img.shields.io/github/license/mountain-pass/problem-document?logo=apache)](https://github.com/mountain-pass/problem-document/blob/master/LICENSE) [![npm](https://img.shields.io/npm/v/@mountainpass/problem-document?logo=npm)](https://www.npmjs.com/package/@mountainpass/problem-document) [![npm downloads](https://img.shields.io/npm/dm/@mountainpass/problem-document?logo=npm)](https://www.npmjs.com/package/@mountainpass/problem-document)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmountain-pass%2Fproblem-document.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmountain-pass%2Fproblem-document?ref=badge_shield)
 
+[![Build Status](https://img.shields.io/github/workflow/status/mountain-pass/problem-document/release?logo=github)](https://github.com/mountain-pass/problem-document/actions/workflows/release.yml) [![GitHub issues](https://img.shields.io/github/issues/mountain-pass/problem-document?logo=github)](https://github.com/mountain-pass/problem-document/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/mountain-pass/problem-document?logo=github)](https://github.com/mountain-pass/problem-document/pulls)
 
+<!-- [![Quality](https://img.shields.io/codacy/grade/940768d54f7545f7b42f89b26c23c751?logo=codacy)](https://www.codacy.com/gh/mountain-pass/problem-document/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=mountain-pass/problem-document&amp;utm_campaign=Badge_Grade) [![Coverage](https://img.shields.io/codacy/coverage/940768d54f7545f7b42f89b26c23c751?logo=codacy)](https://www.codacy.com/gh/mountain-pass/problem-document/dashboard?utm_source=github.com&utm_medium=referral&utm_content=mountain-pass/problem-document&utm_campaign=Badge_Coverage) -->
+
+[![source code vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/mountain-pass/problem-document?label=source%20code%20vulnerabilities&logo=snyk)](https://snyk.io/test/github/mountain-pass/problem-document) [![npm package vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/@mountainpass/problem-document@latest?label=npm%20package%20vulnerabilties&logo=snyk)](https://snyk.io/test/npm/@mountainpass/problem-document/latest)
+
+
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
+
+![I love badges](https://img.shields.io/badge/%E2%99%A5%20i%20love-%20badges-green?logo=heart)
+
+<!-- [![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard) -->
+
+## Installation
+
+### npm
+
+run the following command in your project
+
+```sh
+npm install @mountainpass/problem-document
+```
+
+### yarn
+
+run the following command in your project
+
+```sh
+yarn add @mountainpass/problem-document
+```
+
+### projen
+
+Add `@mountainpass/problem-document` to your `deps` in your `.projen.js` or `projen.ts`. e.g.
 
 ```js
-let foo = bar
-foo.forEach(efddd => {
-    efddd = 24
-})
+///...
+const project = new NodeProject({
+    //...
+    deps: [
+        //...
+        '@mountainpass/problem-document'
+    ]
+});
+```
+
+and run `npx projen`
+
+## Usage
+
+```js
+import { ProblemDocument } from "@mountainpass/problem-document";
+
+//...
+const problemDocument = new ProblemDocument({
+    type: "https://example.com/probs/out-of-credit",
+    title: "You do not have enough credit.",
+    detail: "Your current balance is 30, but that costs 50.",
+    instance: "/account/12345/msgs/abc",
+    balance: 30,
+    accounts: ["/account/12345",
+                 "/account/67890"]
+  });
 ```

package/package.json

@@ -11,33 +11,36 @@
     "clobber": "npx projen clobber",
     "compile": "npx projen compile",
     "default": "npx projen default",
-    "docgen": "npx projen docgen",
     "eject": "npx projen eject",
     "eslint": "npx projen eslint",
     "package": "npx projen package",
     "post-compile": "npx projen post-compile",
+    "post-upgrade": "npx projen post-upgrade",
     "pre-compile": "npx projen pre-compile",
     "prepare": "npx projen prepare",
     "release": "npx projen release",
+    "spellcheck": "npx projen spellcheck",
     "test": "npx projen test",
     "test:update": "npx projen test:update",
     "test:watch": "npx projen test:watch",
     "unbump": "npx projen unbump",
+    "upgrade": "npx projen upgrade",
     "watch": "npx projen watch",
     "projen": "npx projen"
   },
   "author": {
     "name": "Mountain Pass",
     "email": "info@mountain-pass.com.au",
+    "url": "https://mountain-pass.com.au",
     "organization": true
   },
   "devDependencies": {
-    "@commitlint/cli": "^16.2.4",
-    "@commitlint/config-conventional": "^16.2.4",
-    "@mountainpass/projen-typescript-library": "^0.1.8",
+    "@commitlint/cli": "^17.0.2",
+    "@commitlint/config-conventional": "^17.0.2",
+    "@mountainpass/cool-bits-for-projen": "^0.1.8",
     "@types/http-status-codes": "^1.2.0",
     "@types/jest": "^27.4.1",
-    "@types/node": "^12",
+    "@types/node": "^14",
     "@typescript-eslint/eslint-plugin": "^5",
     "@typescript-eslint/parser": "^5",
     "cspell": "*",
@@ -46,21 +49,20 @@
     "eslint-import-resolver-node": "^0.3.6",
     "eslint-import-resolver-typescript": "^2.7.1",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jsdoc": "^39.2.9",
-    "eslint-plugin-jsdoc-typescript": "^2.1.0",
+    "eslint-plugin-jsdoc": "^39.3.2",
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-unicorn": "^42.0.0",
     "http-status-codes": "^2.2.0",
-    "husky": "^7.0.4",
+    "husky": "^8.0.1",
     "jest": "^27",
     "jest-junit": "^13",
     "json-schema": "^0.4.0",
+    "npm-check-updates": "^12",
     "prettier": "^2.6.2",
-    "projen": "^0.54.50",
+    "projen": "^0.56.35",
     "standard-version": "^9",
     "ts-jest": "^27",
     "ts-node": "^9",
-    "typedoc": "^0.22.15",
     "typescript": "^4.6.3"
   },
   "keywords": [
@@ -73,19 +75,11 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.0.39",
+  "version": "0.0.42",
   "bugs": {
     "url": "https://github.com/mountain-pass/problem-document/issues"
   },
   "jest": {
-    "coverageThreshold": {
-      "global": {
-        "branches": 100,
-        "functions": 100,
-        "lines": 100,
-        "statements": 100
-      }
-    },
     "testMatch": [
       "<rootDir>/src/**/__tests__/**/*.ts?(x)",
       "<rootDir>/(test|src)/**/?(*.)+(spec|test).ts?(x)"
@@ -127,7 +121,8 @@
   },
   "types": "lib/index.d.ts",
   "contributors": [
-    "Tom Howard <tom@mountainpass.com.au>"
+    "Tom Howard <tom@windyroad.com.au>",
+    "dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>"
   ],
   "//": "~~ Generated by projen. To modify, edit .projenrc.js and run \"npx projen\"."
 }

package/cspell.json

@@ -1,13 +0,0 @@
-{
-  "language": "en-GB",
-  "words": [
-    "commitlint",
-    "docgen",
-    "projen",
-    "projenrc",
-    "unbump",
-    "mountainpass",
-    "dbaeumer",
-    "outdir"
-  ]
-}