-
Notifications
You must be signed in to change notification settings - Fork 4.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into feat/add_pr_template
- Loading branch information
Showing
2 changed files
with
42 additions
and
0 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# [Stage#1.](../../) Linters, Formatters, and Husky | ||
|
||
## Module Overview 📚 | ||
|
||
This module introduces students to essential development tools: Linters, Formatters, and Husky. It's designed to provide a comprehensive understanding of how these tools enhance code quality and consistency in web development projects. The module covers the basics and practical applications of these tools, including installation and configuration. | ||
|
||
## Learning Objectives 🎯 | ||
|
||
- Get to know: | ||
- Linters | ||
- Formatters | ||
- Husky | ||
- Explore reasons to use these tools | ||
- Get to know how to install and configure these tools | ||
|
||
## Approximate Module Completion Time ⏱️ | ||
|
||
- **1,5 hour** | ||
|
||
## 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) | ||
3. Read [the article about Prettier](https://javascript.plainenglish.io/prettier-the-formatting-big-brother-of-eslint-2becf33168f9) (~ 5 min) | ||
4. Read [the article about Prettier and ESLint duo](https://blog.logrocket.com/using-prettier-eslint-automate-formatting-fixing-javascript/) (8 min) | ||
5. Watch [the video-tutorial how to work with ESLint and Prettier in VSCode](https://www.youtube.com/watch?v=St1YSNoB36Y) (~ 5 min) | ||
6. Read [docs about ESLint rules](https://eslint.org/docs/latest/use/configure/rules) (~7 min) | ||
7. Read [the article about husky](https://blog.bitsrc.io/ensure-javascript-code-quality-with-husky-and-hooks-6e338222662) (~ 5 min) | ||
8. Watch [the video-tutorial about husky setting up](https://www.youtube.com/watch?v=-qHA6zbOdLc) (~ 4 min) | ||
|
||
## Practice 💻 | ||
|
||
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) | ||
4. [Comparison of popular linters for JavaScript](https://www.sitepoint.com/comparison-javascript-linting-tools/) (optional) | ||
5. [Why Prettier](https://prettier.io/docs/en/why-prettier.html) |