Skip to content

Commit 4d3f066

Browse files
Merge branch 'cyrilchapon-master'
2 parents dc45805 + f70207a commit 4d3f066

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

content/first-steps.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,3 +114,21 @@ $ npm run start:dev
114114
```
115115

116116
This command will watch your files, automatically recompiling and reloading the server.
117+
118+
#### Linting and formatting
119+
120+
[CLI](/cli/overview) provides best effort to scaffold a reliable development workflow at scale. Thus, a generated Nest project comes with both a code **linter** and **formatter** preinstalled (respectively [eslint](https://eslint.org/) and [prettier](https://prettier.io/)).
121+
122+
> info **Hint** Not sure about the role of formatters VS linters ? Learn the difference [here](https://prettier.io/docs/en/comparison.html).
123+
124+
To ensure maximum stability and extensibility, we use the base [`eslint`](https://www.npmjs.com/package/eslint) and [`prettier`](https://www.npmjs.com/package/prettier) cli packages. This setup allows neat IDE integration with official extensions by design.
125+
126+
For headless environments where an IDE is not relevant (Continuous Integration, Git hooks, etc.) a Nest project comes with ready-to-use `npm` scripts.
127+
128+
```bash
129+
# Lint and autofix with eslint
130+
$ npm run lint
131+
132+
# Format with prettier
133+
$ npm run format
134+
```

0 commit comments

Comments
 (0)