Merge branch 'master' into beta

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

commitlint.config.js

@@ -1,16 +1,4 @@
-const {readdirSync, statSync} = require('fs')
-const {join, sep} = require('path')
-
-const ls = path =>
-  readdirSync(path)
-    .filter(f => statSync(join(path, f)).isFile())
-    .map(
-      f =>
-        `${path.split(sep).reverse()[0]}/${f.replace(
-          /(\.config)?.(json|js)/,
-          '',
-        )}`,
-    )
+const {ls, scopes} = require('./src/api/commit')
 
 module.exports = {
   extends: ['./src/config/commitlint.config'],
@@ -19,11 +7,13 @@ module.exports = {
       1,
       'always',
       [
-        ...ls('./src/config'),
-        ...ls('./src/scripts'),
-        ...ls('./src/api'),
-        'deps',
-        'build',
+        ...scopes.build(),
+        'config',
+        'scripts',
+        'api',
+        ...ls.configs('./src/config'),
+        ...ls.configs('./src/scripts'),
+        ...ls.configs('./src/api'),
       ],
     ],
   },

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/api/__tests__/__fixtures__/ls/configs/.foorc.json

@@ -0,0 +1,36 @@
+const {ls} = require('../commit')
+
+const fixtures = './src/api/__tests__/__fixtures__'
+
+describe('ls', () => {
+  test('configs', () => {
+    const result = ls.configs(`${fixtures}/ls/configs`)
+
+    const expected = [
+      'configs/.foorc',
+      'configs/foo',
+      'configs/foo.setup',
+      'configs/foo',
+    ]
+
+    expect(result.sort()).toEqual(expected.sort())
+  })
+
+  describe('dirs', () => {
+    test('without prefix', () => {
+      const result = ls.dirs(`${fixtures}/ls/dirs`)
+
+      const expected = ['.baz', 'bar', 'foo']
+
+      expect(result.sort()).toEqual(expected.sort())
+    })
+
+    test('with prefix', () => {
+      const result = ls.dirs(`${fixtures}/ls/dirs`, 'prefix')
+
+      const expected = ['prefix/.baz', 'prefix/bar', 'prefix/foo']
+
+      expect(result.sort()).toEqual(expected.sort())
+    })
+  })
+})

src/api/__tests__/__fixtures__/ls/configs/foo.config.js

@@ -0,0 +1,61 @@
+const {readdirSync, statSync} = require('fs')
+const {join, sep} = require('path')
+
+//
+// Common scopes
+
+/**
+ * Build scopes
+ * - commit
+ * - deps
+ * - deps-dev
+ * - format
+ * - lint
+ */
+const build = () => ['commit', 'deps', 'deps-dev', 'format', 'lint']
+
+const scopes = {build}
+
+//
+// Scope helpers
+
+/**
+ * Enumerate config files
+ *
+ * Example
+ *
+ * - `dir/foo.js`
+ * - `dir/bar.config.js`
+ * - `dir/baz.json`
+ * - `dir/qux.ts`
+ *
+ * `ls.config('./dir') → ['dir/foo', 'dir/bar', 'dir/baz', 'dir/qux']`
+ *
+ * @param {string} path - directory to enumerate
+ */
+const configs = path =>
+  readdirSync(path)
+    .filter(f => statSync(join(path, f)).isFile())
+    .map(
+      f =>
+        `${path.split(sep).reverse()[0]}/${f.replace(
+          /(\.config)?.(json|js|ts)/,
+          '',
+        )}`,
+    )
+
+/**
+ * Enumerate one level of directories
+ *
+ * @param {string} path - directory to enumerate
+ * @param {string} [prefix] - prefix for each scope entry (e.g: `prefix/entry`)
+ */
+const dirs = (path, prefix) =>
+  readdirSync(path)
+    .filter(f => statSync(join(path, f)).isDirectory())
+    .map(item => (prefix ? `${prefix}/${item}` : item))
+    .map(item => item.toLowerCase())
+
+const ls = {configs, dirs}
+
+module.exports = {ls, scopes}

src/api/__tests__/__fixtures__/ls/configs/foo.js

@@ -1,3 +1,5 @@
+const {scopes} = require('../api/commit')
+
 module.exports = {
   extends: ['@commitlint/config-conventional'],
   rules: {
@@ -19,6 +21,6 @@ module.exports = {
       ],
     ],
     'scope-case': [1, 'always', 'kebab-case'],
-    'scope-enum': [0, 'always', ['deps', 'build']],
+    'scope-enum': [0, 'always', scopes.build()],
   },
 }

src/api/__tests__/__fixtures__/ls/configs/foo.setup.ts

@@ -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`,
   ],