Copy Pontoon-friendly L10n resources to SDK add-on friendly paths

- Move add-on locales to Pontoon-friendly paths

- Gulp task to copy Pontoon-friendly resources to add-on friendly paths

- Update add-on build in CircleCI to run the gulp task

- Update .gitignore

- Update docs

Fixes mozilla#557

.gitignore

@@ -6,6 +6,7 @@
 
 # Files to ignore in the base directory
 coverage
+.coverage
 debug-config.json
 .env
 MANIFEST
@@ -25,4 +26,5 @@ tmp/
 # Files to ignore within specific directories
 addon/*.rdf
 addon/*.xpi
+addon/locale/
 legal-copy/*html

addon/README.md

@@ -37,23 +37,29 @@ A relatively easy path for working on this addon involves the following steps:
 
 1. Install [Firefox Developer Edition][devedition].
 
-2. Install the [DevPrefs][devprefs] Add-on, which sets a number of preferences
+1. Install the [DevPrefs][devprefs] Add-on, which sets a number of preferences
    necessary for Add-on development, importantly `xpinstall.signatures.required`
    and `xpinstall.whitelist.required`.
 
-3. Install the [Extension Auto-Installer][autoinstaller] Add-on in Firefox
+1. Install the [Extension Auto-Installer][autoinstaller] Add-on in Firefox
    Developer Edition.
 
-4. Run `npm start` to fire up a watcher that will build the Test Pilot add-on
-   whenever files change and auto-update the installed version in Firefox.
+1. In the top-level directory, run `npm run addon:locales` to copy over
+   translated string resources into the add-on project. [If you have the frontend
+   web server running][quickstart], this should be automatically handled by gulp.
 
-5. Read all about [setting up an extension development
+1. In the `addon/` directory, run `npm start` to fire up a watcher that will
+   build the Test Pilot add-on whenever files change and auto-update the
+   installed version in Firefox.
+
+1. Read all about [setting up an extension development
    environment][extensiondev] on MDN.
 
 [devedition]: https://www.mozilla.org/en-US/firefox/developer/
 [devprefs]: https://addons.mozilla.org/en-US/firefox/addon/devprefs/
 [autoinstaller]: https://addons.mozilla.org/en-US/firefox/addon/autoinstaller/
 [extensiondev]: https://developer.mozilla.org/en-US/Add-ons/Setting_up_extension_development_environment
+[quickstart]: ../docs/development/quickstart.md
 
 For UI hacking you can run `npm run watch-ui` to easily debug `lib/templates.js` and `data/panel.css`
 

addon/tasks/locales.js

@@ -0,0 +1,15 @@
+const gulp = require('gulp');
+const rename = require('gulp-rename');
+
+gulp.task('addon-copy-locales', () =>
+  gulp.src('./locales/**/addon.properties')
+    .pipe(rename(path => {
+      // Transform {LOCALE}/addon.properties -> {LOCALE}.properties
+      path.basename = path.dirname;
+      path.dirname = '';
+    }))
+    .pipe(gulp.dest('./addon/locale'))
+);
+
+gulp.task('addon-watch-locales', () =>
+  gulp.watch('./locales/**/addon.properties', ['addon-copy-locales']));

bin/circleci/build-addon.sh

@@ -1,5 +1,6 @@
 #!/bin/bash
 set -ex
+npm run addon:locales
 cd addon/
 # only sign when on master branch or a tag
 if [[ $CIRCLE_PROJECT_USERNAME == 'mozilla' && ($CIRCLE_BRANCH == 'master' || $CIRCLE_TAG != '') ]]; then

gulpfile.js

@@ -18,13 +18,16 @@ require('./frontend/tasks/pages');
 require('./frontend/tasks/server');
 require('./frontend/tasks/dist');
 
+require('./addon/tasks/locales');
+
 gulp.task('clean', () => del([
   config.DEST_PATH,
   config.DIST_PATH,
   config.DJANGO_OLD_STATIC
 ]));
 
 gulp.task('build', [
+  'addon-copy-locales',
   'content-build',
   'scripts-build',
   'styles-build',
@@ -34,6 +37,7 @@ gulp.task('build', [
 ]);
 
 gulp.task('watch', [
+  'addon-watch-locales',
   'self-watch',
   'content-watch',
   'scripts-watch',

package.json

@@ -110,6 +110,7 @@
     "test": "cd frontend && mocha --require babel-register --require test-setup.js --recursive",
     "test:ci": "NODE_ENV=test nyc mocha --recursive --reporter mocha-junit-reporter --require frontend/test-setup.js frontend/test",
     "test:watch": "npm test -- --watch",
-    "coverage": "NODE_ENV=test nyc mocha --recursive --require frontend/test-setup.js frontend/test"
+    "coverage": "NODE_ENV=test nyc mocha --recursive --require frontend/test-setup.js frontend/test",
+    "addon:locales": "gulp addon-copy-locales"
   }
 }