mozilla / commonplace

Node modules for Firefox Marketplace frontend projects

Commonplace

Necessary Node modules for Marketplace frontend projects.

• Marketplace frontend documentation
• Marketplace documentation

Commonplace includes:

• Common Bower and require.js configuration
• Nunjucks template compilation optimizer
• Localization extraction and language pack generation

Creating a New Marketplace Frontend Project

Clone the Marketplace template.

Run make init. This will download dependencies and set things up.

commonplace's Issues

Move src/media/js files into new contrib directory

This would allow commonplace projects to easily define custom behavior on a per-project basis without breaking the upgrade path or using confusing _local hacks...an issue separately being faced by both fireplace and yogafire right now.

Does not run on Windows

When I run damper on Windows, most of the content (i.e. images and text) do not get served.

`commonplace update` should ignore hello_world.js

Add prefix for URL routes

If you're in commbadge all URL routes prefixed with /comm/ we should assume correspond to views in commbadge.

We should consider adding a url_prefix to the settings.js file that if set allows us to determine which URLs to hijack (so we then know which URLs are outbound ones).

See bug 907868.

Marketplace docker setup failing due to incorrect relative path

I'm not sure whether this is the right place to report the issue, there are lots of different repositories involved. Feel free to point me in the right direction if I need to file this elsewhere.

I'm installing Marketplace via Docker as outlined in the docs. Calling docker-compose up fails with the following error message:

fireplace_1     | [13:08:59] Starting 'js_build'...
fireplace_1     | [13:08:59] Finished 'js_build' after 211 ms
fireplace_1     | { [Error: Error: ENOENT, no such file or directory '/srv/fireplace/src/bower_components/marketplace-core-modules/core/init.js'
fireplace_1     | In module tree:
fireplace_1     |     main
fireplace_1     |       init
fireplace_1     | 
fireplace_1     |     at Object.fs.openSync (fs.js:427:18)
fireplace_1     | ]
fireplace_1     |   originalError: 
fireplace_1     |    { [Error: ENOENT, no such file or directory '/srv/fireplace/src/bower_components/marketplace-core-modules/core/init.js']
fireplace_1     |      errno: 34,
fireplace_1     |      code: 'ENOENT',
fireplace_1     |      path: '/srv/fireplace/src/bower_components/marketplace-core-modules/core/init.js',
fireplace_1     |      syscall: 'open',
fireplace_1     |      fileName: '/srv/fireplace/src/bower_components/marketplace-core-modules/core/init.js',
fireplace_1     |      moduleTree: [ 'init', 'main' ] } }
mkt_fireplace_1 exited with code 1

After some investigation, the issue is being caused by this line (never mind the error message showing up after "Finished 'js_build'" message, that's mozilla/marketplace-gulp#28). Note that the default paths are being overwritten by the buildPaths member defined here. The path for the core module is a relative one and resolves into /srv/fireplace/src/bower_components/marketplace-core-modules/core, correct path would have been /srv/fireplace/bower_components/marketplace-core-modules/core however (without src).

I'm not sure which one is the guilty party here but using process.env.BOWER_PATH (which is available) would have been one way to avoid the whole issue.

`commonplace fiddle` should accept branches (refs?)

It might be helpful to have a commonplace fiddle feature allowing a repository's branch to be checked out and deployed.

The package.json config might look like this:

"commonplaceDependencies": {
    "git://github.com/mozilla/fireplace.git": {
        "symlinks": {"hearth/media": "media/fireplace"},
        "name": "fireplace",
        "branch": "feed"
    }
}

Along the same lines, it may be useful to allow specification of a ref (commit hash or tag name):

"commonplaceDependencies": {
    "git://github.com/mozilla/fireplace.git": {
        "symlinks": {"hearth/media": "media/fireplace"},
        "name": "fireplace",
        "ref": "f9c70cb39d882ad1ce57939eed99c7f7130484af"
    },
    "git://github.com/mozilla/rocketfuel.git": {
        "symlinks": {"src/media": "media/rocketfuel"},
        "name": "rocketfuel",
        "ref": "2014.01.07"
    }
}

Preserve hashes in navigation

http://localhost:5000/game/mario-bros#game-media should load http://localhost:5000/game/mario-bros#game-media not http://localhost:5000/game/mario-bros

Originally cvan/galaxy#18

`commonplace update` should create .js files for .js.dist files when they don't exist.