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

Ensure linting errors trigger a non-zero exit code. #12572

Merged
merged 1 commit into from
Aug 23, 2024

Conversation

rtibbles
Copy link
Member

Summary

Fixes error from #9698 where the CLI calling the linting function was not properly reading the return code, so was always returning a falsy value even when there were linting errors, meaning that the exit code was always 0.

References

Root cause of the missed linting here: #12428

Reviewer guidance

Deliberately introduce a linting error.
Run yarn run lint-frontend.
Ensure that the exit code is 1.


Testing checklist

  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Critical and brittle code paths are covered by unit tests

PR process

  • PR has the correct target branch and milestone
  • PR has 'needs review' or 'work-in-progress' label
  • If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
  • If this is an important user-facing change, PR or related issue has a 'changelog' label
  • If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@rtibbles rtibbles added the DEV: tools Internal tooling for development label Aug 20, 2024
@nucleogenesis nucleogenesis self-assigned this Aug 22, 2024
Comment on lines -389 to -391
.then(formatted => {
return formatted.code;
})
Copy link
Member

Choose a reason for hiding this comment

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

Why was this then block causing the issue?

Copy link
Member Author

Choose a reason for hiding this comment

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

Because it was taking the resolved value of the promise which is no longer an object with a code attribute, but now just the code itself, and then trying to read a property from it.

Copy link
Member

@nucleogenesis nucleogenesis left a comment

Choose a reason for hiding this comment

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

Tested locally and works as expected

@rtibbles rtibbles merged commit 53e03ac into learningequality:release-v0.17.x Aug 23, 2024
40 checks passed
@rtibbles rtibbles deleted the lint_fix branch August 23, 2024 18:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DEV: tools Internal tooling for development
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants