Explore, document and make a new issue to implement linters which can be installed locally

[SAUMILDHANKAR]

Overview

In this issue, we will explore and implement linters which can be installed locally so that developers can identify errors before making a PR

Action Items

• Explore linters (Example: Super-Linter) which can be used for HfLA website repo
• Demo a use case in your local environment during the team meeting
• Make sure the dev team can use the linter with VS code in their local environment
• Write further issues to create documentation or a wiki article
• Add instructions for other developers to follow
• For merge team: Release dependency on Create a wiki page for linters used by the HfLA website team #3230
  • Update action items in the dependency issue if needed.
  • If all dependencies in Create a wiki page for linters used by the HfLA website team #3230 have been resolved, remove the dependency label, move it to the new issue approval column and add a ready for milestone label.
• For merge team: Release dependency on Identify and fix inconsistent code indentation in a SCSS file #2695
  • Update action items in the dependency issue if needed.
  • If all dependencies in these issues have been resolved, remove the dependency label, move it to the new issue approval column and add a ready for milestone label.
    • GitHub Actions: Implement ESlint #1442
    • Identify and fix inconsistent code indentation in a SCSS file #2695

Resources/Instructions

• Helpful links: VS code with linter, VS code remote container
• Related documentation: Run linter locally
• Nice read Update Docker Compose Dev With New Features #1443

[bootcamp-brian]

ETA: 2 weeks (need to make a demo for team meeting and the next one isn't until the 14th)
Availability: Weekdays before 5pm

[ExperimentsInHonesty]

@bootcamp-brian I moved your issue to in progress.

[bootcamp-brian]

Provide Update

1. Progress: Did some research on linters and decided to test out ESLint. Went through set up in my local environment and confirmed it worked in VSCode. Did a write up of the set up process going step by step to prepare for presenting a demo.
2. Blockers: I don't know of a way to test if ESLint is compatible with a mac environment. I haven't seen anything saying that it isn't but also haven't come across any confirmation that it does.
3. Availability: Weekdays before 5pm of next week
4. ETA: By end of next week

[bootcamp-brian]

Provide Update

1. Progress: Put together a demo to present at the meeting last Tuesday, but it was suggested that I wait until more of the merge team was in attendance to present it. The plan is to demo it at this Sunday's meeting instead. Also found confirmation that ESLint is compatible with macs.
2. Blockers: None
3. Availability: Weekdays before 5pm next week
4. ETA: By end of next week

[bootcamp-brian]

Provide Update

1. Progress: Presented demo, wrote documentation and created issue. Sent merge team member a message asking what I should do next and am currently awaiting a reply.
2. Unsure of next steps to take (already reached out for assistance)
3. Availability: Weekdays before 5pm
4. ETA: Within the next week.

[jdingeman]

This issue will make way for more issues. Dev created the decision record here, also created new issue here:

• Add ESlint VS Code installation instructions #4264 for installing ESlint locally

Need new issues for:

• Roll out plan
  • What messages will need to be sent and where
    • Possible changes to GitHub actions and HackforLA bot to notify members of upcoming changes
• Update Contributing.md Add ESlint VS Code installation instructions #4264
• Create messaging for issues (Dev & prework), meetings, GHA messages on PRs

Dev has completed scope of work and we will close this issue. Thank you Brian!