Security News
New Proposed CISA Mandate Would Require Critical Infrastructure to Report Ransom Payments Within 24 Hours
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
pretty-quick
Advanced tools
Get Pretty Quick
Weekly downloads
Package description
The pretty-quick npm package is a tool that runs Prettier, an opinionated code formatter, on your changed files. It integrates with version control systems like Git to format only the files that have been modified. This can be particularly useful as a pre-commit hook to ensure code style consistency without having to format the entire codebase on every commit.
Running on Changed Files
Run Prettier on all files that have changed since the last commit. This is the basic usage and can be integrated into pre-commit hooks.
npx pretty-quick
Running with Specific Options
Run Prettier on all changed files but filter them by a specific pattern. In this case, only JavaScript files will be formatted.
npx pretty-quick --pattern "**/*.js"
Staging Changes
Run Prettier on all staged files and re-stage the changes automatically. This is useful for ensuring that only formatted code gets committed.
npx pretty-quick --staged
Husky is a tool for managing Git hooks. It allows you to run scripts at various points in the Git lifecycle, such as pre-commit or pre-push. While it doesn't format code by itself, it is often used in conjunction with tools like Prettier or pretty-quick to enforce code style by running them as pre-commit hooks.
Lint-staged is similar to pretty-quick in that it runs linters on staged files in Git. It is more flexible than pretty-quick because it can run any command, not just Prettier, and it can be configured to run different commands for different file types.
Prettier itself is the underlying code formatter that pretty-quick leverages. While pretty-quick focuses on running Prettier only on changed files, Prettier can be used to format entire codebases or individual files, regardless of their version control status.
Readme
pretty-quick
Get Pretty Quick
Runs Prettier on your changed files.
Supported source control managers:
# npm
npm install -D prettier pretty-quick
# yarn
yarn add -D prettier pretty-quick
# npx
npx pretty-quick
# yarn
yarn pretty-quick
You can run pretty-quick
as a pre-commit
hook using simple-git-hooks
.
# npm
npm install -D simple-git-hooks
# yarn
yarn add -D simple-git-hooks
In package.json
, add:
"simple-git-hooks": {
"pre-commit": "pretty-quick --staged"
}
--staged
(only git)Pre-commit mode. Under this flag only staged files will be formatted, and they will be re-staged after formatting.
Partially staged files will not be re-staged after formatting and pretty-quick will exit with a non-zero exit code. The intent is to abort the git commit and allow the user to amend their selective staging to include formatting fixes.
--no-restage
(only git)Use with the --staged
flag to skip re-staging files after formatting.
--branch
When not in staged
pre-commit mode, use this flag to compare changes with the specified branch. Defaults to master
(git) / default
(hg) branch.
--pattern
Filters the files for the given minimatch pattern.
For example pretty-quick --pattern "**/*.*(js|jsx)"
or pretty-quick --pattern "**/*.js" --pattern "**/*.jsx"
--verbose
Outputs the name of each file right before it is processed. This can be useful if Prettier throws an error and you can't identify which file is causing the problem.
--bail
Prevent git commit
if any files are fixed.
--check
Check that files are correctly formatted, but don't format them. This is useful on CI to verify that all changed files in the current branch were correctly formatted.
--no-resolve-config
Do not resolve prettier config when determining which files to format, just use standard set of supported file types & extensions prettier supports. This may be useful if you do not need any customization and see performance issues.
By default, pretty-quick will check your prettier configuration file for any overrides you define to support formatting of additional file extensions.
Example .prettierrc
file to support formatting files with .cmp
or .page
extensions as html.
{
"printWidth": 120,
"bracketSpacing": false,
"overrides": [
{
"files": "*.{cmp,page}",
"options": { "parser": "html" }
}
]
}
--ignore-path
Check an alternative file for ignoring files with the same format as .prettierignore
.
For example pretty-quick --ignore-path .gitignore
pretty-quick
will respect your .prettierrc
, .prettierignore
, and .editorconfig
files if you don't use --ignore-path
. Configuration files will be found by searching up the file system. .prettierignore
files are only found from the repository root and the working directory that the command was executed from.
FAQs
Get Pretty Quick
The npm package pretty-quick receives a total of 895,054 weekly downloads. As such, pretty-quick popularity was classified as popular.
We found that pretty-quick demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Security News
Redis is no longer OSS, breaking its explicit commitment to remain under the BSD 3-Clause License forever. This has angered contributors who are now working to fork the software.
Product
Socket AI now enables 'AI detected potential malware' alerts by default, ensuring users benefit from AI-powered state-of-the-art malware detection without needing to opt-in.