Update JS testing with ESLint #32
Conversation
| An impeccable style guide, however, does not prevent human error. Every coder has at least one horror story about an hours-long hunt for a missing semicolon that caused the (sometimes silent) crash of an entire program. At DataMade, we recommend [ESLint](https://eslint.org/) as a way to enforce a coherent JS syntax and automate the hunt for typos. | ||
|
|
||
| ## jshint | ||
| We integrate `ESLint` into our workflow as a step in continuous integration—typically, when any commit is pushed to a feature branch. This means that we catch syntax errors early, but are not stymied during local development as we introduce new code and troubleshoot. For an example of what this looks like, see the Gatsby app cookiecutter template. Notable files: |
There was a problem hiding this comment.
I don't think I've ever set up ESLint in a Django project. Which is not great! Have you, @hancush? It would be good to link to a Django setup here as well.
There was a problem hiding this comment.
I have not! Sounds like a good addition to our Django project template. Opened datamade/how-to#115.
hancush
left a comment
hancush
left a comment
There was a problem hiding this comment.
Although it was never fully adopted, I liked that our fork of the Node style guide included discussion of why we preferred certain syntax. https://github.com/datamade/node-style-guide
Is there a similar document or discussion of the ESLint rules we're applying? It's not something I require to bring in these changes, but it would be good to include, if it exists!
| An impeccable style guide, however, does not prevent human error. Every coder has at least one horror story about an hours-long hunt for a missing semicolon that caused the (sometimes silent) crash of an entire program. At DataMade, we recommend [ESLint](https://eslint.org/) as a way to enforce a coherent JS syntax and automate the hunt for typos. | ||
|
|
||
| ## jshint | ||
| We integrate `ESLint` into our workflow as a step in continuous integration—typically, when any commit is pushed to a feature branch. This means that we catch syntax errors early, but are not stymied during local development as we introduce new code and troubleshoot. For an example of what this looks like, see the Gatsby app cookiecutter template. Notable files: |
There was a problem hiding this comment.
I have not! Sounds like a good addition to our Django project template. Opened datamade/how-to#115.
| An impeccable style guide, however, does not prevent human error. Every coder has at least one horror story about an hours-long hunt for a missing semicolon that caused the (sometimes silent) crash of an entire program. At DataMade, we recommend [ESLint](https://eslint.org/) as a way to enforce a coherent JS syntax and automate the hunt for typos. | ||
|
|
||
| ## jshint | ||
| We integrate `ESLint` into our workflow as a step in continuous integration—typically, when any commit is pushed to a feature branch. This means that we catch syntax errors early, but are not stymied during local development as we introduce new code and troubleshoot. For an example of what this looks like, see the Gatsby app cookiecutter template. Notable files: |
There was a problem hiding this comment.
How about a link to the template here?
| An impeccable style guide, however, does not prevent human error. Every coder has at least one horror story about an hours-long hunt for a missing semicolon that caused the (sometimes silent) crash of an entire program. | ||
| - `package.json`: This setup requires installation of the package `eslint-config-react-app`. This is also where you can define the `yarn test` command used in `test.yml` | ||
| - `.eslintrc.js`: This file defines the syntax rules ESLint will follow. It's based on the `react-app` defaults, with minor modifications. | ||
| - `.github/workflows/test.yml`: This Âworkflow instructs Github to run the ESLint tests on every push. |
There was a problem hiding this comment.
| - `.github/workflows/test.yml`: This Âworkflow instructs Github to run the ESLint tests on every push. | |
| - `.github/workflows/test.yml`: This workflow instructs Github to run the ESLint tests on every push. |
|
|
||
| An impeccable style guide, however, does not prevent human error. Every coder has at least one horror story about an hours-long hunt for a missing semicolon that caused the (sometimes silent) crash of an entire program. | ||
| - `package.json`: This setup requires installation of the package `eslint-config-react-app`. This is also where you can define the `yarn test` command used in `test.yml` | ||
| - `.eslintrc.js`: This file defines the syntax rules ESLint will follow. It's based on the `react-app` defaults, with minor modifications. |
There was a problem hiding this comment.
If this differs from our style guide here https://github.com/datamade/node-style-guide, we ought to deprecate it, as well. (Never really got team buy in, so I think we can either delete or archive our fork.)
|
P.s., this looks awesome, @beamalsky! Thank you for helping to keep this documentation inline with our R&D. ❤️ Let me know if there's anything I can do to pitch in. |
2 participants
This updates our JS linter instructions to match the new Gatsby template currently in progress here: datamade/how-to#85
This PR needs updated links to the
how-torepo before it can be merged.