node package manager

ux-lint

Banno UX Linter

This project combines the following linting tools used by the Banno UX team into a single tool.

Installation

npm install -g ux-lint

You can also install the module local to a project and then invoke it from the CLI or a Node file (see "API" below).

Usage

ux-lint [--fix] [--extend <optionsFile>] [<folder>]

By default, ux-lint will lint any JS files in the src folder (including subfolders) and the current working directory. Pass file or folder names as arguments to lint them instead. Non-files (e.g., folders, devices, sockets, etc.) are automatically ignored.

If a --fix argument is specified, ux-lint will attempt to automatically fix any linting errors that it finds.

If --extend arguments are specified, ux-lint will parse the following JSON files for configuration overrides. The overrides should be indexed by plugin name (e.g., eslint).

The exit code is equal to the number of errors found by ux-lint (0 if no errors).

API

The ux-lint module can be included in your Javascript file and then invoked (for gulp or grunt tasks, for example).

var linter = require('ux-lint');
 
linter.check('src', { /* optional config, keyed by plugin name */ }, function(err, lintErrors) {
  // `err` is the Error object, if an error occurred 
  // `lintErrors` is an array of linting errors 
});
 
linter.fix('src', { /* optional config */ }, function(err, response) {
  // `err` and `response` are in the same format as the check() callback 
});
 
// A glob pattern can also be used: 
linter.check('*.js', function() {});

The first argument can be a file, file pattern, or array of those.

The configuration object passed as the 2nd argument will override (not replace) the default configuration.

You can also check/fix code directly:

linter.checkCode('// code here', { /* optional config, keyed by plugin name */ }, function(err, lintErrors) {
  // `err` is the Error object, if an error occurred 
  // `lintErrors` is an array of linting errors 
});
 
linter.fixCode('// code here', { /* optional config */ }, function(err, fixedCode) {
  // `err` is in the same format as the checkCode() callback 
  // `fixedCode` is the source code with the fixes 
});

A language option can be passed in the options to specify the format of the code (html or javascript), so that the appropriate linters are run.

Contributing

Want to propose a change to our style (and therefore linting) conventions? Want to add another linting tool? Pull requests and suggestions are welcome.

Please add tests and maintain the existing styling when adding and updating the code.

npm run lint  # run linting
npm test      # run tests

Linters

Each linter has a plugin in the linters folder. Plugins have the following signature:

// All methods return a promise that resolves to an array (or string, in the case of fixCode()). 
exports.check = function(filePattern, opts) { /* ... */ };
exports.fix   = function(filePattern, opts) { /* ... */ };
exports.checkCode = function(codeString, opts) { /* ... */ };
exports.fixCode   = function(codeString, opts) { /* ... */ };

The results array should contain objects with the following signature:

{
  plugin: 'eslint', // or 'jscs', etc 
  type: 'error', // or 'warning' 
  code: 'W117', // plugin's internal ID for the error 
  evidence: '\t\t\tconsole.log(error);', // copy of the offending code 
  line: 13, // line number of the offending code 
  character: 9, // column number of the offending code 
  description: '\'console\' is not defined.', // message about the error 
  file: '/Users/jdoe/bad-javascript.js' // filename (check() and fix() only) 
}

Look at other plugins for the common patterns and modules to use.

Plugins are automatically loaded by the ux-lint tool.

License

Copyright 2015 Jack Henry & Associates Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.