Skip to content

Commit

Permalink
add dependency notes to DEVELOPER.md (wikimedia-gadgets#1777)
Browse files Browse the repository at this point in the history
* add dependency notes to DEVELOPER.md

* add jest-environment-jsdom
  • Loading branch information
NovemLinguae committed Jun 6, 2023
1 parent cec581a commit 514d076
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,3 +133,14 @@ The `--base` flag operates as a *prefix*; note the presence of the trailing `/`.
[App::cpanminus]: https://metacpan.org/pod/App::cpanminus
[intadmin]: https://en.wikipedia.org/wiki/Wikipedia:Interface_administrators
[special_botpass]: https://en.wikipedia.org/wiki/Special:BotPasswords

### Dependencies

All the dependencies that Twinkle uses are JavaScript **dev** dependencies. They are not used at all on-wiki and are just used during development. Here's what they are and what they do. This may help with evaluating dependabot patches (dependabot is a GitHub bot that helps keep libraries up to date by submitting pull requests).

- eslint - Used by continuous integration for enforcing code linting rules.
- jest - Used by continuous integration for unit testing.
- jest-environment-jsdom - Needed for Jest to work.
- mock-mediawiki - Used by continuous integration for unit testing.
- mwn - Used when you run `npm start`. `npm start` is what enables localhost testing.
- Everything else - Dependabot will not usually try to update these unless one of the 5 above dependencies gets out of date. It is probably best to update the above dependencies instead.

0 comments on commit 514d076

Please sign in to comment.