Check for console.log() in CI #1156
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DEFRA/water-abstraction-team#94 During development, we constantly use `console.log()` to print out and check for expected results. Although they are useful during the development process, it is very common that we forget to remove them, leading to requested changes during pull requests 😪. Currently, we use checks within our CI to catch mistakes similar to this such as `.only()` on `describe` and `it` blocks within our unit tests. ```yaml # Before we do anything, check we haven't accidentally left any `describe.only()` or `it.only(` statements in the # tests # # Reworking of https://stackoverflow.com/a/21788642/6117745 - name: Temporary tag check run: | ! grep -R 'describe.only(\|it.only(' test ``` Aside from the accidental `console.log()` present, there is one instance we do not want the CI to flag. Within `app/server.js` there is a `console.log()` that is there to log unhandled exceptions. In this case we can change it to 'console.error()' to get around this. This PR is focused on implementing the checks for `console.log()` when pushing code and changing the `console.log()` within `app/server.js` to `console.error()`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DEFRA/water-abstraction-team#94
During development, we constantly use
console.log()to print out and check for expected results. Although they are useful during the development process, it is very common that we forget to remove them, leading to requested changes during pull requests 😪.Currently, we use checks within our CI to catch mistakes similar to this such as
.only()ondescribeanditblocks within our unit tests.Aside from the accidental
console.log()present, there is one instance we do not want the CI to flag. Withinapp/server.jsthere is aconsole.log()that is there to log unhandled exceptions. In this case we can change it to 'console.error()' to get around this.This PR is focused on implementing the checks for
console.log()when pushing code and changing theconsole.log()withinapp/server.jstoconsole.error().