Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
vfile-reporter
Advanced tools
vfile-reporter - npm Package Compare versions
Comparing version 7.0.2 to 7.0.3
@@ -1,42 +0,2 @@ | ||
| /** | ||
| * Report a file’s messages. | ||
| * | ||
| * @param {Error|VFile|Array.<VFile>} [files] | ||
| * @param {Options} [options] | ||
| * @returns {string} | ||
| */ | ||
| export function reporter( | ||
| files?: import('vfile').VFile | Error | import('vfile').VFile[] | undefined, | ||
| options?: Options | undefined | ||
| ): string | ||
| export default reporter | ||
| export type VFile = import('vfile').VFile | ||
| export type VFileMessage = import('vfile-message').VFileMessage | ||
| export type Statistics = import('vfile-statistics').Statistics | ||
| export type Options = { | ||
| color?: boolean | undefined | ||
| silent?: boolean | undefined | ||
| quiet?: boolean | undefined | ||
| verbose?: boolean | undefined | ||
| defaultName?: string | undefined | ||
| } | ||
| export type _Row = { | ||
| place: string | ||
| label: string | ||
| reason: string | ||
| ruleId: string | ||
| source: string | ||
| } | ||
| export type _FileRow = { | ||
| type: 'file' | ||
| file: VFile | ||
| stats: Statistics | ||
| } | ||
| export type _Sizes = { | ||
| [x: string]: number | ||
| } | ||
| export type _Info = { | ||
| rows: Array<_FileRow | _Row> | ||
| stats: Statistics | ||
| sizes: _Sizes | ||
| } | ||
| export type Options = import('./lib/index.js').Options | ||
| export {reporter, reporter as default} from './lib/index.js' |
300
index.js
| /** | ||
| * @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 | ||
| * @property {string} place | ||
| * @property {string} label | ||
| * @property {string} reason | ||
| * @property {string} ruleId | ||
| * @property {string} source | ||
| * | ||
| * @typedef _FileRow | ||
| * @property {'file'} type | ||
| * @property {VFile} file | ||
| * @property {Statistics} stats | ||
| * | ||
| * @typedef {{[x: string]: number}} _Sizes | ||
| * | ||
| * @typedef _Info | ||
| * @property {Array.<_FileRow|_Row>} rows | ||
| * @property {Statistics} stats | ||
| * @property {_Sizes} sizes | ||
| * @typedef {import('./lib/index.js').Options} Options | ||
| */ | ||
| import supportsColor from 'supports-color' | ||
| import width from 'string-width' | ||
| import {stringifyPosition} from 'unist-util-stringify-position' | ||
| import {statistics} from 'vfile-statistics' | ||
| import {sort} from 'vfile-sort' | ||
| const own = {}.hasOwnProperty | ||
| // @ts-expect-error Types are incorrect. | ||
| const supported = supportsColor.stderr.hasBasic | ||
| // `log-symbols` without chalk, ignored for Windows: | ||
| /* c8 ignore next 4 */ | ||
| const chars = | ||
| process.platform === 'win32' | ||
| ? {error: '×', warning: '‼'} | ||
| : {error: '✖', warning: '⚠'} | ||
| const labels = { | ||
| true: 'error', | ||
| false: 'warning', | ||
| null: 'info', | ||
| undefined: 'info' | ||
| } | ||
| export default reporter | ||
| /** | ||
| * Report a file’s messages. | ||
| * | ||
| * @param {Error|VFile|Array.<VFile>} [files] | ||
| * @param {Options} [options] | ||
| * @returns {string} | ||
| */ | ||
| export function reporter(files, options = {}) { | ||
| /** @type {boolean|undefined} */ | ||
| let one | ||
| if (!files) { | ||
| return '' | ||
| } | ||
| // Error. | ||
| if ('name' in files && 'message' in files) { | ||
| return String(files.stack || files) | ||
| } | ||
| // One file. | ||
| if (!Array.isArray(files)) { | ||
| one = true | ||
| files = [files] | ||
| } | ||
| return format(transform(files, options), one, options) | ||
| } | ||
| /** | ||
| * @param {Array.<VFile>} files | ||
| * @param {Options} options | ||
| * @returns {_Info} | ||
| */ | ||
| function transform(files, options) { | ||
| /** @type {Array.<_FileRow|_Row>} */ | ||
| const rows = [] | ||
| /** @type {Array.<VFileMessage>} */ | ||
| const all = [] | ||
| /** @type {_Sizes} */ | ||
| const sizes = {} | ||
| let index = -1 | ||
| while (++index < files.length) { | ||
| // @ts-expect-error it works fine. | ||
| const messages = sort({messages: [...files[index].messages]}).messages | ||
| /** @type {Array.<_Row>} */ | ||
| const messageRows = [] | ||
| let offset = -1 | ||
| while (++offset < messages.length) { | ||
| const message = messages[offset] | ||
| if (!options.silent || message.fatal) { | ||
| all.push(message) | ||
| const row = { | ||
| place: stringifyPosition( | ||
| message.position | ||
| ? message.position.end.line && message.position.end.column | ||
| ? message.position | ||
| : message.position.start | ||
| : undefined | ||
| ), | ||
| label: labels[/** @type {keyof labels} */ (String(message.fatal))], | ||
| reason: | ||
| (message.stack || message.message) + | ||
| (options.verbose && message.note ? '\n' + message.note : ''), | ||
| ruleId: message.ruleId || '', | ||
| source: message.source || '' | ||
| } | ||
| /** @type {keyof row} */ | ||
| let key | ||
| for (key in row) { | ||
| // eslint-disable-next-line max-depth | ||
| if (own.call(row, key)) { | ||
| sizes[key] = Math.max(size(row[key]), sizes[key] || 0) | ||
| } | ||
| } | ||
| messageRows.push(row) | ||
| } | ||
| } | ||
| if ((!options.quiet && !options.silent) || messageRows.length > 0) { | ||
| rows.push( | ||
| {type: 'file', file: files[index], stats: statistics(messages)}, | ||
| ...messageRows | ||
| ) | ||
| } | ||
| } | ||
| return {rows, stats: statistics(all), sizes} | ||
| } | ||
| /** | ||
| * @param {_Info} map | ||
| * @param {boolean|undefined} one | ||
| * @param {Options} options | ||
| */ | ||
| // eslint-disable-next-line complexity | ||
| function format(map, one, options) { | ||
| /** @type {boolean} */ | ||
| const enabled = | ||
| options.color === undefined || options.color === null | ||
| ? supported | ||
| : options.color | ||
| /** @type {Array.<string>} */ | ||
| const lines = [] | ||
| let index = -1 | ||
| while (++index < map.rows.length) { | ||
| const row = map.rows[index] | ||
| if ('type' in row) { | ||
| const stats = row.stats | ||
| let line = row.file.history[0] || options.defaultName || '<stdin>' | ||
| line = | ||
| one && !options.defaultName && !row.file.history[0] | ||
| ? '' | ||
| : (enabled | ||
| ? '\u001B[4m' /* Underline. */ + | ||
| (stats.fatal | ||
| ? '\u001B[31m' /* Red. */ | ||
| : stats.total | ||
| ? '\u001B[33m' /* Yellow. */ | ||
| : '\u001B[32m') /* Green. */ + | ||
| line + | ||
| '\u001B[39m\u001B[24m' | ||
| : line) + | ||
| (row.file.stored && row.file.path !== row.file.history[0] | ||
| ? ' > ' + row.file.path | ||
| : '') | ||
| if (!stats.total) { | ||
| line = | ||
| (line ? line + ': ' : '') + | ||
| (row.file.stored | ||
| ? enabled | ||
| ? '\u001B[33mwritten\u001B[39m' /* Yellow. */ | ||
| : 'written' | ||
| : 'no issues found') | ||
| } | ||
| if (line) { | ||
| if (index && !('type' in map.rows[index - 1])) { | ||
| lines.push('') | ||
| } | ||
| lines.push(line) | ||
| } | ||
| } else { | ||
| let reason = row.reason | ||
| const match = /\r?\n|\r/.exec(reason) | ||
| /** @type {string} */ | ||
| let rest | ||
| if (match) { | ||
| rest = reason.slice(match.index) | ||
| reason = reason.slice(0, match.index) | ||
| } else { | ||
| rest = '' | ||
| } | ||
| lines.push( | ||
| ( | ||
| ' ' + | ||
| ' '.repeat(map.sizes.place - size(row.place)) + | ||
| row.place + | ||
| ' ' + | ||
| (enabled | ||
| ? (row.label === 'error' | ||
| ? '\u001B[31m' /* Red. */ | ||
| : '\u001B[33m') /* Yellow. */ + | ||
| row.label + | ||
| '\u001B[39m' | ||
| : row.label) + | ||
| ' '.repeat(map.sizes.label - size(row.label)) + | ||
| ' ' + | ||
| reason + | ||
| ' '.repeat(map.sizes.reason - size(reason)) + | ||
| ' ' + | ||
| row.ruleId + | ||
| ' '.repeat(map.sizes.ruleId - size(row.ruleId)) + | ||
| ' ' + | ||
| (row.source || '') | ||
| ).replace(/ +$/, '') + rest | ||
| ) | ||
| } | ||
| } | ||
| const stats = map.stats | ||
| if (stats.fatal || stats.warn) { | ||
| let line = '' | ||
| if (stats.fatal) { | ||
| line = | ||
| (enabled | ||
| ? '\u001B[31m' /* Red. */ + chars.error + '\u001B[39m' | ||
| : chars.error) + | ||
| ' ' + | ||
| stats.fatal + | ||
| ' ' + | ||
| (labels.true + (stats.fatal === 1 ? '' : 's')) | ||
| } | ||
| if (stats.warn) { | ||
| line = | ||
| (line ? line + ', ' : '') + | ||
| (enabled | ||
| ? '\u001B[33m' /* Yellow. */ + chars.warning + '\u001B[39m' | ||
| : chars.warning) + | ||
| ' ' + | ||
| stats.warn + | ||
| ' ' + | ||
| (labels.false + (stats.warn === 1 ? '' : 's')) | ||
| } | ||
| if (stats.total !== stats.fatal && stats.total !== stats.warn) { | ||
| line = stats.total + ' messages (' + line + ')' | ||
| } | ||
| lines.push('', line) | ||
| } | ||
| return lines.join('\n') | ||
| } | ||
| /** | ||
| * Get the length of `value`, ignoring ANSI sequences. | ||
| * | ||
| * @param {string} value | ||
| * @returns {number} | ||
| */ | ||
| function size(value) { | ||
| const match = /\r?\n|\r/.exec(value) | ||
| return width(match ? value.slice(0, match.index) : value) | ||
| } | ||
| export {reporter, reporter as default} from './lib/index.js' |
| { | ||
| "name": "vfile-reporter", | ||
| "version": "7.0.2", | ||
| "version": "7.0.3", | ||
| "description": "vfile utility to create a report for a file", | ||
@@ -35,4 +35,8 @@ "license": "MIT", | ||
| "main": "index.js", | ||
| "browser": { | ||
| "./lib/color.js": "./lib/color.browser.js" | ||
| }, | ||
| "types": "index.d.ts", | ||
| "files": [ | ||
| "lib/", | ||
| "index.d.ts", | ||
@@ -63,7 +67,7 @@ "index.js" | ||
| "vfile": "^5.0.0", | ||
| "xo": "^0.44.0" | ||
| "xo": "^0.47.0" | ||
| }, | ||
| "scripts": { | ||
| "prepack": "npm run build && npm run format", | ||
| "build": "rimraf \"*.d.ts\" && tsc && type-coverage", | ||
| "build": "rimraf \"lib/**/*.d.ts\" \"*.d.ts\" && tsc && type-coverage", | ||
| "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix", | ||
@@ -70,0 +74,0 @@ "test-api": "cross-env FORCE_COLOR=\"true\" node test.js", |
@@ -66,3 +66,3 @@ # vfile-reporter | ||
| Generate a stylish report from the given [`vfile`][vfile], `Array.<VFile>`, | ||
| Generate a stylish report from the given [`vfile`][vfile], `Array<VFile>`, | ||
| or `Error`. | ||
@@ -69,0 +69,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by2.58%
17022
- Number of package files
- increased by120%
11
- Lines of code
- increased by3.61%
316
Worsened metrics
- Number of medium supply chain risk alerts
- increased byInfinity%
1
No dependency changes