chore: documentation and CI updates (#183)

Author: Fdawgs

.github/dependabot.yml

@@ -1,12 +1,12 @@
 version: 2
 updates:
 - package-ecosystem: github-actions
-  directory: "/"
+  directory: '/'
   schedule:
     interval: daily
   open-pull-requests-limit: 10
 - package-ecosystem: npm
-  directory: "/"
+  directory: '/'
   schedule:
     interval: daily
   open-pull-requests-limit: 10

.github/workflows/ci.yml

@@ -1,39 +1,46 @@
 name: CI
+
 on:
   push:
     paths-ignore:
-        - "docs/**"
-        - "*.md"
+        - 'docs/**'
+        - '*.md'
   pull_request:
     paths-ignore:
-        - "docs/**"
-        - "*.md"
+        - 'docs/**'
+        - '*.md'
+
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 13.x, 14.x, 16.x]
+        node-version: [10, 12, 13, 14, 16]
     steps:
       - name: Checkout
         uses: actions/checkout@v2.3.4
+
       - name: Use Node.js
         uses: actions/setup-node@v2.1.5
         with:
           node-version: ${{ matrix.node-version }}
+
       - name: Restore cached dependencies
         uses: actions/cache@v2.1.5
         with:
           path: node_modules
           key: node-modules-${{ hashFiles('package.json') }}
+
       - name: Install dependencies
         run: npm install
+
       - name: Run Tests
         run: npm run ci
+
       - name: Coveralls Parallel
         uses: coverallsapp/github-action@v1.1.2
         with:
-          github-token: ${{ secrets.github_token }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
           parallel: true
           flag-name: run-${{ matrix.node-version }}-${{ matrix.os }}
 
@@ -52,6 +59,5 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: fastify/github-action-merge-dependabot@v2.0.0
-        if: ${{ github.actor == 'dependabot[bot]' && github.event_name == 'pull_request' }}
         with:
-          github-token: ${{secrets.github_token}}
+          github-token: ${{ secrets.GITHUB_TOKEN }}

Readme.md

@@ -45,7 +45,7 @@ $ npm install -g pino-pretty
 <a id="usage"></a>
 ## Usage
 
-It's recommended to use `pino-pretty` with `pino`
+It is recommended to use `pino-pretty` with `pino`
 by piping output to the CLI tool:
 
 ```sh
@@ -59,7 +59,7 @@ node app.js | pino-pretty
 - `--crlf` (`-f`): Appends carriage return and line feed, instead of just a line
   feed, to the formatted log line.
 - `--errorProps` (`-e`): When formatting an error object, display this list
-  of properties. The list should be a comma separated list of properties Default: `''`.
+  of properties. The list should be a comma-separated list of properties Default: `''`.
 - `--levelFirst` (`-l`): Display the log level name before the logged date and time.
 - `--errorLikeObjectKeys` (`-k`): Define the log keys that are associated with
   error like objects. Default: `err,error`.
@@ -73,14 +73,14 @@ node app.js | pino-pretty
   Default: `false`
 - `--timestampKey` (`-a`): Define the key that contains the log timestamp.
   Default: `time`.
-- `--translateTime` (`-t`): Translate the epoch time value into a human readable
+- `--translateTime` (`-t`): Translate the epoch time value into a human-readable
   date and time string. This flag also can set the format string to apply when
-  translating the date to human readable format. For a list of available pattern
-  letters see the [`dateformat` documentation](https://www.npmjs.com/package/dateformat).
+  translating the date to a human-readable format. For a list of available pattern
+  letters, see the [`dateformat` documentation](https://www.npmjs.com/package/dateformat).
   - The default format is `yyyy-mm-dd HH:MM:ss.l o` in UTC.
-  - Require a `SYS:` prefix to translate time to the local system's timezone. A
+  - Require a `SYS:` prefix to translate time to the local system's time zone. A
     shortcut `SYS:standard` to translate time to `yyyy-mm-dd HH:MM:ss.l o` in
-    system timezone.
+    system time zone.
 - `--search` (`-s`): Specify a search pattern according to
   [jmespath](http://jmespath.org/).
 - `--ignore` (`-i`): Ignore one or several keys: (`-i time,hostname`)
@@ -91,7 +91,7 @@ node app.js | pino-pretty
 <a id="integration"></a>
 ## Programmatic Integration
 
-We recommend against using `pino-pretty` in production, and highly
+We recommend against using `pino-pretty` in production and highly
 recommend installing `pino-pretty` as a development dependency.
 
 When installed, `pino-pretty` will be used by `pino` as the default
@@ -155,7 +155,7 @@ The `colorize` default follows
 
 `customPrettifiers` option provides the ability to add a custom prettify function
 for specific log properties. `customPrettifiers` is an object, where keys are
-log properties which will be prettified and value is the prettify function itself.
+log properties that will be prettified and value is the prettify function itself.
 For example, if a log line contains a `query` property,
 you can specify a prettifier for it:
 ```js
@@ -170,13 +170,13 @@ const prettifyQuery = value => {
 }
 ```
 
-`messageFormat` option allows you to customize the message output. The format can be defined by a template `string` like this:
+`messageFormat` option allows you to customize the message output. A template `string` like this can define the format:
 ```js
 {
   messageFormat: '{levelLabel} - {pid} - url:{request.url}'
 }
 ```
-But this option can also be defined as a `function` with this prototype:
+This option can also be defined as a `function` with this prototype:
 ```js
 {
   messageFormat: (log, messageKey, levelLabel) => {

docs/help.md

@@ -3,22 +3,22 @@
 
 If you run your Node.js process via [Systemd](https://www.freedesktop.org/wiki/Software/systemd/) and you examine your logs with [journalctl](https://www.freedesktop.org/software/systemd/man/journalctl.html) some data will be duplicated. You can use a combination of `journalctl` options and `pino-pretty` options to shape the output.
 
-For example viewing the pretified logs of a process named `monitor` with `journalctl -u monitor -f | pino-pretty`, might output something like this:
+For example viewing the prettified logs of a process named `monitor` with `journalctl -u monitor -f | pino-pretty`, might output something like this:
 
 ```
 Apr 24 07:40:01 nanopi node[6080]: {"level":30,"time":1587706801902,"pid":6080,"hostname":"nanopi","msg":"TT
 21","v":1}
 ```
-As you can see, the timestamp, hostname and pid are duplicated.
-If you just want the bare pretified Pino logs you can strip out the duplicate items from the `journalctl` output with the `-o cat` option of `journalctl`: 
+As you can see, the timestamp, hostname, and pid are duplicated.
+If you just want the bare prettified Pino logs you can strip out the duplicate items from the `journalctl` output with the `-o cat` option of `journalctl`: 
 ```
 journalctl -u monitor -f -o cat | pino-pretty
 ```
 the output now looks something like this:
 ```
 [1587706801902] INFO  (6080 on nanopi): TT 21
 ```
-Making the output even more human readble by using the pino-pretty options `-t` to format the timestamp and `-i pid, hostname` to filter out hostname and pid:
+Make the output even more human readable by using the pino-pretty options `-t` to format the timestamp and `-i pid, hostname` to filter out hostname and pid:
 ```
 [2020-04-24 05:42:24.836 +0000] INFO : TT 21
 ``` 

package.json

@@ -7,9 +7,9 @@
     "pino-pretty": "./bin.js"
   },
   "scripts": {
-    "ci": "standard && tap 'test/**/*.test.js' --coverage-report=lcovonly",
+    "ci": "standard && tap \"test/**/*.test.js\" --coverage-report=lcovonly",
     "lint": "standard | snazzy",
-    "test": "tap --100 'test/**/*.test.js'"
+    "test": "tap --100 \"test/**/*.test.js\""
   },
   "repository": {
     "type": "git",