Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up README #1

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 6 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,6 @@
# archived

prettier made some changes that breaks plugins entirely

___


prettier mirror
===============

This is a fork of the (now archived) https://github.com/pre-commit/mirrors-prettier with the only difference
being that it only references release versions of prettier, not e.g. alpha/beta versions.

Mirror of prettier package for pre-commit.

For pre-commit: see https://github.com/pre-commit/pre-commit
Expand All @@ -31,23 +21,16 @@ Add this to your `.pre-commit-config.yaml`:

*note*: only prettier versions >= 2.1.0 are supported

When using plugins with `prettier` you'll need to declare them under
`additional_dependencies`. For example:

```yaml
- repo: https://github.com/rbubley/mirrors-prettier
rev: '' # Use the sha / tag you want to point at
hooks:
- id: prettier
additional_dependencies:
- [email protected]
- '@prettier/[email protected]'
```

By default, all files are passed to `prettier`, if you want to limit the
file list, adjust `types` / `types_or` / `files`:

```yaml
- id: prettier
types_or: [css, javascript]
```


### History

This is a fork of the (now archived) https://github.com/pre-commit/mirrors-prettier with the only difference
being that it only references release versions of prettier, not e.g. alpha/beta versions.