beautifier/js-beautify

Add option to run js-beautify as check with fail on change

Open

#741 opened on Jul 20, 2015

View on GitHub
 (12 comments) (10 reactions) (0 assignees)JavaScript (8,342 stars) (1,460 forks)batch import
good first issuetype: enhancement

Description

In order to run js-beautify as a non-intrusive pre-commit hook in git (or any other place where you wish to check that the code is beautified, but not actually change it), it would help immensely to have an option not to actually save the beautified version of a file anywhere, but to just have js-beautify fail with a non-zero exit code and some reasonable message.

Contributor guide

Tech stack
javascriptnodejs
Domain
clitooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptCLI basicsNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Examine the main entry point of js beautify (likely in bin/js beautify.js) to understand how options are parsed and how files are processed. Look at how the current beautification is performed and where the output is written. The goal is to add a ' check' flag that runs beautification but instead of saving, compares the result to the original and fails with exit code 1 if different. Review any existing configuration options for similar behavior.