Skip to content

Commit 8c51aea

Browse files
authored
docs: update angular eslint instructions (#72)
1 parent cd5772e commit 8c51aea

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

coding-standards/angular.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,19 +69,16 @@ Navigate to the root directory of your project and execute the following npm com
6969
npm init @eslint/config
7070
```
7171
Choose the following options:
72-
- Usage: To check syntax, find problems, and enforce code style
72+
- Usage: To check syntax and find problems
7373
- Modules: JavaScript (import/export)
7474
- Frameworks: None of these
7575
- Typescript: No (Airbnb does not have support for TS, it is defined for JS and we will add additional TS support for it later)
7676
- Environment: Browser
77-
- Style: Use a popular style guide
78-
- Style guide: Airbnb
79-
- Format: JSON
8077

8178
Now select the option to install required dependencies. Click on Yes.
8279
Select the appropiate package manager that is used by you.
8380

84-
Refer to this [screenshot](https://imgur.com/a/pIbb1Wb) for the options to choose and expected outcome
81+
Refer to this [screenshot](https://imgur.com/a/aO2ozaV) for the options to choose and expected outcome
8582

8683
2. **Install dependencies to support typescript**
8784

@@ -546,7 +543,7 @@ To ensure proper setup, add the following configuration files to your project's
546543
```
547544
548545
4. **`package.json`**
549-
Update `package.json`. Add the following line under "scripts" to enable Prettier formatting:
546+
Update `package.json`. Add the following lines under "scripts" to detects any warnings and enable Prettier formatting:
550547
551548
```json
552549
// package.json
@@ -555,11 +552,13 @@ To ensure proper setup, add the following configuration files to your project's
555552
"scripts": {
556553
// Other Commands
557554
// Add the following line under "scripts"
555+
"lint": "ng lint --max-warnings 0",
558556
"prettier-format": "prettier --ignore-path .gitignore --write \"**/*.+(js|ts|json)\""
559557
}
560558
// ...
561559
}
562560
```
561+
563562
1. **`settings.json`**
564563
In your project's root directory, locate the .vscode folder. Create one if it doesn't exist. Once inside the folder, you can either create or modify the settings.json file. Populate this file with the following content:
565564

0 commit comments

Comments
 (0)