{"id":13431886,"url":"https://github.com/vfile/vfile-reporter-pretty","last_synced_at":"2025-06-11T21:40:21.178Z","repository":{"id":10208048,"uuid":"64971706","full_name":"vfile/vfile-reporter-pretty","owner":"vfile","description":"utility to create a pretty report for a vfile","archived":false,"fork":false,"pushed_at":"2023-06-15T09:25:28.000Z","size":146,"stargazers_count":20,"open_issues_count":0,"forks_count":5,"subscribers_count":9,"default_branch":"main","last_synced_at":"2024-12-29T15:02:23.083Z","etag":null,"topics":["file","reporter","vfile","vfile-reporter","vfile-util","virtual"],"latest_commit_sha":null,"homepage":"https://unifiedjs.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vfile.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"unifiedjs","open_collective":"unified"}},"created_at":"2016-08-04T22:37:53.000Z","updated_at":"2024-09-29T10:04:02.000Z","dependencies_parsed_at":"2024-05-31T23:48:30.098Z","dependency_job_id":"2ae04e3f-7788-4174-b134-8b207dcfcc73","html_url":"https://github.com/vfile/vfile-reporter-pretty","commit_stats":{"total_commits":70,"total_committers":3,"mean_commits":"23.333333333333332","dds":0.0714285714285714,"last_synced_commit":"77761c9eb7dccd1bcde7c0df742e4e7413fb5f57"},"previous_names":["sindresorhus/vfile-reporter-pretty"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vfile%2Fvfile-reporter-pretty","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vfile%2Fvfile-reporter-pretty/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vfile%2Fvfile-reporter-pretty/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vfile%2Fvfile-reporter-pretty/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vfile","download_url":"https://codeload.github.com/vfile/vfile-reporter-pretty/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243944930,"owners_count":20372885,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["file","reporter","vfile","vfile-reporter","vfile-util","virtual"],"created_at":"2024-07-31T02:01:06.757Z","updated_at":"2025-03-16T22:32:36.965Z","avatar_url":"https://github.com/vfile.png","language":"JavaScript","funding_links":["https://github.com/sponsors/unifiedjs","https://opencollective.com/unified"],"categories":["JavaScript"],"sub_categories":[],"readme":"# vfile-reporter-pretty\n\n[![Build][build-badge]][build]\n[![Coverage][coverage-badge]][coverage]\n[![Downloads][downloads-badge]][downloads]\n[![Size][size-badge]][size]\n[![Sponsors][sponsors-badge]][collective]\n[![Backers][backers-badge]][collective]\n[![Chat][chat-badge]][chat]\n\n[vfile][] utility to create a pretty report.\n\n![][screenshot]\n\n## Contents\n\n*   [What is this?](#what-is-this)\n*   [When should I use this?](#when-should-i-use-this)\n*   [Install](#install)\n*   [Use](#use)\n*   [API](#api)\n    *   [`reporterPretty(files)`](#reporterprettyfiles)\n*   [Types](#types)\n*   [Compatibility](#compatibility)\n*   [Contribute](#contribute)\n*   [License](#license)\n\n## What is this?\n\nThis package is like [`vfile-reporter`][vfile-reporter] but a bit prettier.\n\n## When should I use this?\n\nYou can use this when you like\n[`eslint-formatter-pretty`][eslint-formatter-pretty], use `vfile-reporter`\nitself otherwise.\n\n## Install\n\nThis package is [ESM only][esm].\nIn Node.js (version 16+), install with [npm][]:\n\n```sh\nnpm install vfile-reporter-pretty\n```\n\nIn Deno with [`esm.sh`][esmsh]:\n\n```js\nimport {reporterPretty} from 'https://esm.sh/vfile-reporter-pretty@7'\n```\n\nIn browsers with [`esm.sh`][esmsh]:\n\n```html\n\u003cscript type=\"module\"\u003e\n  import {reporterPretty} from 'https://esm.sh/vfile-reporter-pretty@7?bundle'\n\u003c/script\u003e\n```\n\n## Use\n\n```js\nimport {VFile} from 'vfile'\nimport {reporterPretty} from 'vfile-reporter-pretty'\n\nconst file = new VFile({path: '~/example.md'})\n\nfile.message('`braavo` is misspelt; did you mean `bravo`?', {line: 1, column: 8})\nfile.info('This is perfect', {line: 2, column: 1})\n\ntry {\n  file.fail('This is horrible', {line: 3, column: 5})\n} catch (error) {}\n\nconsole.log(reporterPretty([file]))\n```\n\n## API\n\nThis package exports the identifier [`reporterPretty`][api-reporter-pretty].\nThat identifier is also the default export.\n\n### `reporterPretty(files)`\n\nCreate a pretty report from files.\n\n###### Parameters\n\n*   `files` ([`Array\u003cVFile\u003e`][vfile])\n    — files to report\n\n###### Returns\n\nReport (`string`).\n\n## Types\n\nThis package is fully typed with [TypeScript][].\nIt exports no additional types.\n\n## Compatibility\n\nProjects maintained by the unified collective are compatible with maintained\nversions of Node.js.\n\nWhen we cut a new major release, we drop support for unmaintained versions of\nNode.\nThis means we try to keep the current release line, `vfile-reporter-pretty@^7`,\ncompatible with Node.js 16.\n\n## Contribute\n\nSee [`contributing.md`][contributing] in [`vfile/.github`][health] for ways to\nget started.\nSee [`support.md`][support] for ways to get help.\n\nThis project has a [code of conduct][coc].\nBy interacting with this repository, organization, or community you agree to\nabide by its terms.\n\n## License\n\n[MIT][license] © [Sindre Sorhus][author]\n\n\u003c!-- Definitions --\u003e\n\n[build-badge]: https://github.com/vfile/vfile-reporter-pretty/workflows/main/badge.svg\n\n[build]: https://github.com/vfile/vfile-reporter-pretty/actions\n\n[coverage-badge]: https://img.shields.io/codecov/c/github/vfile/vfile-reporter-pretty.svg\n\n[coverage]: https://codecov.io/github/vfile/vfile-reporter-pretty\n\n[downloads-badge]: https://img.shields.io/npm/dm/vfile-reporter-pretty.svg\n\n[downloads]: https://www.npmjs.com/package/vfile-reporter-pretty\n\n[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size\u0026query=$.size.compressedSize\u0026url=https://deno.bundlejs.com/?q=vfile-reporter-pretty\n\n[size]: https://bundlejs.com/?q=vfile-reporter-pretty\n\n[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg\n\n[backers-badge]: https://opencollective.com/unified/backers/badge.svg\n\n[collective]: https://opencollective.com/unified\n\n[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg\n\n[chat]: https://github.com/vfile/vfile/discussions\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c\n\n[esmsh]: https://esm.sh\n\n[typescript]: https://www.typescriptlang.org\n\n[contributing]: https://github.com/vfile/.github/blob/main/contributing.md\n\n[support]: https://github.com/vfile/.github/blob/main/support.md\n\n[health]: https://github.com/vfile/.github\n\n[coc]: https://github.com/vfile/.github/blob/main/code-of-conduct.md\n\n[license]: license\n\n[author]: https://sindresorhus.com\n\n[screenshot]: screenshot.png\n\n[vfile]: https://github.com/vfile/vfile\n\n[vfile-reporter]: https://github.com/vfile/vfile-reporter\n\n[eslint-formatter-pretty]: https://github.com/sindresorhus/eslint-formatter-pretty\n\n[api-reporter-pretty]: #reporterprettyfiles\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvfile%2Fvfile-reporter-pretty","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvfile%2Fvfile-reporter-pretty","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvfile%2Fvfile-reporter-pretty/lists"}