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

feat: [week-7] add 'Linters, Formatters, and Husky' module to Stage 1 #1300

Merged
merged 7 commits into from
Nov 19, 2023
32 changes: 32 additions & 0 deletions stage1/modules/linters-formatters-husky/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# [Stage#1.](../../) Linters, Formatters, and Husky

## Objectives:
valerydluski marked this conversation as resolved.
Show resolved Hide resolved

- Get to know:
- Linters
- Formatters
- Husky
- Explore reasons to use these tools
- Get to know how to install and configure these tools


## Duration:
Approximately 1,5 hour.
valerydluski marked this conversation as resolved.
Show resolved Hide resolved

## Theory:
1. Watch [the video about linters](https://www.youtube.com/watch?v=HDQXWr5TOnI) (7 min)
2. Read [the article about linters](https://www.testim.io/blog/what-is-a-linter-heres-a-definition-and-quick-start-guide/) (optional, ~ 7 min)
2. Read [the article about Prettier](https://javascript.plainenglish.io/prettier-the-formatting-big-brother-of-eslint-2becf33168f9) (~ 5 min)
2. Watch [the video-tutorial how to work with ESLint and Prettier in VSCode](https://www.youtube.com/watch?v=St1YSNoB36Y) (~ 5 min)
3. Read [docs about ESLint rules](https://eslint.org/docs/latest/use/configure/rules) (~7 min)
3. Read [the article about husky](https://blog.bitsrc.io/ensure-javascript-code-quality-with-husky-and-hooks-6e338222662) (~ 5 min)
4. Watch [the video-tutorial about husky setting up](https://www.youtube.com/watch?v=-qHA6zbOdLc) (~ 4 min)

## Practice
1. Students should take the "Linters, Formatters, and Husky" test in RS APP > Auto Test.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
1. Students should take the "Linters, Formatters, and Husky" test in RS APP > Auto Test.
1. Students should take the "[St1] Linters, Formatters, and Husky" test in RS APP > Auto Test.


## Additional materials:
1. [Prettier documentation](https://prettier.io/)
2. [ESLint configuration (docs)](https://eslint.org/docs/latest/use/configure/)
3. [Popular style guides](https://blog.codacy.com/4-popular-javascript-style-guides)
2. [Comparison of popular linters for JavaScript](https://www.sitepoint.com/comparison-javascript-linting-tools/) (optional)
valerydluski marked this conversation as resolved.
Show resolved Hide resolved