949547 - [repoman] Put commonplace modules in their own directory

Status: RESOLVED FIXED

(Marketplace Graveyard :: Code Quality, defect, P3)

Description

[Matt Basta [:basta]]

media/js/lib/ and media/js/views/ should stay where they are.

Any JS file that comes pre-installed with commonplace (excluding any .dist files) should put itself into its own subdirectory:

requests.js
cache.js
storage.js

into

common/requests.js
common/cache.js
common/storage.js

Instead of dumping all this into the require config (which would be a disaster since main.js isn't updated on commonplace update), a small script should be written at the end of require.js that lists each commonplace module and adds the correct mapping when require.config is called. This will also clean up existing commonplace require.config calls.

Also make sure docs are written:
- Notes in the AMD documentation about the further customization of require.js and
- how commonplace modules are loaded.

`commonplace update` should be updated with a simple upgrade "migration":
- If the media/js/common/ directory exists, skip the migration.
- If it doesn't exist, mkdir it and iterate over each file that would otherwise be in it and copy it in.
- For each of the files copied, check if the file exists in media/js/. If it does, remove it.

Comment 1

[Kevin Ngo [:ngoke]]

https://github.com/mozilla/fireplace/commit/c81865a3ce5e0caa08b62ab49ce6b5a1d2e5ad3d
https://github.com/mozilla/commonplace/pull/34