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

(docs): add Jest and ESLint subsections to Customization #697

Merged

Conversation

agilgur5
Copy link
Collaborator

@agilgur5 agilgur5 commented Apr 26, 2020

  • while the docs do say these are run fairly directly, recently folks
    seem to be particularly confused about how to configure Jest

    • so explicitly mention jest.config.js and .eslintrc.js to make
      that a bit more clear
      • don't mention package.json options as I think that should be
        implicitly implied enough now
        • and because ESLint config works a bit differently in the two
          cases (see existing issue)
    • and more explicitly say that all tsdx test flags are forwarded to
      Jest
  • also add links to "its own config" for each of the Babel, Jest, and
    ESLint subsections so people can look at the source quickly if they
    want

    • the Babel one is a bit harder to read though
  • and specify the merge behavior for each, i.e. shallow or deep

    • and the ordering when it comes to Babel, as order matters there

To help with issues like #695 and #692 (comment) as I guess it's not clear enough that you can do this already
Also specifies merge behavior of Babel since #543 is a thing

- while the docs do say these are run fairly directly, recently folks
  seem to be particularly confused about how to configure Jest
  - so explicitly mention `jest.config.js` and `.eslintrc.js` to make
    that a bit more clear
    - don't mention `package.json` options as I think that should be
      implicitly implied enough now
      - and because ESLint config works a bit differently in the two
        cases (see existing issue)
  - and more explicitly say that all `tsdx test` flags are forwarded to
    Jest

- also add links to "its own config" for each of the Babel, Jest, and
  ESLint subsections so people can look at the source quickly if they
  want
  - the Babel one is a bit harder to read though

- and specify the merge behavior for each, i.e. shallow or deep
  - and the ordering when it comes to Babel, as order matters there
@agilgur5 agilgur5 force-pushed the docs-add-jest-config-etc-mention branch from 010a0c8 to c3a7e76 Compare April 26, 2020 19:25
Copy link
Collaborator Author

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@agilgur5 agilgur5 merged commit 4e4df28 into jaredpalmer:master Apr 26, 2020
@agilgur5 agilgur5 deleted the docs-add-jest-config-etc-mention branch April 26, 2020 19:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant