Commit Graph
40 Commits
Author SHA1 Message Date
Sunshioandfisker Cheung 09316aa830 docs: Add documentation for Bun.sh (#16153)
Co-authored-by: fisker Cheung <lionkay@gmail.com>
2024-04-10 17:40:26 +08:00
Tech Geniusandfisker Cheung 721a050d0b docs: removed the entire pretty-quick section (#15337)
Co-authored-by: fisker Cheung <lionkay@gmail.com>
2023-09-14 15:16:08 +08:00
SUZUKI Sosuke 0b6d400cf8 Add docs for pnpm (#14455) 2023-03-06 14:03:06 +09:00
David De Sloovereandfisker Cheung df1f6ad1ac Update Husky.Net info (#13883)
Co-authored-by: fisker Cheung <lionkay@gmail.com>
2022-12-15 14:50:24 +08:00
AliReZa Sabouriandfisker Cheung 7c16d226f1 docs: Add Husky.Net option (#12040)
Co-authored-by: fisker Cheung <lionkay@gmail.com>
2022-01-05 09:43:23 +08:00
Carlos Frias ae33e494a9 fix(docs): lint-staged install instructions (#11363)
As per https://github.com/okonet/lint-staged#installation-and-setup

The previous ones were not working.
2021-09-13 19:38:11 +03:00
Boris K 7cfa9aa89b Fix pre-commit hook setup command (#10710) 2021-05-09 15:44:34 +03:00
typicode 48628eb17d docs(precommit): update husky installation (#10658) 2021-04-08 20:26:09 +03:00
Jonas DOREL fd29bfc7c5 docs(precommit): Ignore unknown files (#10634)
Without `--ignore-unknown`, files without an extension or with an unknown extension would trigger the following error :
```
.gitignore[error] No parser could be inferred for file: ansible.cfg
```
2021-03-29 13:50:36 +03:00
Mikhail Gorbunov 7678033855 husky -> simple-git-hooks (#10601)
`Lint staged` along with `mrm` recently migrated from `husky` to `simple-git-hooks`.

It is reflected in their [docs](https://github.com/okonet/lint-staged):

> It will install and configure simple-git-hooks and lint-staged depending on code quality tools from package.json dependencies so please make sure you install (npm install --save-dev) and configure all code quality tools like Prettier, ESlint prior that.

Migration brought these benefits for users: 

* lighter `node_modules` 
   `simple-git-hooks` (10 kb) is lighter then husky4 (1mb) and husky5 (25kb)
* Out of the box `Yarn 2` support
* No worry for licensing. 
   Simple git hooks has MIT license, like husky 4
2021-03-27 01:08:24 +02:00
ed49bf10a0 Moved pre-commit support to github.com/pre-commit/mirrors-prettier (#8937)
Co-authored-by: fisker Cheung <lionkay@gmail.com>
Co-authored-by: sosukesuzuki <aosukeke@gmail.com>
2020-11-16 18:27:34 +08:00
e3d1f0dee0 CLI: Add --ignore-unknown (#8829)
Co-authored-by: Georgii Dolzhykov <thorn.mailbox@gmail.com>
Co-authored-by: sosukesuzuki <aosukeke@gmail.com>
2020-08-21 09:11:59 +08:00
solimant b22ed01625 Remove the precise-commits section (#8722)
Unfortunately, the precise-commit repo does not seem to have been maintained for about two years:
- [most recent commit](https://github.com/nrwl/precise-commits/commit/803871289f59e2c326b4d20c08e6b1b862c0408e) to master was on Mar 27, 2018
- [most recent release](https://github.com/jameshenry/precise-commits/compare/v1.0.1...v1.0.2) was on Feb 16, 2018
- [most recently closed issue](https://github.com/nrwl/precise-commits/issues/19) was closed on Jul 29, 2018

I have [requested](https://github.com/nrwl/precise-commits/issues/58) archiving.

This is sad. I could think of several use-cases where a tool like `precise-commits` could be very useful, especially for already matured projects that are trying to onboard linting and prettifying.
2020-07-11 20:07:01 +08:00
Simon Lydell ca437912cc Update stable docs (#8652) 2020-07-01 08:44:21 +02:00
554b15473d Document recommended setup and improve docs overall (#8510)
Co-authored-by: Jed Fox <git@twopointzero.us>
Co-authored-by: Georgii Dolzhykov <thorn.mailbox@gmail.com>
2020-06-28 09:47:29 +08:00
Jesse Hallett 61d3936b6e Add docs on using prettier with git-format-staged in a pre-commit hook (#7074)
* Add docs on using prettier with git-format-staged in a pre-commit hook

* wording change to use case description

* Add "unstage" and "unstaged" to cspell dictionary

* add note about Python requirement
2020-02-25 13:11:47 +02:00
fisker Cheung 3dbe4b2038 Docs: add link to devDependencies (#6682) 2019-10-18 10:36:24 +02:00
Beau Fabry 2314640485 include renames in git pre-commit hook (#6371) 2019-08-15 12:34:19 +03:00
Andrey Okonetchnikov 8a8b88f2e6 docs: Add simplified installation instructions for lint-staged (#5911)
* docs: Add simplified installation instructions for lint-staged

Currently, to install and configure lint-staged you'd need to manually install all packaged and modify the `package.json`. 
With `mrm` it's done automatically depending on what version of Prettier is installed and specified in project's dependencies.

* docs: Update according to feedback

* Update docs/precommit.md

Co-Authored-By: okonet <okonet@users.noreply.github.com>
2019-03-12 12:01:13 -04:00
m-adler e83490a90e Escape spaces within file names in pre-commit hook script (#5721) 2019-01-07 23:30:20 -07:00
Andrey Okonetchnikov 7238ceffab docs: Remove the warning about partially staged files (#5310)
Since partially staged files are now officially supported, this isn't up to date anymore.
2018-10-29 09:16:28 -03:00
Jeremy Kairis 8979b47630 Fix a typo in precommit.md Option 4. (#5196)
* Fix a typo in precommit.md Option 4.

* Remove the a
2018-10-07 07:42:41 -04:00
typicode c8d22c6ed5 docs: remove next tag for husky (#5141)
Husky 1.0 was released and isn't behind a `@next` tag anymore :)
2018-09-24 13:31:50 +08:00
Ika 514fcb835a chore: bump Prettier dependency to 1.14.0 2018-07-29 15:44:21 +08:00
Ika 86614bd16d docs(precommit): add missing @next for husky 2018-07-28 13:51:18 +08:00
Steven Loria ef7d96e124 Fix precommit configuration in docs (#4817)
The "sha" option has been renamed to "rev"

See https://pre-commit.com/#pre-commit-configyaml---repos
2018-07-10 12:27:25 -07:00
Kevin Peters 975402b285 docs: fix example of husky pre-commit hook to include next version tag (#4812) 2018-07-10 12:23:44 -07:00
Peter Ramsing d4f4edeb96 Adds closing quote to "hooks" in husky config (#4805) 2018-07-04 11:31:49 -04:00
Christian Haug 8ef10b2177 Update docs to be compatible with latest husky version (#4803) 2018-07-04 10:15:46 -03:00
Anthony Sottile 2e59f178aa No longer need to clarify that pre-commit is "Python version" (#4089) 2018-03-02 10:14:20 -05:00
Anthony Sottile a02094961a pre-commit.com is now served on https (#4088) 2018-03-02 07:26:36 -05:00
Milen Igrachev 29ef3f0033 Enhancing pre-commit bash script documentation. (#3638)
* Enhancing pre-commit bash script documentation.

* Correcting typo.

* attempt to correct lint problem

* Grammar clarification.

* Further styling correction

Mark .git/hooks/post-commit as ```code```

* Remove redundant exit 0 from post-install script.

* Insert newline
2018-02-24 19:12:25 +11:00
Sam Horton 67bf3e51df docs: add information about precise-commits (#3818)
* docs: add information about precise-commits

* docs: add use case info to precommit documentation
2018-02-02 14:46:17 +11:00
Lucas Azzola eb1096d4af Add pretty-quick pre-commit docs (#3675) 2018-01-09 02:19:53 +11:00
Jiawen Geng ea4bc9093e fix recursive in script (#3565)
See more here : https://github.com/prettier/prettier/issues/2078.
2017-12-25 20:16:50 +11:00
Jiawen Geng 0a28c7484f Add js version pre-commit (#3541) 2017-12-20 18:08:42 -02:00
Lucas Duailibe c9079926c9 Improve visibility of lint-staged usage warning (#3445) 2017-12-10 00:09:07 -02:00
Maxime Thirouin a9502f0ab7 Add "md" extension in "Pre-commit hook" documentation (#3421)
It's nice to have all extensions so we can easily copy paste :)
2017-12-06 20:34:58 +11:00
Ika 76efb33e75 chore: setup markdown formatting (#3224)
* chore(deps): upgrade prettier to v1.8.2

* chore: setup lint-docs script

* docs: add `<!-- prettier-ignore -->`s

* docs: format docs

* Revert "docs: format docs"

This reverts commit 6dba903987dddc498cb589ca311905f25b6aee53.

* chore(prettierrc): set `--no-prose-wrap`

* docs: format docs

* Revert "docs: format docs"

This reverts commit 139bd744b6921916be8fac4fa3bab83bae5d12df.

* docs: tweak

* docs: format docs

* chore: rename .prettierrc

* chore: rename back to .prettierrc

* chore: split out third-party

* refactor: fix linting

* chore: do not split out third-party on website
2017-11-22 22:27:40 +11:00
Lucas Azzola 71a5533c4e Move all docs to website (#3139)
* Sync README -> docs/options.md

* Sync README -> docs/*.md

* Misc fixups

* Remove markdown-toc

* Remove insert-pragma from ToC

* Never again!

* Move all docs to ./docs

* Remove yarn toc

* Fix inter-doc links

* Fix links in footer

* Clean up README.md

* Add basic description to README.md

* Use flat badges

* Move editor guides to website

* Improve prettier-ignore docs

* Fixup bad find/replace

* Add JSON to README

* Fix custom parser API link

* Fixup GitHub centering, add downloads badge

* Add 1.8 docs

* docs(website): mention markdown on homepage (#1)

* Add intro

* Add watching-files.md

* Fix markdown syntax highlighting

* Switch back to .md links
2017-11-07 14:39:07 +11:00