mozilla / node-firefox-build-tools

INACTIVE - http://mzl.la/ghe-archive - Common build tasks and configuration files for the node-firefox project

node-firefox-build-tools

Common build tasks and configuration files for the node-firefox project.

Right now this is just a set of common gulp tasks and style checks.

Usage

Install first: npm install --save-dev node-firefox-build-tools.

If you are not using gulp in your module yet, now is the right time to add it:

npm install --save-dev gulp

Then either create a gulpfile.js or edit the existing one to start using the build tools:

var gulp = require('gulp');
var buildTools = require('node-firefox-build-tools');

buildTools.loadGulpTasks(gulp);

Available tasks

lint

Run quality and style checks on your code.

nodeunit

Run all nodeunit tests matching tests/unit/**/test.*.js

test

Run linters and tests. You may want to override this task.

watch

Run linters and tests whenever code is updated. This is handy if you want instant feedback on code you write! (This is the default task.)

Bootstrap for new node-firefox modules

You can use the included node-firefox-init-project binary to copy our up-to-date Gulpfile and TravisCI files into your project. This means even less work when you create a new node-firefox module:

cd node-firefox-something-something # go to your project on the command line
node-firefox-init-project # create your files; you're finished!

License

This program is free software; it is distributed under an Apache License.

Copyright

Copyright (c) 2015 Mozilla (Contributors).

node-firefox-build-tools's Issues

Check for local .jshintrc and .jscsrc

If they exist, either:

1. Use them

or

2. Complain and tell the developer to use the stock ones

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)

Allow file lists to be extended

Does Gulp have variables we can set through its instance? That would be the easy way, I'd say.

Add command to create travis and gulp file for new project

It might be nice if you could automatically have files created for you if they didn't exist. This would help in the creation of new modules. Automation is nice!

Add rule for spaces around operators

See: https://github.com/mozilla/node-firefox-find-ports/pull/34/files#r26978865

Not catching certain indent mismatches

https://github.com/mozilla/node-firefox-start-simulator/pull/3/files#r23232174 has an indentation too deep that we aren't catching, so we should fix that!