docs(test): add instruction on how to integrate test in pre-commit hook #2598
Conversation
| @@ -52,13 +52,13 @@ You can find the most recent version of this guide [here](https://github.com/fac | |||
| - [Filename Conventions](#filename-conventions) | |||
| - [Command Line Interface](#command-line-interface) | |||
| - [Version Control Integration](#version-control-integration) | |||
There was a problem hiding this comment.
Let's instead move both Integration sections after Coverage Reporting.
|
|
||
| The build command will check for linter warnings and fail if any are found. | ||
|
|
||
| ### Pre-commit Hook |
There was a problem hiding this comment.
Seems like this should either be #### or become a new entry in table of contents.
|
@gaearon ok, ready to be reviewed |
| @@ -1084,13 +1085,38 @@ The watcher includes an interactive command-line interface with the ability to r | |||
|
|
|||
|  | |||
|
|
|||
| ### Version Control Integration | |||
| ### Pre-commit Hook | |||
There was a problem hiding this comment.
Let's move this right after Continuous Integration section?
| @@ -1327,6 +1294,39 @@ The test command will force Jest to run tests once instead of launching the watc | |||
|
|
|||
| The build command will check for linter warnings and fail if any are found. | |||
|
|
|||
| ### Pre-commit Hook | |||
|
|
|||
| You can run tests against "staged" files before each Git commit by integrating the test script in pre-commit hook. | |||
There was a problem hiding this comment.
We just merged a very similar PR for Prettier commit hook. Should we unify those sections? We can leave non-hook descriptions in both and link to a section where both hooks are described with a common setup step. Can be called "Useful Hooks".
There was a problem hiding this comment.
Is it really needed to add docs about prettier in CRA? since there's no special step to do it in a CRA based project.
people can read through prettier docs then do exactly what the docs say, it'll just work. and IMO by merging #2006 will make CRA docs bloated day by day.
on the other hand, i think we should add docs & explain something which are specific/special in CRA based project like how to run test, storybook, coverage reporting, linting, etc. yeah basically just like what we did so far in our docs except for #2006.
what do you think? but if you think that it doesnt matter, i'll go on and do what you suggested here 😊
There was a problem hiding this comment.
We already added docs about Prettier (#2006 is merged). I'm referring to consolidating those two sections and removing duplication between them.
There was a problem hiding this comment.
okay, any suggestion on where to put the "Useful Hooks"?
There was a problem hiding this comment.
Put it somewhere you like, I'll take a look and think about it
This will make integration `prettier` easier for CRA users
|
@gaearon any suggestions? |
|
This pull request has been automatically marked as stale because it has not had any recent activity. It will be closed in 7 days if no further activity occurs. |
|
This pull request has been automatically closed because it has not had any recent activity. The conversation will be locked in 7 days unless the pull request is reopened. Thank you for your contribution. |
Since Jest added a flag called
--findRelatedTests,some users asked about how to do this in CRA.
I've helped to answer them but I think it's a good time to document this now in
Running Testssection. So then we can guide them to the docs.close #2587 #2336