mozilla / ember-cli-fxos

Ember-cli add-on for creating Firefox OS applications

Ember-cli-fxos

This is an Ember CLI add-on for creating Firefox OS applications.

Installation

From the root of your Ember CLI project:

ember install ember-cli-fxos

Configuration

Manifest File

Every Firefox OS application requires a manifest file in the root of your project.

This addon creates a manifest.webapp in your application's /public directory. Any values that start with @@ (e.g. @@appName) will be pulled from your package.json at build time. Reference MDN for additional information on configuring your manifest file.

Validation

After running ember build, your final manifest file will be compiled into the /dist directory. To validate the manifest file and check for any errors or warnings, run:

ember fxos:validate

Note: The module performing validation is still a work in progress. It may not catch all errors. Please do file bugs as you encounter them.

ember-cli-fxos's Issues

Generate manifest automatically afterInstall

Save users the step of having to generate it manually.

Prompt users to select packaged vs. hosted app

The environment config locationType must be set to none for packaged apps, but auto for hosted apps. Add-ons do not have the ability to override config values, so we can either prompt users to select the appropriate locationType, or err out the build process if it isn't accurate.

CODE_OF_CONDUCT.md file missing

As of January 1 2019, Mozilla requires that all GitHub projects include this CODE_OF_CONDUCT.md file in the project root. The file has two parts:

1. Required Text - All text under the headings Community Participation Guidelines and How to Report, are required, and should not be altered.
2. Optional Text - The Project Specific Etiquette heading provides a space to speak more specifically about ways people can work effectively and inclusively together. Some examples of those can be found on the Firefox Debugger project, and Common Voice. (The optional part is commented out in the raw template file, and will not be visible until you modify and uncomment that part.)

If you have any questions about this file, or Code of Conduct policies and procedures, please see Mozilla-GitHub-Standards or email [email protected].

(Message COC001)

Build only manifest instead of running a full ember build on fxos:validate

Currently running a full ember build before validating the manifest file with fxos:validate. This takes enough time to be annoying, so it would be nice to just build the manifest file or /public directory instead.

Figure out why we have to stub /public directory to satisfy travis

Add a generator for controller/model/route ala recroom

The old recroom generators allowed you to create a controller/route/model/template together, and also a static page (controller/route/template). We should add these to this generator for now, and/or see about making our own generator for it.

Include generator for setting up datastore

This might require too much configuration to make sense as a generator, but as it stands now, there is quite a bit of work involved in setting up a datastore (installing an adapter, importing it in Brocfile.js, creating an adapter file, creating a serializer file, and in some scenarios returning this.store in the application route's model. Would be nice to handle some of this if possible. Need to do some investigating.

Set `wrapInEval` to false in included hook.

Other wise, all users that target FirefoxOS will have to do this manually in their Brocfile.js.

Look into .gitignoring config file for credentials

Haven't seen a convention for doing this yet, need to talk to some ember cli folks about it

Update version in manifest when package/bower/whatever updates?

It would be nice, presumably, with a hook into ember build, to update the version inside the Open Web App manifest file so the version ready to be published to the marketplace/web server is up-to-date.

Related could be even auto-updating those versions on a deploy, but that's something that requires more careful treading.

Handle parsing different variations of package.json author field

Author fields in the package.json can be strings or objects. Currently we're only handing author fields in object form to place in the manifest file. Let's handle strings too.

Submit to marketplace

Allow users to submit to the Marketplace via the cli using their fancy APIs!

RFC - 'ember build' when doing a 'ember fxos:validate'

Should the ember fxos:validate command also do an ember build?

I was just recently playing with this addon. I ran ember fxos:validate on a project i had yet to run ember build on. This results in an error telling me to run ember build.

Thats fine, but the real issue that arose for me was after i ran the build, and ran the validate again, i got another error about a mandatory field missing. So i added that missing field to my package.json then re-ran the validate command. Which resulted in the same error.

I then realized i had to run ember build again.

I think running ember build with ember fxos:validate could save a step.

Not sure if there is some other reason for not doing this?

Update deprecated broccoli usage

During the postProcessTree hook on build, we use broccoli to merge some trees. The methods we're using are deprecated and need updating.

[Deprecated] this.pickFiles is deprecated, please use broccoli-funnel directly instead [addon: ember-cli-fxos]

[Deprecated] this.mergeTrees is deprecated, please use broccoli-merge-trees directly instead [addon: ember-cli-fxos]

Fix validation errors for optional fields

During the build step, the manifest file stubs in properties with an empty string if there is no value to pull from the package.json. This creates a validation error Error: InvalidPropertyLengthDeveloperUrl -urlmust be at least 1 in length. Let's not stub these in for optional fields.