Commit Graph

94 Commits (5c6fd80d509aeffe6760801d3a63e1b8df92e338)

Author SHA1 Message Date
Shaun LeBron 2fd7199c11 Clarify when original styling is significant (#1620)
* Clarify when original styling is significant

* add superscript "1" as footnote link

* use "*" instead of "1" to denote a caveat
2017-05-17 21:03:52 -07:00
Joseph Frazier f5c52890b5 Fix typo: parse -> parser (#1596) 2017-05-12 08:04:42 -07:00
Christopher Chedeau ef9a93dce2 Update README.md 2017-05-10 15:55:00 -07:00
Stephen Eisenhauer dfbea5d8ab Improve clarity of boolean option documentation (#1573)
As discussed on #1564, improve the clarity of the descriptions for the bracketSpacing and semicolons options by describing what the options do rather than what their CLI overrides do; These were confusing as written because these options default to true, and their CLI overrides trigger the opposite behavior.
2017-05-10 08:15:32 -07:00
Joseph Frazier 8ce393a425 Remove trailing whitespace from src/ and markdown files (#1576) 2017-05-10 08:15:11 -07:00
Joseph Frazier ebe85917a3 Add warning about vanilla Vim integration, recommend Neoformat (#1568)
* Add warning about vanilla Vim integration

Fixes https://github.com/prettier/prettier/issues/743
Fixes https://github.com/prettier/prettier/issues/1191
Fixes https://github.com/prettier/prettier/issues/1466

* Recommend Neoformat over vanilla Vim integration

See https://github.com/prettier/prettier/issues/743
See https://github.com/prettier/prettier/issues/1191
See https://github.com/prettier/prettier/issues/1466

* Remove vanilla Vim integration from README

Since it's relatively broken, we don't want to recommend it.
See https://github.com/prettier/prettier/pull/1568#issuecomment-300270038

This also adds a TOC link for the "Other `autocmd` events" section,
which was previously missing.
2017-05-09 12:50:01 -07:00
Stephen Eisenhauer 93472d0998 Fix incorrect options documentation in README (#1564)
* Fix incorrect options documentation in README

The options section in the README (which appears to be the primary source of truth for documentation) had incorrectly conflated the bracketSpacing and jsxBracketSameLine options into a single table row (using the human readable name for one, the machine readable names for another, and combined descriptions of both). This patch splits the row into two accurate ones.

* Revise previous correction to options documention in README

Incorporating feedback in #1564
2017-05-09 12:06:40 -07:00
Joseph Frazier 225fa57780 Mention --debug-check in CLI section of README (#1562)
* Prevent using --write with --debug-check

This addresses https://github.com/prettier/prettier/issues/1552#issuecomment-300043294

* Exit with a non-zero code if --debug-check fails

This makes it easier to use programmatically. See
https://github.com/prettier/prettier/issues/1552#issuecomment-300042417

* Mention --debug-check in CLI section of README

This addresses https://github.com/prettier/prettier/issues/1552#issuecomment-300043294
2017-05-09 02:51:04 -07:00
Prathik Shetty c2bdcbe996 Include pre-commit plugin (#1493)
* Update README.md

* Update README.md

* Update README.md

* Update README.md
2017-05-06 07:59:23 -07:00
Dorian Karter d3d5d57984 Use setlocal in all vim examples (#1403) 2017-05-05 09:13:08 -07:00
Jake Trent 3cfc37d411 Options readme (#1406)
* add options table to readme

* remove options from api usage in favor of options table

and link a few paragraphs to the options section
2017-05-05 09:10:23 -07:00
Michal Srb 768a81c5d5 Add example of using yarn test with arguments (#1383)
Not sure if the copy is great, but since this is mostly for n00bs, better to err on side of more information.
2017-04-21 15:54:28 -07:00
Brent Vatne e2fbaaf1f3 Update link to @vjeux's React London presentation (#1330) 2017-04-19 10:22:01 -07:00
Joseph Frazier dc499ba990 Add information about Vim's other autocmd events (#1333)
This lets you configure Vim to format your code even more frequently.
2017-04-18 15:30:16 -07:00
Joseph Frazier 652e2f90fb Add prettier_d to Related Projects (#1328)
`prettier_d` is like [eslint_d], but it runs `prettier` instead of
`eslint`. This eliminates the Node.js startup delay from all but the
first run of `prettier_d`, making it a snappier experience.

[eslint_d]: https://github.com/mantoni/eslint_d.js

Related discussion:
* https://github.com/prettier/prettier/issues/575#issuecomment-277368389
* https://github.com/prettier/prettier/issues/918#issuecomment-294130268
* https://github.com/prettier/prettier/pull/753#issuecomment-294339207
2017-04-18 13:27:36 -07:00
Tim 67a137f6d5 Double quotes for option values in Readme file (#1314) 2017-04-17 15:07:38 -07:00
Giorgio Polvara 1625730755 Remove emoji part from lint-staged's name (#1302) 2017-04-16 09:47:08 -07:00
Ethan Cohen 8ba3fc8623 Add --dev option to suggested install cmd (#1289)
Prettier should be saved to `devDependencies`
2017-04-15 07:05:38 -07:00
Bill Mill 306870a2a0 match jsx files in pre-commit hook (#1276) 2017-04-14 11:16:17 -04:00
Jason Laster 1802545865 Document debugging strategies (#1253) 2017-04-13 15:50:21 -07:00
Mike Wilcox 6ecbb99e8a fix small typo (#1255) 2017-04-13 15:49:27 -07:00
Douglas Wade d39654fa8b [1242]: Prettier 1.0 is the stabler release we've been waiting for (#1243) 2017-04-13 14:23:14 -07:00
Alex Rattray 36bec87d17 Enable no-semi mode and protect against ASI failures (#1129) 2017-04-11 13:50:47 -07:00
Christopher Chedeau 9d5e8f19e4 Update README.md 2017-04-10 16:18:01 -07:00
Christopher Chedeau 53d2b5e50c Add talks 2017-04-10 16:17:39 -07:00
Simon Lydell dc93bdc983 Sync the Flow tests (#1163)
* Extract custom tests from tests/flow/

Approach:

1. Remove all .js files in tests/flow except .snap.js files.
2. Copy over all .js files from tests/ in the flow repo.
3. Go through the diff looking for deletions.
   - It was easy to see which deletions were due to changes in the tests
     due to updates in the flow repo.
   - For the rest of the deletions, I used `git blame` to verify that
     they had been added by us since the flow tests were copied over.

This makes tests/flow/ simply a copy of the tests from the flow repo,
making it easier to sync with the upstream flow tests in the future.

* Add a script for syncing the flow tests

* Sync the flow tests
2017-04-08 07:52:38 -07:00
Rafael Hengles 728f3fb408 Change prettier-with-tabs to prettier-miscellaneous (#1149) 2017-04-07 07:56:55 -07:00
Rafael Hengles 170e4d558a Refactored option to indent with tabs (#1026)
Refactored option to indent with tabs
2017-04-06 22:49:37 -04:00
Gregor Adams 3ddd6c9271 docs(readme) added TOC (#1123)
generate table of contents for readme.

closes #1122
2017-04-05 08:55:26 -07:00
Dara Hak cefec125f7 Update README.md: fixed typo, added links (#1115) 2017-04-04 14:23:52 -07:00
Brian Holt eff5af6ca9 Add check method to Prettier Node API. (#1104)
* Add check method to Prettier. Make CLI use that method for list-different

* Catch in check and return false if it throws

* Remove catch/finally from Prettier list-different bin

* remove try catch in prettier bin for list-different
2017-04-03 09:54:10 -07:00
Yatharth Khatri a707dda53b note on styled-with-prettier badge to README (#1095) 2017-03-29 15:26:01 +01:00
Christopher Moeller 7702a2b1e3 Add note to README regarding vim-jsx plugin (#1085) 2017-03-25 08:10:38 -07:00
Karl Horky 862adaf94d Document prettier-ignore (#1082)
Original PR: prettier/prettier#671
2017-03-23 07:33:04 -07:00
Erick Romero 24f9cc3a71 Vim readme (#1058)
* Moved Vim info to its own editor folder, started drafting new README

* Finished first draft, ready for PR

* Testing Readme layout

* Removed vim folder
2017-03-20 22:12:10 -07:00
Adam Stankiewicz 60b6d6fc56 Mention prettier-standard package (#1010) 2017-03-16 10:33:23 -07:00
Bill Mill f5ede513eb update the README to add a pre-commit hook (#944)
* update the README to add a pre-commit hook

* remove comments

* better wording

* better quoting

* consistent prettier binary

* move the tr and fix the quoting

* fix quotes one last time
2017-03-07 19:55:43 -08:00
Patrick Camacho 513b57db3a Update README.md (#928)
typo fix
2017-03-07 11:38:58 -08:00
Andrey Okonetchnikov 3045829a61 Update lint-staged docs to use husky for less config. (#923) 2017-03-07 09:53:00 -08:00
Simon Lydell 25bbe1accb Improve readme CLI usage example (#910)
- Use double quotes for cmd.exe support. See #761.
- Remove redundant example and merge it into the previous.
2017-03-06 03:45:16 -08:00
Jed Watson 74b6466ee7 Add CLI Example to Readme (#909)
Simple change to add a real world example of CLI usage, because it wasn't immediately obvious to me how it should actually look
2017-03-05 21:51:51 -08:00
David Ascher c8c91d4af3 Fix typo (#891)
I believe that the instructions for pre-commit config are off by a character.
2017-03-04 11:47:35 -08:00
Christopher Chedeau a91bb5f2ec Fix travis build image 2017-03-02 19:20:45 -08:00
Simon Lydell 25340671d3 Update list of related projects (#833) 2017-02-28 09:24:08 -08:00
Spencer Dixon a59e2c652f Adds another preset to related projects (#820) 2017-02-27 16:50:38 -05:00
Christopher Chedeau 9a447c05ec Correct link for travis 2017-02-24 15:56:13 -08:00
Umidbek Karimov 278b489f38 Use double quotes in script wildcards to support windows `cmd.exe`. (#761) 2017-02-21 07:49:07 -08:00
James Long 77f6f4de68 Add note about trailingComma option in versions 0.18.0 and below 2017-02-20 09:33:22 -05:00
James Long 9399c1b656 Update README with valid trailingComma options 2017-02-18 08:58:34 -05:00
Vincent Voyer 417279cacd docs(README): use yarn add for consistency (#734)
Other places we say we default to yarn but then we use npm, was confusing a bit.
2017-02-17 11:10:07 -08:00