wikimedia/mediawiki-extensions-Popups
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups synced 2024-11-16 20:18:00 +00:00
Code Issues Packages Projects Releases Wiki Activity
mediawiki-extensions-Popups/docs/adr/0005-frontend-sources-directory-structure.md
Stephen Niedzielski 8ba5c0f773 Hygiene: make JSDoc configs consistent 
Make the Popups, MobileFrontend, and MinervaNeue JSDocs consistent. For
Popups, specify package.json, readme, and default template options and
moved doc/ to docs/ and autogenerated JavaScript documentation from
doc/autogenerated to docs/js.

http://usejsdoc.org/about-configuring-jsdoc.html
http://usejsdoc.org/about-commandline.html
http://usejsdoc.org/about-configuring-default-template.html

Bug: T188261
Change-Id: I81e64f06265f1ecc4e2ee159deef9b204ea7e957
2018-07-23 14:45:14 -05:00

1.5 KiB
Raw Blame History

1. Frontend sources directory structure

Date: 14/02/2017

Status

Accepted

Context

With the addition of a frontend bundler, there are now assets that are the source, and assets that are for distribution.

Before, all assets were distribution ones stored in resources/, just a configurable convention used by the Reading Web team for using MediaWiki's ResourceLoader.

In order to facilitate the CI checks and understanding where sources are and where compiled sources are, we need to chose two distinct paths for storing sources and distribution files.

Decision

After some discussion, because of ease of understanding to the wider development community and the good mapping between the name and what they contain, we chose to:

  • Put unbundled frontend sources in src/.
  • Put bundled distribution files in dist/ under resources/ in resources/dist/.
  • Files directly distributed by ResourceLoader remain under resources/* to follow Reading Web Team's conventions around assets used by ResourceLoader.

Consequences

  • Frontend sources will be under src/.
  • After npm start or npm run build the bundled sources will be under resources/dist.
  • Jenkins will check in continuous integration that the sources under src/ are actually compiled when commited under resources/dist.
  • If the src path where to become inconvenient because we wanted to add other types of sources in it, we'll move the frontend assets to src/js or something more specific.