Skip to content
This repository has been archived by the owner on Dec 26, 2022. It is now read-only.

Ajout de fichiers pour gérer des dépendances de développement #51

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,19 @@ jobs:
steps:
- uses: actions/checkout@v2

- name: Use Node.js
uses: actions/setup-node@v1
with:
node-version: "14.x"

- name: Install dependencies
run: npm ci

- name: Lint the web extension
run: npx web-ext lint

Comment on lines 21 to 23
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
- name: Lint the web extension
run: npx web-ext lint

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Petit comportement intéressant de npx: il utilise le package local au projet s'il est présent :-)
donc ça utilise bien la version installée dans le projet.

(j'ai appris ça lorsque j'ai fait cette PR, je trouve que yarn est beaucoup plus logique pour ça finalement...)

Copy link
Owner

Choose a reason for hiding this comment

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

Oui je me suis déjà fait avoir sur d'autres projets par ce comportement (pas très intuitif je trouve).

- name: Check CS
run: npx prettier --check .
- name: Check code style
run: npm run lint

- name: Build the extension
run: npm run build
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
/web-ext-artifacts
/node_modules
46 changes: 46 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contribuer à vaccin.click

Merci de regarder comment contribuer à vaccin.click !

Cette extension utilise node pour installer des dépendances utilisées pour le
développement. Ce fichier explique comment les installer et les utiliser.

## Installation de node

L'installation de node dépend de votre système. Vous pouvez l'installer
globalement sur votre système avec [les paquets disponibles sur leur
site](https://nodejs.org/fr/), ou bien, si vous voulez une gestion plus fine,
vous pouvez aussi utiliser un script comme [nvm](https://github.com/nvm-sh/nvm#about).

## Installation des dépendances

Lorsque `node` est installé, vous pouvez cloner le projet et installer les
dépendances:

```
git clone [email protected]:dunglas/vaccin.click.git
cd vaccin.click
npm i
```

## Scripts disponibles

Les scripts suivants sont disponibles:

- `npm run lint` va lancer prettier localement.
- `npm run lint-fix` également, tout en corrigeant les problèmes.
- `npm start` lance l'extension dans firefox, et la recharge à chaque
changement.\
On peut utiliser l'option `-f` pour spécifier la version de
Firefox à lancer: `nightly`, `beta`, `firefoxdeveloperedition`, `firefox`, ou
tout simplement un chemin complet:\
`npm start -- -f nightly`\
`npm start -- -f ~/firefox/firefox`\
La variable d'environnement `$WEB_EXT_FIREFOX` permet de configurer cela de
manière permanente.
- `npm run build` va builder localement l'extension.
- `npx web-ext lint` va linter l'extension.

## Trucs et astuces

(À compléter)
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ Retrouvez toutes les infos concernant l'extension sur [vaccin.click](https://vac

## Contribuer à l'extension

Voir [le guide publié par Mozilla](https://extensionworkshop.com/documentation/develop/).
Merci ! Tout est décrit dans le fichier `CONTRIBUTING.md`.

Voir aussi [le guide publié par Mozilla](https://extensionworkshop.com/documentation/develop/).

## Crédits

Expand Down
Loading