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

Add ESLint GitHub Action for automated PR review comments #943

Merged
merged 3 commits into from May 4, 2020

Conversation

bomanimc
Copy link
Member

The goal of this PR is to include a new GitHub Action that will run ESLint on PRs to this repo and comment with lint errors. This will help us avoid adding new lint errors into the codebase as we start forwarding on the path of getting these fixed.

This approach uses the reviewdog ESLint action.

Here's an example of what the comments look like:
action

@bomanimc bomanimc changed the title Add config file for eslint reviewdog action Add ESLint GitHub Action for automated PR review comments Apr 27, 2020
src/index.js Outdated
@@ -34,7 +34,7 @@ import universalSentenceEncoder from './UniversalSentenceEncoder';
import p5Utils from './utils/p5Utils';
import communityStatement from './utils/community';

const withPreload = {
let withPreload = {

Choose a reason for hiding this comment

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

[eslint] reported by reviewdog 🐶
'withPreload' is never reassigned. Use 'const' instead. prefer-const

Copy link
Member Author

Choose a reason for hiding this comment

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

Nice! It's working! I'll be removing this change from the PR.

Copy link
Contributor

@joeyklee joeyklee left a comment

Choose a reason for hiding this comment

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

@bomanimc - Very cool. Hopefully this will encourage more consistent code styles for PRs :)

Thank you!

@joeyklee
Copy link
Contributor

joeyklee commented May 4, 2020

Merging now!

@joeyklee joeyklee merged commit ca6fa1d into development May 4, 2020
@bomanimc bomanimc deleted the bomani.eslint-reviews branch May 24, 2020 16:00
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.

None yet

2 participants