feat(lint): Add prettier (#76)

## Problem

Want to add [`prettier`](https://prettier.io/) support mainly to make development easier so that code auto-formats on save. But if we have `prettier,` we might as well integrate it into CI somehow.


## Solution

The solution is multi-pronged:

- Added `.prettierrc.json` and `.vscode/settings.json` in order to have code formatting on save. This applies to all file times `.ts`, `.js`, `.json`, `.md`, etc
- Added a `.github/workflows/format.yml` workflow that runs the `prettier` CLI and overwrites the files with the changes. If there are file changes, it pushes a new auto-commit to the branch with new changes. That way any changes that were missed will get caught by CI. As a result of the push, CI will run _again_ and we can make sure that running `prettier` didn't break any test with malformed files. Since this was the first run of `prettier`, **lots** of files were updated
- Added `prettier` check as part of linting with [`@typescript-eslint/eslint-plugin`](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin). This will fail `benmvp test` if there are malformed files, but most should be fixable when running `benmvp start`
- `benmvp integrate` runs `benmvp test` within the `integration-tests/` project, but it needs the same `.prettierrc.json` so those are copied over as part of the script that runs the integration test

In the end, it'll be the responsibility of `benmvp start` to create a new project with prettier configs. They will be something that each library can change themselves, allowing a bit of configuration, but the idea is that they wouldn't be. I had to make the file part of the host library instead of within `benmvp-cli` in order to make the dev environment work properly.

BREAKING CHANGE: Although CI will auto-format, `benmvp test` will fail because prettier now runs on all the files

Author: benmvp

.github/workflows/ci.yml

@@ -12,23 +12,23 @@ jobs:
         node: [8, 10, 12, 13]
 
     steps:
-    - name: Checkout repo
-      uses: actions/checkout@v1
-
-    - name: Use Node ${{ matrix.node }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node }}
-
-    - name: Install NPM dependencies
-      run: npm ci
-
-    - name: Run unit tests
-      run: npm test
-      env:
-        CI: true
-
-    - name: Run integration tests
-      run: npm run integrate
-      env:
-        CI: true
+      - name: Checkout repo
+        uses: actions/checkout@v1
+
+      - name: Use Node ${{ matrix.node }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Install NPM dependencies
+        run: npm ci
+
+      - name: Run unit tests
+        run: npm test
+        env:
+          CI: true
+
+      - name: Run integration tests
+        run: npm run integrate
+        env:
+          CI: true

.github/workflows/format.yml

@@ -0,0 +1,50 @@
+name: Format files
+
+on:
+  push:
+    branches-ignore:
+      # don't format files on push to master because pushing
+      # to master triggers version releases and we don't want
+      # to trigger a re-release just for formatting. We'll wait
+      # until the next PR to fix the formatting issues
+      - master
+
+jobs:
+  prettier:
+    name: Format files
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v1
+
+      - name: Use Node 12
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12
+
+      - name: Install NPM dependencies
+        run: npm ci
+
+      - name: Format files
+        run: npx prettier --write "**/*.*"
+
+      - name: Show git working tree
+        run: git status
+
+      - name: Commit formatted files on branch
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "Automated Formatter"
+          git add -A
+          # Do nothing if there are no changes
+          git diff-index --quiet HEAD || git commit -m "Automated format of files"
+
+      - name: Push data to repo
+        uses: ad-m/[email protected]
+        with:
+          branch: ${{ github.ref }}
+
+          # Need to use special repo-scoped token so that when
+          # the push happens, it triggers CI again
+          github_token: ${{ secrets.REPO_SCOPED_TOKEN }}

.prettierignore

@@ -0,0 +1,13 @@
+# Ignore dotfiles
+**/.*
+
+# Ignore other extensions prettier doesn't know about
+**/*.sh
+**/*.log
+
+# Ignore NPM files
+**/package.json
+**/package-lock.json
+
+# Ignore all built files
+lib/**/*.*

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "arrowParens": "always"
+}

.vscode/settings.json

@@ -1,6 +1,11 @@
 {
-  "jest.enableInlineErrorMessages": false,
-  "jest.enableSnapshotPreviews": false,
-  "jest.enableSnapshotUpdateMessages": false,
-  "jest.autoEnable": false
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[markdown]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "editor.formatOnSave": true,
+  "json.format.enable": false
 }

CONTRIBUTING.md

@@ -4,12 +4,12 @@ Thank you for your interest in contributing to my CLI!
 
 ## Table of Contents
 
-* [Setup](#setup)
-* [Branches](#using-branches-to-submit-changes)
-* [Keeping up to date](#keeping-your-local-repo-up-to-date)
-* [Creating issues](#creating-issues)
-* [Working on and submitting changes](#working-on-and-submitting-changes)
-* [Steps to submit](#steps-to-submit)
+- [Setup](#setup)
+- [Branches](#using-branches-to-submit-changes)
+- [Keeping up to date](#keeping-your-local-repo-up-to-date)
+- [Creating issues](#creating-issues)
+- [Working on and submitting changes](#working-on-and-submitting-changes)
+- [Steps to submit](#steps-to-submit)
 
 ## Setup
 
@@ -61,4 +61,4 @@ Please try to conform to the coding style of the code base.
 1. Check to make sure that your changes are documented properly (inline comments for interesting lines, READMEs, etc.)
 1. Run `npm test` to ensure that all tests pass, the linter is satisfied and your changes are typescript compliant.
 1. PR titles must be prefixed by the type of changes the PR contains followed by the scope of what the PR touches. We are following the [angular commit guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines). Please use one of `feat, fix, docs, style, refactor, perf, test, chore` as the prefix. The " is the the direct product your changes affect. Example: `chore(build): Add encrypted ssh key for semantic-release` because its a chore and it touches the build. For multiple scope items, you can comma separate 2 or 3 but if there are more than that please use a `*` instead.
-1.  Please use a [closing issue keyword](https://help.github.com/articles/closing-issues-using-keywords/) to indicate the issue that your fix addresses in the description section of the pull request template. Example: `fixes #32` to close issue #32
+1. Please use a [closing issue keyword](https://help.github.com/articles/closing-issues-using-keywords/) to indicate the issue that your fix addresses in the description section of the pull request template. Example: `fixes #32` to close issue #32

README.md

@@ -22,14 +22,14 @@ A highly-opinionated, zero-config CLI for consistent infra for Ben Ilegbodu's Ty
 
 ## ToC
 
-*  [Installation](#installation)
-*  [Quick Usage](#quick-usage)
-*  [Docs](docs/)
-*  [Supported Node Versions](#supported-node-versions)
-*  [Technologies Used](#technologies-used)
-*  [Contributing](CONTRIBUTING.md)
-*  [Project philosophy](#project-philosophy)
-*  [License](LICENSE)
+- [Installation](#installation)
+- [Quick Usage](#quick-usage)
+- [Docs](docs/)
+- [Supported Node Versions](#supported-node-versions)
+- [Technologies Used](#technologies-used)
+- [Contributing](CONTRIBUTING.md)
+- [Project philosophy](#project-philosophy)
+- [License](LICENSE)
 
 ## Installation
 

docs/api/README.md

@@ -8,4 +8,3 @@ The Node API exposes the following functions:
 - [`build()`](build.md) - Builds the library into the desired module formats at the specified location
 - [`integrate()`](integrate.md) - Runs additional integration tests for the library
 - [`run()`](run.md) - Parses the specified array of CLI arguments to runs the desired command
-

docs/api/build.md

@@ -9,23 +9,23 @@ Looking for CLI docs? View companion [`benmvp build` documentation](../cli/build
 Build all module formats in default output directory:
 
 ```js
-import {build} from '@benmvp/cli'
+import { build } from '@benmvp/cli'
 
 build()
 ```
 
 To specify an alternate output directory:
 
 ```js
-import {build} from '@benmvp/cli'
+import { build } from '@benmvp/cli'
 
-build({out: './built'})
+build({ out: './built' })
 ```
 
 To exclude type definitions:
 
 ```js
-import {build} from '@benmvp/cli'
+import { build } from '@benmvp/cli'
 
 build({
   formats: ['esm', 'cjs'],
@@ -35,7 +35,7 @@ build({
 To put ESM & type declarations in an alternate build location with continuous watch:
 
 ```js
-import {build} from '@benmvp/cli'
+import { build } from '@benmvp/cli'
 
 build({
   formats: ['esm', 'type'],

docs/api/create.md

@@ -2,12 +2,16 @@
 
 > NOTE: `create()` is still under development
 
-
 Creates a new library with the specified name set up with infrastructure using `@benmvp/cli`, returning a `Promise` indicating whether the creation succeeded or failed.
 
+It will:
+
 - Add `"test"`, `"start"`, `"build"` and `"integrate"` scripts in the `package.json` to call [`benmvp test`](test.md), [`benmvp start`](start.md), [`benmvp build`](build.md), and [`benmvp integrate`](integrate.md), respectively
 - After the `package.json` is created (or updated), it will install `@benmvp/cli` as a dev dependency, using [Yarn](https://yarnpkg.com/) if available. If Yarn is unavailable, it will fallback to [npm](https://docs.npmjs.com/)
-- Will add (or overwrite) a `.travis.yml` file w/ [build stages](https://docs.travis-ci.com/user/build-stages/) for testing and deploying the library
+- Add (or overwrite) `.prettierrc.json`, `.prettierignore` & `.vscode/settings.json` files to format all code
+- Add (or overwrite) a `.github/workflows/ci.yml` [Github workflow](https://help.github.com/en/actions) for testing your code when a branch is pushed to or a PR is updated.
+- Add (or overwrite) a `.github/workflows/format.yml` [Github workflow](https://help.github.com/en/actions) for formatting your files when a non-`master` branch is pushed to. Formatted code will be pushed as a new commit to the branch.
+- Add (or overwrite) a `.github/workflows/release.yml` [Github workflow](https://help.github.com/en/actions) for release a new version of your package with new commits to `master`.
 
 Looking for CLI docs? View companion [`benmvp create` documentation](../cli/create.md).
 
@@ -16,15 +20,15 @@ Looking for CLI docs? View companion [`benmvp create` documentation](../cli/crea
 Create a new lib named `lib-of-fun` with the default settings (simplest setup):
 
 ```js
-import {create} from '@benmvp/cli'
+import { create } from '@benmvp/cli'
 
-create({name: 'lib-of-fun'})
+create({ name: 'lib-of-fun' })
 ```
 
 Add lint verification to an existing library:
 
 ```js
-import {create} from '@benmvp/cli'
+import { create } from '@benmvp/cli'
 
 create({
   modes: ['lint'],
@@ -34,7 +38,7 @@ create({
 Create a new library named `my-lib` that only outputs ESM format:
 
 ```js
-import {create} from '@benmvp/cli'
+import { create } from '@benmvp/cli'
 
 create({
   name: 'my-lib',
@@ -45,7 +49,7 @@ create({
 Add custom setup to an existing library:
 
 ```js
-import {create} from '@benmvp/cli'
+import { create } from '@benmvp/cli'
 
 create({
   modes: ['type', 'spec'],
@@ -71,10 +75,12 @@ The optional `Options` object supports the following properties:
 The name of the library to create or update.
 
 When `name` is unspecified:
+
 - If a `package.json` does not already exist, it creates a new `package.json` with the name matching the directory it's within.
 - If a `package.json` does exist, it does nothing to the existing `package.json`.
 
 When `name` is specified:
+
 - If a `package.json` does not already exist, it creates a new `package.json` with the specified name.
 - If a `package.json` does exist, it updates the `"name"` property of the `package.json` with specified name.
 
@@ -112,7 +118,6 @@ Optional. Defaults to all modes when unspecified.
 
 This will initialize the `"start"`, `"test"` and `"integrate"` scripts in the `package.json` to pass the matching argument.
 
-
 ## Return Value
 
 `create()` returns a `Promise`.