{"id":40983,"library":"eslint-formatter-beauty","title":"eslint-formatter-beauty","description":"A beautiful formatter for ESLint that provides visually appealing output with code frames. Current stable version is 3.0.0. Maintenance-focused, with no recent breaking changes. Differentiates from default ESLint formatters by offering colorized, structured output that enhances readability of lint results. Suitable for use with ESLint CLI, gulp-eslint, and eslint-loader.","status":"active","version":"3.0.0","language":"javascript","source_language":"en","source_url":"https://github.com/g-plane/eslint-formatter-beauty","tags":["javascript","beauty","beautiful","codeframe","eslint","eslint-formatter"],"install":[{"cmd":"npm install eslint-formatter-beauty","lang":"bash","label":"npm"},{"cmd":"yarn add eslint-formatter-beauty","lang":"bash","label":"yarn"},{"cmd":"pnpm add eslint-formatter-beauty","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"peer dependency required for formatting functionality","package":"eslint","optional":false}],"imports":[{"note":"When using ESLint CLI, use the formatter name without the prefix.","wrong":"eslint -f eslint-formatter-beauty path/to/file.js","symbol":"eslint-formatter-beauty","correct":"eslint -f=beauty path/to/file.js"},{"note":"The package is CJS-only; use require() in Node.js. Not available as ESM.","wrong":"import formatter from 'eslint-formatter-beauty'","symbol":"eslint-formatter-beauty","correct":"const formatter = require('eslint-formatter-beauty')"},{"note":"For gulp-eslint, pass the formatter function directly, not a string.","wrong":"eslint.format('beauty')","symbol":"eslint-formatter-beauty","correct":"eslint.format(require('eslint-formatter-beauty'))"}],"quickstart":{"code":"npm install --save-dev eslint eslint-formatter-beauty\necho '{\"rules\":{\"semi\":\"error\"}}' > .eslintrc.json\necho 'var x = 1' > test.js\nnpx eslint -f=beauty test.js","lang":"javascript","description":"Install the formatter, create a minimal ESLint config with a rule, a test file with an error, and run ESLint using the beauty formatter."},"warnings":[{"fix":"Use require() instead of import.","message":"The formatter is CJS-only and cannot be imported via ESM.","severity":"gotcha","affected_versions":">=3.0.0"},{"fix":"Use -f=beauty.","message":"When using with ESLint CLI, specify the formatter as '-f=beauty' not '-f=eslint-formatter-beauty'.","severity":"gotcha","affected_versions":">=3.0.0"},{"fix":"Switch to eslint-webpack-plugin and use the formatter option.","message":"eslint-loader is deprecated; use eslint-webpack-plugin instead.","severity":"deprecated","affected_versions":">=3.0.0"},{"fix":"Ensure ESLint is properly configured for actual rule checks.","message":"The formatter only processes ESLint results; it does not change linting behavior.","severity":"gotcha","affected_versions":">=3.0.0"}],"env_vars":null,"search_vec":"'3.0.0':22 'appeal':13 'beauti':4,6,61,62 'break':29 'chang':30 'cli':52 'code':16 'codefram':63 'color':38 'current':18 'default':33 'differenti':31 'enhanc':42 'eslint':2,9,34,51,55,58,64,66 'eslint-formatt':65 'eslint-formatter-beauti':1 'eslint-load':57 'focus':25 'formatt':3,7,35,67 'frame':17 'gulp':54 'gulp-eslint':53 'javascript':60 'lint':45 'loader':59 'mainten':24 'maintenance-focus':23 'offer':37 'output':14,40 'provid':11 'readabl':43 'recent':28 'result':46 'stabl':19 'structur':39 'suitabl':47 'use':49 'version':20 'visual':12","created_at":"2026-06-04T18:50:12.631167+00:00","updated_at":"2026-06-04T18:50:12.631167+00:00","problems":[{"fix":"Run `npm install --save-dev eslint-formatter-beauty`.","cause":"The package is not installed or not in node_modules.","error":"Error: Cannot find module 'eslint-formatter-beauty'"},{"fix":"Use `eslint -f=beauty` instead of `eslint -f=eslint-formatter-beauty`.","cause":"Using the full package name instead of just 'beauty' in CLI.","error":"Invalid format option: 'beauty' is not a valid formatter."},{"fix":"Pass the result of `require('eslint-formatter-beauty')` as the formatter argument.","cause":"When using with gulp-eslint, passing a string instead of the required module.","error":"TypeError: formatter is not a function"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/g-plane/eslint-formatter-beauty","github":"https://github.com/g-plane/eslint-formatter-beauty","docs":null,"changelog":null,"pypi":null,"npm":"eslint-formatter-beauty","openapi_spec":null,"status_page":null,"smithery":null,"categories":["testing"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-04","next_check":"2026-09-02","install_tag":null}}