Skip to content

Commit 94cfbc2

Browse files
Add better command in documentation
1 parent 8352cb7 commit 94cfbc2

7 files changed

Lines changed: 50 additions & 28 deletions

File tree

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ git clone git@github.com:EmmanuelLefevre/AngularTemplate.git
164164
cd AngularTemplate
165165
corepack enable
166166
pnpm install --frozen-lockfile
167-
pnpm start
167+
pnpm start/ng serve
168168
```
169169

170170
- Via Package
@@ -178,3 +178,25 @@ pnpm start
178178
```bash
179179
pnpm add -g @angular/cli@21.2.1
180180
```
181+
182+
### Installer une librairie
183+
184+
- En DEV
185+
186+
```bash
187+
pnpm add -DE <MA_LIBRAIRIE>@latest
188+
```
189+
190+
- En PROD
191+
192+
```bash
193+
pnpm add <MA_LIBRAIRIE>@latest
194+
```
195+
196+
Supprimer le `node_modules`, le `pnpm-lock.yaml` et clean le cache de **PNPM** =>
197+
198+
````bash
199+
pnpm store prune
200+
```
201+
202+
Push 🤜🤜🤜

docs/CICD.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ Si **Gitleaks** trouve une faille, le job **Security** échoue immédiatement, b
182182
L'utilisation de **rimraf** permet de supprimer des dossiers de manière fiable que l'on soit sous **Windows**, **macOS** ou **Linux**. C'est essentiel pour éviter que d'anciens rapports de couverture ne viennent fausser les nouvelles analyses.
183183

184184
```shell
185-
pnpm add -D rimraf
185+
pnpm add -DE rimraf@latest
186186
```
187187

188188
Dans `package.json` ajouter les scripts `clean` et `test:coverage`

docs/DOCUMENTATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Dans ce projet, nous avons poussé l'intégration plus loin pour permettre une d
4545
**Etape 1 :** Installer **Compodoc**
4646

4747
```shell
48-
pnpm add -D @compodoc/compodoc
48+
pnpm add -DE @compodoc/compodoc@latest
4949
```
5050

5151
**Etape 2 :**

docs/MULTI-LANGUES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Pour offrir une expérience utilisateur de premier plan, l'internationalisation
2626
Installer les librairies suivantes =>
2727

2828
```shell
29-
pnpm add @ngx-translate/core @ngx-translate/http-loader
29+
pnpm add @ngx-translate/core@latest @ngx-translate/http-loader@latest
3030
```
3131

3232
> [🔗 Ngx Translate Documentation](https://ngx-translate.org/)

docs/QUALITE.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -80,25 +80,25 @@ ng add @angular-eslint/schematics --package-manager=pnpm
8080
1. Installer la config de compatibilité
8181

8282
```shell
83-
pnpm add -D eslint-config-prettier
83+
pnpm add -DE eslint-config-prettier@latest
8484
```
8585

8686
2. Installer **ESLint** et **Angular ESLint**
8787

8888
```shell
89-
pnpm add -D eslint angular-eslint
89+
pnpm add -DE eslint angular-eslint@latest
9090
```
9191

9292
3. Installer les `stylistics`
9393

9494
```shell
95-
pnpm add -D @stylistic/eslint-plugin
95+
pnpm add -DE @stylistic/eslint-plugin@latest
9696
```
9797

9898
4. Installer le plugin `security`
9999

100100
```shell
101-
pnpm add -D eslint-plugin-security
101+
pnpm add -DE eslint-plugin-security@latest
102102
```
103103

104104
Créer un fichier `eslint-security.config.js` et y coller la configuration présente dans le template.
@@ -192,7 +192,7 @@ Vous devriez voir s'afficher =>
192192
**Etape 7 :** Ajouter les autres packages **ESLint**
193193

194194
```shell
195-
pnpm add -D @angular-eslint/builder @eslint/js typescript-eslint
195+
pnpm add -DE @angular-eslint/builder@latest @eslint/js@latest typescript-eslint@latest
196196
```
197197

198198
<h2 id="prettier">
@@ -224,7 +224,7 @@ Cela garantit que tous les fichiers commits respectent les normes de formatage d
224224
Bien qu'il y ait une configuration dans `package.json`, il est préférable (Best Practice) d'avoir un fichier de configuration dédié `.prettierrc`.
225225

226226
```shell
227-
pnpm add -D prettier
227+
pnpm add -DE prettier@latest
228228
```
229229

230230
**Etape 2 :** Créer un fichier `.prettierrc.js` à la racine et y coller la configuration présente dans le template.
@@ -235,7 +235,7 @@ pnpm add -D prettier
235235
Installer l'extension **Trivago** pour le tri des imports.
236236

237237
```shell
238-
pnpm add -D @trivago/prettier-plugin-sort-imports
238+
pnpm add -DE @trivago/prettier-plugin-sort-imports@latest
239239
```
240240

241241
Formater le code :
@@ -287,7 +287,7 @@ Grâce à un ensemble de règles configurables via un fichier `.htmlhintrc`, **H
287287
**Etape 1 :** Ajouter le package **HTMLLint**
288288

289289
```shell
290-
pnpm add -D htmlhint
290+
pnpm add -DE htmlhint@latest
291291
```
292292

293293
**Etape 2 :** Ajouter l'extension **VSCode** :
@@ -363,7 +363,7 @@ Concrètement, **Stylelint** analyse vos fichiers de style et nous signale tout
363363
### Configuration :
364364

365365
```shell
366-
pnpm add -D stylelint stylelint-scss postcss-scss
366+
pnpm add -DE stylelint@latest stylelint-scss@latest postcss-scss@latest
367367
```
368368

369369
Il faut ensuite créer le fichier `.stylelintrc.json` à la racine et y coller la configuration présente dans le template.
@@ -413,7 +413,7 @@ ainsi que le script =>
413413
**Etape 1 :** Installer **Ngx Translate Lint**
414414

415415
```shell
416-
pnpm add -D ngx-translate-lint
416+
pnpm add -DE ngx-translate-lint@latest
417417
```
418418

419419
**Etape 2 :** Configurer le script dans `package.json` pour la **CI**
@@ -462,7 +462,7 @@ pnpm i18n:lint
462462
**Etape 1 :** Installer **Ngx Translate Extract**
463463

464464
```shell
465-
pnpm add -D @bartholomej/ngx-translate-extract
465+
pnpm add -DE @bartholomej/ngx-translate-extract@latest
466466
```
467467

468468
**Etape 2 :** Configurer le script dans `package.json`
@@ -534,7 +534,7 @@ C'est là que `lint-staged` entre en jeu. C'est un outil intelligent qui exécut
534534
**Etape 1 :** Installer **Husky** et `lint-staged`
535535

536536
```shell
537-
pnpm add -D husky lint-staged
537+
pnpm add -DE husky lint-staged@latest
538538
```
539539

540540
**Etape 2 :** Initialiser **Husky**
@@ -626,7 +626,7 @@ Une fois qu'un secret est "poussé" sur un dépôt (même privé), il est consid
626626
Il évite la pollution de l'historique **Git**. Une fois qu'un secret est commité, il est techniquement compromis et difficile à effacer totalement. **Secretlint** bloque le processus dès la détection, forçant le développeur à placer ses secrets dans des variables d'environnement (`.env`) ou des gestionnaires de secrets sécurisés (comme les **GitHub Secrets** ou **HashiCorp Vault**) garantissant ainsi que le code partagé reste sain.
627627

628628
```shell
629-
pnpm add -D secretlint @secretlint/secretlint-rule-preset-recommend
629+
pnpm add -DE secretlint@latest @secretlint/secretlint-rule-preset-recommend@latest
630630
```
631631

632632
De plus il est nécessaire d'ajouter dans le fichier `package.json` l'exécution de **Secretlint** sur les fichiers en `pre-commit` via `lint-staged`.

docs/STYLES.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ En **SCSS** avec **BEM**, évitez d'imbriquer plus de 1 niveau de profondeur (le
189189
**Angular Material** est la bibliothèque de composants officielle basée sur les principes du **Material Design**. Elle offre une collection de composants UI testés, accessibles et performants.
190190

191191
```shell
192-
pnpm add @angular/material @angular/cdk
192+
pnpm add @angular/material@latest @angular/cdk@latest
193193
```
194194

195195
⚠️ Les surcharges de **Angular Material** (`_material-overrides.scss`) sont globales et doivent être importées une seule fois dans le fichier `styles.scss` principal dans `src/styles` et non dans chaque composant.
@@ -212,11 +212,11 @@ Pour l'iconographie, **Font Awesome** est le standard de l'industrie. Plutôt qu
212212
- **Modularité :** possibilité d'importer uniquement les packs nécessaires (Solid, Regular, Brands).
213213

214214
```shell
215-
pnpm add @fortawesome/fontawesome-svg-core @fortawesome/angular-fontawesome
215+
pnpm add @fortawesome/fontawesome-svg-core@latest @fortawesome/angular-fontawesome@latest
216216
```
217217

218218
Puis ajouter les différentes variantes d'icônes...
219219

220220
```shell
221-
pnpm add @fortawesome/free-solid-svg-icons @fortawesome/free-brands-svg-icons @fortawesome/free-regular-svg-icons
221+
pnpm add @fortawesome/free-solid-svg-icons@latest @fortawesome/free-brands-svg-icons@latest @fortawesome/free-regular-svg-icons@latest
222222
```

docs/TESTS.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ Activer le nouveau système de tests unitaires natif d'**Angular**. Ce builder m
1818
**Etape 1 :** Installer les librairies requises
1919

2020
```shell
21-
pnpm add -D vitest jsdom
22-
pnpm add -D @angular/platform-browser-dynamic
23-
pnpm add -D @analogjs/vite-plugin-angular
24-
pnpm add -D @analogjs/vitest-angular
25-
pnpm add -D @types/node
26-
pnpm add -D vite-tsconfig-paths
21+
pnpm add -DE vitest jsdom@latest
22+
pnpm add -DE @angular/platform-browser-dynamic@latest
23+
pnpm add -DE @analogjs/vite-plugin-angular@latest
24+
pnpm add -DE @analogjs/vitest-angular@latest
25+
pnpm add -DE @types/node@latest
26+
pnpm add -DE vite-tsconfig-paths@latest
2727
```
2828

2929
**Etape 2 :** Dans `tsconfig.spec.json` remplacer la configuration présente par celle-ci dans la propriété `@compilerOptions`.
@@ -60,15 +60,15 @@ pnpm add -D vite-tsconfig-paths
6060
**Vitest** possède une interface web agréable pour visualiser les tests, voir le code et les logs. C'est bien plus pratique que le terminal.
6161

6262
```shell
63-
pnpm add -D @vitest/ui
63+
pnpm add -DE @vitest/ui@latest
6464
```
6565

6666
![Vitest UI](https://github.com/EmmanuelLefevre/MarkdownImg/blob/main/vitest_ui.png.png)
6767

6868
**Etape 5 :** Installer le package de coverage `@vitest/coverage-v8`
6969

7070
```shell
71-
pnpm add -D @vitest/coverage-v8
71+
pnpm add -DE @vitest/coverage-v8@latest
7272
```
7373

7474
**Etape 6 :** Créer le fichier `test-setup.ts` dans `src`

0 commit comments

Comments
 (0)