.github/workflows/main.yml

@@ -7,18 +7,18 @@ jobs:
     name: '${{matrix.node}} on ${{matrix.os}}'
     runs-on: ${{matrix.os}}
     steps:
-      - uses: actions/checkout@v2
-      - uses: dcodeIO/setup-node-nvm@master
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{matrix.node}}
       - run: npm install
       - run: npm test
-      - uses: codecov/codecov-action@v1
+      - uses: codecov/codecov-action@v3
     strategy:
       matrix:
         os:
           - ubuntu-latest
           - windows-latest
         node:
-          - lts/erbium
+          - lts/gallium
           - node

.npmrc

@@ -1 +1,2 @@
 package-lock=false
+ignore-scripts=true

lib/index.js

@@ -2,48 +2,79 @@
  * @typedef {import('vfile').VFile} VFile
  * @typedef {import('vfile-message').VFileMessage} VFileMessage
  * @typedef {import('vfile-statistics').Statistics} Statistics
- *
+ */
+
+/**
  * @typedef Options
- * @property {boolean} [color]
- * @property {boolean} [silent=false]
- * @property {boolean} [quiet=false]
- * @property {boolean} [verbose=false]
- * @property {string} [defaultName='<stdin>']
- *
- * @typedef Row
+ *   Configuration (optional).
+ * @property {boolean | null | undefined} [color]
+ *   Use ANSI colors in report.
+ *   The default behavior in Node.js is the check if color is supported.
+ * @property {boolean | null | undefined} [verbose=false]
+ *   Show message `note`s.
+ *   Notes are optional, additional, long descriptions.
+ * @property {boolean | null | undefined} [quiet=false]
+ *   Do not show files without messages.
+ * @property {boolean | null | undefined} [silent=false]
+ *   Show errors only, this hides info and warning messages, and sets
+ *   `quiet: true`.
+ * @property {string | null | undefined} [defaultName='<stdin>']
+ *   Label to use for files without file path.
+ *   If one file and no `defaultName` is given, no name will show up in the
+ *   report.
+ */
+
+/**
+ * @typedef MessageRow
+ *   Message.
  * @property {string} place
+ *   Serialized positional info.
  * @property {string} label
+ *   Kind of message.
  * @property {string} reason
+ *   Reason.
  * @property {string} ruleId
+ *   Rule.
  * @property {string} source
+ *   Source.
+ *
+ * @typedef {keyof MessageRow} MessageColumn
  *
  * @typedef FileRow
+ *   File header row.
  * @property {'file'} type
+ *   Kind.
  * @property {VFile} file
+ *   Virtual file.
  * @property {Statistics} stats
+ *   Statistics.
  *
- * @typedef {{[x: string]: number}} Sizes
+ * @typedef {Record<MessageColumn, number>} Sizes
+ *   Sizes for message columns.
  *
  * @typedef Info
- * @property {Array<FileRow|Row>} rows
+ *   Result.
+ * @property {Array<FileRow | MessageRow>} rows
+ *   Rows.
  * @property {Statistics} stats
+ *   Total statistics.
  * @property {Sizes} sizes
+ *   Sizes for message columns.
  */
 
 import width from 'string-width'
 import {stringifyPosition} from 'unist-util-stringify-position'
 import {statistics} from 'vfile-statistics'
 import {sort} from 'vfile-sort'
 import {color} from './color.js'
+import {platform} from './platform.js'
 
 const own = {}.hasOwnProperty
 
 // `log-symbols` without chalk, ignored for Windows:
 /* c8 ignore next 4 */
 const chars =
-  process.platform === 'win32'
-    ? {error: '×', warning: '‼'}
-    : {error: '✖', warning: '⚠'}
+  platform === 'win32' ? {error: '×', warning: '‼'} : {error: '✖', warning: '⚠'}
 
 const labels = {
   true: 'error',
@@ -53,16 +84,16 @@ const labels = {
 }
 
 /**
- * Report a file’s messages.
+ * Create a report from an error, one file, or multiple files.
  *
- * @param {Error|VFile|Array<VFile>} [files]
- * @param {Options} [options]
+ * @param {Error | VFile | Array<VFile> | null | undefined} [files]
+ *   Files or error to report.
+ * @param {Options | null | undefined} [options]
+ *   Configuration.
  * @returns {string}
+ *   Report.
  */
-export function reporter(files, options = {}) {
-  /** @type {boolean|undefined} */
-  let one
-
+export function reporter(files, options) {
   if (!files) {
     return ''
   }
@@ -72,33 +103,39 @@ export function reporter(files, options = {}) {
     return String(files.stack || files)
   }
 
+  const options_ = options || {}
+
   // One file.
-  if (!Array.isArray(files)) {
-    one = true
-    files = [files]
+  if (Array.isArray(files)) {
+    return format(transform(files, options_), false, options_)
   }
 
-  return format(transform(files, options), one, options)
+  return format(transform([files], options_), true, options_)
 }
 
 /**
+ * Parse a list of messages.
+ *
  * @param {Array<VFile>} files
+ *   List of files.
  * @param {Options} options
+ *   Options.
  * @returns {Info}
+ *   Rows.
  */
 function transform(files, options) {
-  /** @type {Array<FileRow|Row>} */
+  /** @type {Array<FileRow | MessageRow>} */
   const rows = []
   /** @type {Array<VFileMessage>} */
   const all = []
   /** @type {Sizes} */
-  const sizes = {}
+  const sizes = {place: 0, label: 0, reason: 0, ruleId: 0, source: 0}
   let index = -1
 
   while (++index < files.length) {
     // @ts-expect-error it works fine.
     const messages = sort({messages: [...files[index].messages]}).messages
-    /** @type {Array<Row>} */
+    /** @type {Array<MessageRow>} */
     const messageRows = []
     let offset = -1
 
@@ -124,7 +161,7 @@ function transform(files, options) {
           source: message.source || ''
         }
 
-        /** @type {keyof row} */
+        /** @type {MessageColumn} */
         let key
 
         for (key in row) {
@@ -151,8 +188,13 @@ function transform(files, options) {
 
 /**
  * @param {Info} map
- * @param {boolean|undefined} one
+ *   Rows.
+ * @param {boolean} one
+ *   Whether the input was explicitly one file (not an array).
  * @param {Options} options
+ *   Configuration.
+ * @returns {string}
+ *   Report.
  */
 // eslint-disable-next-line complexity
 function format(map, one, options) {
@@ -285,10 +327,12 @@ function format(map, one, options) {
 }
 
 /**
- * Get the length of `value`, ignoring ANSI sequences.
+ * Get the length of the first line of `value`, ignoring ANSI sequences.
  *
  * @param {string} value
+ *   Message.
  * @returns {number}
+ *   Width.
  */
 function size(value) {
   const match = /\r?\n|\r/.exec(value)

lib/platform.browser.js

@@ -0,0 +1 @@
+export const platform = 'darwin'

lib/platform.js

@@ -0,0 +1,3 @@
+import process from 'node:process'
+
+export const platform = process.platform

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vfile-reporter",
-  "version": "7.0.3",
+  "version": "7.0.5",
   "description": "vfile utility to create a report for a file",
   "license": "MIT",
   "keywords": [
@@ -33,7 +33,8 @@
   "type": "module",
   "main": "index.js",
   "browser": {
-    "./lib/color.js": "./lib/color.browser.js"
+    "./lib/color.js": "./lib/color.browser.js",
+    "./lib/platform.js": "./lib/platform.browser.js"
   },
   "types": "index.d.ts",
   "files": [
@@ -46,31 +47,29 @@
     "string-width": "^5.0.0",
     "supports-color": "^9.0.0",
     "unist-util-stringify-position": "^3.0.0",
+    "vfile": "^5.0.0",
+    "vfile-message": "^3.0.0",
     "vfile-sort": "^3.0.0",
     "vfile-statistics": "^2.0.0"
   },
   "devDependencies": {
-    "@types/tape": "^4.0.0",
+    "@types/node": "^18.0.0",
     "c8": "^7.0.0",
     "cross-env": "^7.0.0",
-    "figures": "^3.0.0",
     "prettier": "^2.0.0",
-    "remark-cli": "^10.0.0",
+    "remark-cli": "^11.0.0",
     "remark-preset-wooorm": "^9.0.0",
-    "rimraf": "^3.0.0",
     "strip-ansi": "^7.0.0",
-    "tape": "^5.0.0",
     "type-coverage": "^2.0.0",
     "typescript": "^4.0.0",
-    "vfile": "^5.0.0",
-    "xo": "^0.47.0"
+    "xo": "^0.53.0"
   },
   "scripts": {
     "prepack": "npm run build && npm run format",
-    "build": "rimraf \"lib/**/*.d.ts\" \"*.d.ts\" && tsc && type-coverage",
+    "build": "tsc --build --clean && tsc --build && type-coverage",
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
-    "test-api": "cross-env FORCE_COLOR=\"true\" node test.js",
-    "test-coverage": "cross-env FORCE_COLOR=\"true\" c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node test.js",
+    "test-api": "cross-env FORCE_COLOR=\"true\" node --conditions development test.js",
+    "test-coverage": "c8 --check-coverage --100 --reporter lcov npm run test-api",
     "test": "npm run build && npm run format && npm run test-coverage"
   },
   "prettier": {
@@ -82,10 +81,7 @@
     "trailingComma": "none"
   },
   "xo": {
-    "prettier": true,
-    "rules": {
-      "node/prefer-global/process": "off"
-    }
+    "prettier": true
   },
   "remarkConfig": {
     "plugins": [