Merge branch 'beta' into feature/new-eslint-rules

Author: jrolfs

README.md

@@ -1,19 +1,31 @@
 <div align="center">
 <br>
-<img width="200" src="https://user-images.githubusercontent.com/288160/95671736-22da8400-0b4f-11eb-953c-339440756a3d.png" alt="Hover Web">
+<img width="200" src="https://user-images.githubusercontent.com/288160/95674568-ed8d6080-0b65-11eb-88be-d119c88ee285.png" alt="Hover Web">
 <br>
 <h1>hover-javascript</h1>
-<p>CLI toolbox for common scripts for <strong>JavaScript</strong> and <strong>TypeScript</strong> projects</p></div>
+<p>🧰 Toolbox of scripts and configurations for <strong>JavaScript</strong> and <strong>TypeScript</strong> projects</p></div>
 
----
+<div align="center">
+
+[![Build Status][build-badge]][build-link]
+[![Code Coverage][coverage-badge]][coverage-link]
+[![Version][package-badge]][package-link]
+[![Maintenance][maintenance-badge]][maintenance-link]
+[![Node Version][node-badge]][node-link]
+[![MIT License][license-badge]][license-link]
+[![Code Style][prettier-badge]][prettier-link]
+[![Conventional Commits][conventional-commits-badge]][conventional-commits-link]
+
+</div>
 
-[![Build Status][build-badge]][build]
-[![Code Coverage][coverage-badge]][coverage]
-[![Dependabot Status][dependabot-badge]][dependabot]
-[![version][version-badge]][package] [![MIT License][license-badge]][license]
+<br>
+
+## ✨ Features
 
-This is a CLI that abstracts away all configuration for ~~my~~ **our** open
-source projects for linting, testing, building, and more.
+- 📦 One package to encapsulate most tooling dependencies
+- ⚙️ Common (extensible) configurations to eliminate boilerplate
+- 📏 Conventions that help enforce consistency
+- 🥽 Best practices to help avoid 🦶🏻🔫
 
 ## Contents
 
@@ -23,14 +35,19 @@ source projects for linting, testing, building, and more.
 - [Installation](#installation)
 - [Usage](#usage)
   - [Overriding Config](#overriding-config)
-- [LICENSE](#license)
+    - [ESLint](#eslint)
+    - [Prettier](#prettier)
+    - [Jest](#jest)
+- [License](#license)
+- [Maintenance](#maintenance)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
 ## Installation
 
-This module is distributed via [npm][npm] which is bundled with [node][node] and
-should be installed as one of your project's `devDependencies`:
+This module is distributed via [npm][npm-link] which is bundled with
+[node][node-link] and should be installed as one of your project's
+`devDependencies`:
 
 ```
 yarn add -D @hover/javascript
@@ -58,6 +75,10 @@ and override only the parts of the config you need to.
 This can be a very helpful way to make editor integration work for tools like
 ESLint which require project-based ESLint configuration to be present to work.
 
+> Note: `hover-scripts` intentionally does not merge things for you when you
+> start configuring things to make it less magical and more straightforward.
+> Extending can take place on your terms.
+
 #### ESLint
 
 So, if we were to do this for ESLint, you could create an `.eslintrc.js` with
@@ -97,32 +118,39 @@ module.exports = {
 }
 ```
 
-> Note: `hover-scripts` intentionally does not merge things for you when you
-> start configuring things to make it less magical and more straightforward.
-> Extending can take place on your terms. ~~I~~ _Kent_ think[s] this is actually
-> a great way to do this.
->
-> For the record, so do I (Jamie)
+## License
+
+## Maintenance
 
-## LICENSE
+This project is actively maintained by engineers at
+[@hoverinc][hover-github-link] 😀.
 
 MIT
 
+[hover-github-link]: https://github.com/hoverinc
+[node-link]: https://nodejs.org
+[npm-link]: https://www.npmjs.com/
 [react-scripts-link]:
   https://github.com/facebook/create-react-app/tree/master/packages/react-scripts
-[npm]: https://www.npmjs.com/
-[node]: https://nodejs.org
 [build-badge]:
   https://g.codefresh.io/api/badges/pipeline/hoverinc/npm%2Fjavascript?type=cf-1
-[build]:
+[build-link]:
   https://g.codefresh.io/public/accounts/hoverinc/pipelines/5d4cb5d4e41f3722d4dfdb94
+[conventional-commits-badge]:
+  https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
+[conventional-commits-link]: https://conventionalcommits.org
+[coverage-link]: https://codecov.io/github/hoverinc/hover-javascript
 [coverage-badge]:
   https://img.shields.io/codecov/c/github/hoverinc/hover-javascript.svg
-[coverage]: https://codecov.io/github/hoverinc/hover-javascript
-[dependabot-badge]:
-  https://api.dependabot.com/badges/status?host=github&repo=hoverinc/hover-javascript
-[dependabot]: https://dependabot.com
-[version-badge]: https://img.shields.io/npm/v/@hover/javascript.svg
-[package]: https://www.npmjs.com/package/@hover/javascript
+[maintenance-badge]:
+  https://img.shields.io/badge/maintenance-active-247ddc?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABkAAAAcCAYAAACUJBTQAAAB1ElEQVRIibWWPUtdQRCGH0VNF/wCCVjYCxr/gZWdhYVgLQYbm/wACTYxxA8SSBDtbKwUbfQWkiJFAgkkmHBBY6U2CXaCGlDDG1buxePOnt17bsgD28zOzjtnZvbuRVKR1SFpVdKepEe1njOGnOWCz0q60B1lSa05/oVE2iTNSfqdCZ7lSyWB0NmkSJekeUmXJqzlayWZUJxckUUTJs23mFAjlhNjSdMHfAQ6g54hZUnDdXyN44ek7iKNH4w0PMaeX7pQ8Ox6HQkWww3Dw1hPWoAJ4BxoB4aNR5oB4APQ5vekUdITSceZDLcreyORrGPcfpEL0CBpVNJRwLmUSWLS7NbGpju8FXEteT2qR+jQ9aS3QK2XgUljjXPpRC6iLpYV4KmxRghNVy28Aqb+t4jjLbBhrAH+RcRxZSwBUiINxlIHKZE/xlIHTTlHBDwHjoDPwHtgF/gEnBnvFJVfzSrXkpYyfxKGvIu14F3ONXP1LOWmzEPjpuWl92j55XyQyDnEjRN5AbwD9gMOPkV7tAPMOJE3ZuuOFmOpjS3gGfCdQDl8fgGnGVtzwt8F7wdGqgKOvOmq4iarB3gMjAFlb78qug5MAwehIO4tKViJe4wDP4FSrgfwF/ntR8JxRSf3AAAAAElFTkSuQmCC
+[maintenance-link]: https://github.com/hoverinc/hover-javascript#maintenance
 [license-badge]: https://img.shields.io/npm/l/@hover/javascript.svg
-[license]: https://github.com/hoverinc/hover-javascript/blob/master/LICENSE
+[license-link]: https://github.com/hoverinc/hover-javascript/blob/master/LICENSE
+[node-link]: https://nodejs.org/en/download/
+[node-badge]: https://img.shields.io/badge/node-v12.18.4-green
+[prettier-badge]:
+  https://img.shields.io/badge/code_style-prettier-ff69b4.svg?logo=prettier
+[prettier-link]: https://prettierjs.org/en/download/
+[package-badge]: https://img.shields.io/npm/v/@hover/javascript.svg
+[package-link]: https://www.npmjs.com/package/@hover/javascript

package.json

@@ -50,7 +50,7 @@
   "license": "MIT",
   "dependencies": {
     "@commitlint/cli": "^11.0.0",
-    "@commitlint/config-conventional": "^9.1.2",
+    "@commitlint/config-conventional": "^11.0.0",
     "@commitlint/prompt": "^11.0.0",
     "@types/jest": "^26.0.14",
     "@typescript-eslint/eslint-plugin": "^4.4.0",
@@ -90,7 +90,7 @@
     "semver": "^7.1.3",
     "typescript": "^4.0.3",
     "which": "^2.0.2",
-    "yargs-parser": "^18.1.3"
+    "yargs-parser": "^20.2.1"
   },
   "eslintConfig": {
     "extends": [

src/config/lintstagedrc.js

@@ -4,7 +4,7 @@ const hoverScripts = resolveHoverScripts()
 const doctoc = resolveBin('doctoc')
 
 module.exports = {
-  'README.md': [`${doctoc} --maxlevel 3 --notitle`],
+  'README.md': [`${doctoc} --maxlevel 4 --notitle`],
   '*.+(js|jsx|json|yml|yaml|css|less|scss|ts|tsx|md|graphql|mdx|vue)': [
     `${hoverScripts} format`,
   ],

yarn.lock

@@ -897,12 +897,12 @@
     resolve-global "1.0.0"
     yargs "^15.1.0"
 
-"@commitlint/config-conventional@^9.1.2":
-  version "9.1.2"
-  resolved "https://registry.yarnpkg.com/@commitlint/config-conventional/-/config-conventional-9.1.2.tgz#9920ad60a2ac64eedad01845b331c970cf854a71"
-  integrity sha512-2zfnsrBJuCNJEKMEmltYlCUEoQNE4anvEBI/SYEuiB1JYXYaELijobDBpqhUVjh5NEpprNTY16oMZat6ewnxOg==
+"@commitlint/config-conventional@^11.0.0":
+  version "11.0.0"
+  resolved "https://registry.yarnpkg.com/@commitlint/config-conventional/-/config-conventional-11.0.0.tgz#3fa300a1b639273946de3c3f15e1cda518333422"
+  integrity sha512-SNDRsb5gLuDd2PL83yCOQX6pE7gevC79UPFx+GLbLfw6jGnnbO9/tlL76MLD8MOViqGbo7ZicjChO9Gn+7tHhA==
   dependencies:
-    conventional-changelog-conventionalcommits "4.3.0"
+    conventional-changelog-conventionalcommits "^4.3.1"
 
 "@commitlint/ensure@^11.0.0":
   version "11.0.0"
@@ -2891,6 +2891,14 @@ compare-func@^1.3.1:
     array-ify "^1.0.0"
     dot-prop "^3.0.0"
 
+compare-func@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/compare-func/-/compare-func-2.0.0.tgz#fb65e75edbddfd2e568554e8b5b05fff7a51fcb3"
+  integrity sha512-zHig5N+tPWARooBnb0Zx1MFcdfpyJrfTJ3Y5L+IFvUm8rM74hHz66z0gw0x4tijh5CorKkKUCnW82R2vmpeCRA==
+  dependencies:
+    array-ify "^1.0.0"
+    dot-prop "^5.1.0"
+
 compare-versions@^3.6.0:
   version "3.6.0"
   resolved "https://registry.yarnpkg.com/compare-versions/-/compare-versions-3.6.0.tgz#1a5689913685e5a87637b8d3ffca75514ec41d62"
@@ -2959,12 +2967,12 @@ conventional-changelog-angular@^5.0.0:
     compare-func "^1.3.1"
     q "^1.5.1"
 
-conventional-changelog-conventionalcommits@4.3.0:
-  version "4.3.0"
-  resolved "https://registry.yarnpkg.com/conventional-changelog-conventionalcommits/-/conventional-changelog-conventionalcommits-4.3.0.tgz#c4205a659f7ca9d7881f29ee78a4e7d6aeb8b3c2"
-  integrity sha512-oYHydvZKU+bS8LnGqTMlNrrd7769EsuEHKy4fh1oMdvvDi7fem8U+nvfresJ1IDB8K00Mn4LpiA/lR+7Gs6rgg==
+conventional-changelog-conventionalcommits@^4.3.1:
+  version "4.4.0"
+  resolved "https://registry.yarnpkg.com/conventional-changelog-conventionalcommits/-/conventional-changelog-conventionalcommits-4.4.0.tgz#8d96687141c9bbd725a89b95c04966d364194cd4"
+  integrity sha512-ybvx76jTh08tpaYrYn/yd0uJNLt5yMrb1BphDe4WBredMlvPisvMghfpnJb6RmRNcqXeuhR6LfGZGewbkRm9yA==
   dependencies:
-    compare-func "^1.3.1"
+    compare-func "^2.0.0"
     lodash "^4.17.15"
     q "^1.5.1"
 
@@ -3421,6 +3429,13 @@ dot-prop@^3.0.0:
   dependencies:
     is-obj "^1.0.0"
 
+dot-prop@^5.1.0:
+  version "5.3.0"
+  resolved "https://registry.yarnpkg.com/dot-prop/-/dot-prop-5.3.0.tgz#90ccce708cd9cd82cc4dc8c3ddd9abdd55b20e88"
+  integrity sha512-QM8q3zDe58hqUqjraQOmzZ1LIH9SWQJTlEKCH4kJ2oQvLZk7RbQXvtDM2XEq3fwkV9CCvvH4LA0AV+ogFsBM2Q==
+  dependencies:
+    is-obj "^2.0.0"
+
 duplexify@^3.4.2, duplexify@^3.6.0:
   version "3.7.1"
   resolved "https://registry.yarnpkg.com/duplexify/-/duplexify-3.7.1.tgz#2a4df5317f6ccfd91f86d6fd25d8d8a103b88309"
@@ -5103,6 +5118,11 @@ is-obj@^1.0.0, is-obj@^1.0.1:
   resolved "https://registry.yarnpkg.com/is-obj/-/is-obj-1.0.1.tgz#3e4729ac1f5fde025cd7d83a896dab9f4f67db0f"
   integrity sha1-PkcprB9f3gJc19g6iW2rn09n2w8=
 
+is-obj@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/is-obj/-/is-obj-2.0.0.tgz#473fb05d973705e3fd9620545018ca8e22ef4982"
+  integrity sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w==
+
 is-plain-obj@^1.1.0:
   version "1.1.0"
   resolved "https://registry.yarnpkg.com/is-plain-obj/-/is-plain-obj-1.1.0.tgz#71a50c8429dfca773c92a390a4a03b39fcd51d3e"
@@ -9130,14 +9150,19 @@ yargs-parser@^13.1.2:
     camelcase "^5.0.0"
     decamelize "^1.2.0"
 
-yargs-parser@^18.1.2, yargs-parser@^18.1.3:
+yargs-parser@^18.1.2:
   version "18.1.3"
   resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-18.1.3.tgz#be68c4975c6b2abf469236b0c870362fab09a7b0"
   integrity sha512-o50j0JeToy/4K6OZcaQmW6lyXXKhq7csREXcDwk2omFPJEwUNOVtJKvmDr9EI1fAJZUyZcRF7kxGBWmRXudrCQ==
   dependencies:
     camelcase "^5.0.0"
     decamelize "^1.2.0"
 
+yargs-parser@^20.2.1:
+  version "20.2.1"
+  resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-20.2.1.tgz#28f3773c546cdd8a69ddae68116b48a5da328e77"
+  integrity sha512-yYsjuSkjbLMBp16eaOt7/siKTjNVjMm3SoJnIg3sEh/JsvqVVDyjRKmaJV4cl+lNIgq6QEco2i3gDebJl7/vLA==
+
 yargs@^13.3.0:
   version "13.3.2"
   resolved "https://registry.yarnpkg.com/yargs/-/yargs-13.3.2.tgz#ad7ffefec1aa59565ac915f82dccb38a9c31a2dd"