Permalink
Browse files

Changed namespace, updated documentation and README. Other related th…

…ings.
  • Loading branch information...
1 parent 7636134 commit 1e7011f752a4e37cab483073d57c2c2a81a5de48 @arthurakay committed Dec 11, 2012
Showing with 117 additions and 111 deletions.
  1. +13 −2 CHANGELOG
  2. +5 −5 PhantomLint.js → LintRoller.js
  3. +2 −29 README
  4. +1 −1 docs/data.js
  5. +3 −3 docs/index.html
  6. +1 −0 docs/output/LintRoller.js
  7. +0 −1 docs/output/PhantomLint.js
  8. +85 −62 docs/source/{PhantomLint.html → LintRoller.html}
  9. +1 −1 generate_docs.sh
  10. +2 −2 package.json
  11. +1 −2 test.bat
  12. +2 −2 test.js
  13. +1 −1 test.sh
View
@@ -1,10 +1,21 @@
-Version 1.3.0 (December 7, 2012)
+===============
+ VERSION 2.x
+===============
+
+Version 2.0.0 (December 11, 2012) - BREAKING CHANGES ALL AROUND!
+ - Changed name from "PhantomLint" to "LintRoller"
- added JSHint support
- optionally disable available linters (JSLint or JSHint)
- - refactored configuration of JSLint file and options (*** BREAKING CHANGE ***)
+ - refactored configuration of linter options
- refactored application of init() configuration
- updated test.js
+ - added documentation via JSDuck
+ - removed dependency on PhantomJS - now running on Node.js as it's more ubiquitous, and installation via NPM is easier
+
+===============
+ VERSION 1.x
+===============
Version 1.2.1 (June 7, 2012)
- updates to example
@@ -25,14 +25,14 @@ var fs = require('fs'),
JSHINT = require('jshint').JSHINT;
/**
- * @class PhantomLint
+ * @class LintRoller
* @author Arthur Kay (http://www.akawebdesign.com)
* @singleton
- * @version 1.3.0
+ * @version 2.0.0
*
* GitHub Project: https://github.com/arthurakay/PhantomLint
*/
-PhantomLint = {
+LintRoller = {
/**
* @cfg {Array} filepaths
* REQUIRED. An array of relative filepaths to the folders containing JS files
@@ -439,7 +439,7 @@ PhantomLint = {
logToFile : function (errorList) {
this.log('\nWriting ' + ((errorList.length - this.linters.length ) / 6) + ' errors to new log file.', true);
- var header = 'PhantomLint : Output for ' + new Date() + '\n\n';
+ var header = 'LintRoller : Output for ' + new Date() + '\n\n';
errorList.splice(0, 0, header);
var output = errorList.join().replace(/,/g, '\n');
@@ -468,4 +468,4 @@ PhantomLint = {
}
};
-module.exports = PhantomLint;
+module.exports = LintRoller;
View
31 README
@@ -1,38 +1,11 @@
OVERVIEW:
- - PhantomLint is an add-on to Phantom.js that recursively dives into a directory and lints your JavaScript files.
+ - LintRoller is a Node.js module that recursively dives into a directory and lints your JavaScript files.
- Available linting platforms include JSLint and JSHint.
- An example shell script (test.sh, test.bat) is provided to run the test.js demo.
-CONFIG OPTIONS:
- - filepaths (Array)
- REQUIRED. An array of relative filepaths to the directories containing JS files
+For full documentation, view /docs/index.html in your browser.
- - exclusions (Array)
- An array of relative filepaths to the directories containing JS files that should be ignored
- - jsLint (Object/Boolean)
- An object containing "file" and "options" properties (False to disable usage.).
- - "file" is a relative filepath to the local JSLint file to use (defaults to ./assets/jslint.js).
- - "options" is an object containing the optional lint flags.
- - jsHint (Object/Boolean)
- An object containing "file" and "options" properties (False to disable usage.).
- - "file" is a relative filepath to the local JSHint file to use (defaults to ./assets/jshint-master/src/stable/jshint.js).
- - "options" is an object containing the optional lint flags.
-
- - verbose (Boolean)
- Defaults to true.
-
- - stopOnFirstError (Boolean)
- Defaults to true.
-
- - logFile (String)
- A relative filepath to where the output error log should go.
- (defaults to ./error_log.txt)
-
-
-
-NOTES:
- - The PhantomJS binary included in this repo is the Mac OS X static build
View

Some generated files are not rendered by default. Learn more.

Oops, something went wrong.
View
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
- <title>PhantomLint API Docs</title>
+ <title>LintRoller API Docs</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<meta name="fragment" content="!">
@@ -23,15 +23,15 @@
<div id="loading"><span class="title"></span><span class="logo"></span></div>
- <div id="header-content">PhantomLint API Docs</div>
+ <div id="header-content">LintRoller API Docs</div>
<div id='categories-content' style='display:none'>
<div class='section'>
<h1>Others...</h1>
<div class='left-column'>
<h3>Others...</h3>
<div class='links'>
-<a href="#!/api/PhantomLint" rel="PhantomLint" class="docClass">PhantomLint</a>
+<a href="#!/api/LintRoller" rel="LintRoller" class="docClass">LintRoller</a>
</div>
</div>
<div class='middle-column'>

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.
Oops, something went wrong.

0 comments on commit 1e7011f

Please sign in to comment.