{"id":13432772,"url":"https://github.com/sindresorhus/eslint-formatter-pretty","last_synced_at":"2025-05-14T16:03:59.801Z","repository":{"id":50042180,"uuid":"56529985","full_name":"sindresorhus/eslint-formatter-pretty","owner":"sindresorhus","description":"Pretty ESLint formatter","archived":false,"fork":false,"pushed_at":"2024-07-26T14:21:54.000Z","size":157,"stargazers_count":506,"open_issues_count":2,"forks_count":24,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-10-29T15:46:34.015Z","etag":null,"topics":["eslint","eslint-formatter","nodejs","npm-package","pretty","reporter","xo"],"latest_commit_sha":null,"homepage":null,"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/sindresorhus.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":".github/security.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"sindresorhus","open_collective":"sindresorhus","buy_me_a_coffee":"sindresorhus","custom":"https://sindresorhus.com/donate"}},"created_at":"2016-04-18T18:02:24.000Z","updated_at":"2024-10-22T09:51:59.000Z","dependencies_parsed_at":"2023-12-23T08:40:05.344Z","dependency_job_id":"d615e6f9-3460-480d-b8cc-0a5d0bb380c5","html_url":"https://github.com/sindresorhus/eslint-formatter-pretty","commit_stats":{"total_commits":77,"total_committers":21,"mean_commits":"3.6666666666666665","dds":"0.37662337662337664","last_synced_commit":"88f108852d01db020a4dbd65a56d05468195dcbe"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sindresorhus%2Feslint-formatter-pretty","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sindresorhus%2Feslint-formatter-pretty/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sindresorhus%2Feslint-formatter-pretty/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sindresorhus%2Feslint-formatter-pretty/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sindresorhus","download_url":"https://codeload.github.com/sindresorhus/eslint-formatter-pretty/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247352583,"owners_count":20925295,"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":["eslint","eslint-formatter","nodejs","npm-package","pretty","reporter","xo"],"created_at":"2024-07-31T02:01:16.387Z","updated_at":"2025-04-09T11:03:05.871Z","avatar_url":"https://github.com/sindresorhus.png","language":"JavaScript","funding_links":["https://github.com/sponsors/sindresorhus","https://opencollective.com/sindresorhus","https://buymeacoffee.com/sindresorhus","https://sindresorhus.com/donate"],"categories":["JavaScript","nodejs"],"sub_categories":[],"readme":"# eslint-formatter-pretty\n\n\u003e Pretty formatter for [ESLint](https://eslint.org)\n\n![](screenshot.png)\n\n## Highlights\n\n- Pretty output.\n- Sorts results by severity.\n- Stylizes inline codeblocks in messages.\n- Command-click a rule ID to open its docs.\n- Command-click a header to reveal the first error in your editor. *(iTerm-only)*\n\n## Install\n\n```sh\nnpm install --save-dev eslint-formatter-pretty\n```\n\n*Please note that to use version 6 of this package you will HAVE to use ESLint v9+. If you're using ESLint v8 or below, install with `npm install --save-dev eslint-formatter-pretty@5` instead.*\n\n## Usage\n\n### [XO](https://github.com/xojs/xo)\n\nNothing to do. It's the default formatter.\n\n### ESLint CLI\n\n```sh\neslint --format=pretty file.js\n```\n\n### [grunt-eslint](https://github.com/sindresorhus/grunt-eslint)\n\n```js\ngrunt.initConfig({\n\teslint: {\n\t\ttarget: ['file.js'].\n\t\toptions: {\n\t\t\tformat: 'pretty'\n\t\t}\n\t}\n});\n\ngrunt.loadNpmTasks('grunt-eslint');\ngrunt.registerTask('default', ['eslint']);\n```\n\n### [gulp-eslint](https://github.com/adametry/gulp-eslint)\n\n```js\nimport gulp from 'gulp';\nimport eslint from 'gulp-eslint';\n\nexport const lint = (\n\tgulp.src('file.js')\n\t\t.pipe(eslint())\n\t\t.pipe(eslint.format('pretty'))\n);\n```\n\n### [eslint-loader](https://github.com/MoOx/eslint-loader) *(webpack)*\n\n```js\nimport eslintFormatterPretty from 'eslint-formatter-pretty';\n\nexport default {\n\tentry: ['file.js'],\n\tmodule: {\n\t\trules: [\n\t\t\t{\n\t\t\t\ttest: /\\.js$/,\n\t\t\t\texclude: /node_modules/,\n\t\t\t\tloader: 'eslint-loader',\n\t\t\t\toptions: {\n\t\t\t\t\tformatter: eslintFormatterPretty\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n};\n```\n\n## Tips\n\nIn iTerm, \u003ckbd\u003eCommand\u003c/kbd\u003e-click the filename header to open the file in your editor.\n\nIn [terminals with support for hyperlinks](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda#supporting-apps), \u003ckbd\u003eCommand\u003c/kbd\u003e-click the rule ID to open its docs.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsindresorhus%2Feslint-formatter-pretty","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsindresorhus%2Feslint-formatter-pretty","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsindresorhus%2Feslint-formatter-pretty/lists"}