editorconfig 0.11.3 → 0.12.2

package/.gitmodules

@@ -1,3 +1,3 @@
-[submodule "tests"]
-	path = tests
-	url = git://github.com/editorconfig/editorconfig-core-test.git
+[submodule "tests"]
+	path = tests
+	url = git://github.com/editorconfig/editorconfig-core-test.git

package/LICENSE

@@ -1,19 +1,19 @@
-Copyright © 2012 EditorConfig Team
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the “Software”), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+Copyright © 2012 EditorConfig Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -1,84 +1,104 @@
-# EditorConfig JavaScript Core
-
-[![Build Status](https://travis-ci.org/editorconfig/editorconfig-core-js.png?branch=master)](https://travis-ci.org/editorconfig/editorconfig-core-js)
-
-The EditorConfig JavaScript core will provide the same functionality as the
-[EditorConfig C Core][] and [EditorConfig Python Core][].
-
-## Installation
-
-You need [node][] to use this package.
-
-To install this package (system-wide):
-
-    sudo npm install -g .
-
-## Usage
-
-Usage as a Node library:
-
-    $ node
-    > var editorconfig = require('./editorconfig');
-    undefined
-    > editorconfig.parse('/home/zoidberg/humans/anatomy.md');
-    { charset: 'utf-8',
-      insert_final_newline: 'true',
-      end_of_line: 'lf',
-      tab_width: '8',
-      trim_trailing_whitespace: 'sometimes' }
-
-
-Usage as a command line tool:
-
-```
-$ ./bin/editorconfig
-
-  Usage: editorconfig [OPTIONS] FILEPATH1 [FILEPATH2 FILEPATH3 ...]
-
-  EditorConfig Node.js Core Version 0.11.4-development
-
-  FILEPATH can be a hyphen (-) if you want path(s) to be read from stdin.
-
-  Options:
-
-    -h, --help     output usage information
-    -V, --version  output the version number
-    -f <path>      Specify conf filename other than ".editorconfig"
-    -b <version>   Specify version (used by devs to test compatibility)
-```
-
-Example:
-
-    $ ./bin/editorconfig /home/zoidberg/humans/anatomy.md
-    charset=utf-8
-    insert_final_newline=true
-    end_of_line=lf
-    tab_width=8
-    trim_trailing_whitespace=sometimes
-
-## Development
-
-To install dependencies for this package run this in the package directory:
-
-    npm install
-
-To test the command line interface:
-
-    ./bin/editorconfig <filepath>
-
-# Testing
-
-[CMake][] must be installed to run the tests.
-
-To run the tests:
-
-    npm test
-
-To run the tests with increased verbosity (for debugging test failures):
-
-    ctest -VV --output-on-failure .
-
-[EditorConfig C Core]: https://github.com/editorconfig/editorconfig-core
-[EditorConfig Python Core]: https://github.com/editorconfig/editorconfig-core-py
-[node]: http://nodejs.org/
-[cmake]: http://www.cmake.org
+# EditorConfig JavaScript Core
+
+[![Build Status](https://travis-ci.org/editorconfig/editorconfig-core-js.png?branch=master)](https://travis-ci.org/editorconfig/editorconfig-core-js)
+
+The EditorConfig JavaScript core will provide the same functionality as the
+[EditorConfig C Core][] and [EditorConfig Python Core][].
+
+
+## Installation
+
+You need [node][] to use this package.
+
+To install this package (system-wide):
+
+    $ npm install editorconfig
+
+To install the package system-wide:
+
+    $ npm install -g editorconfig
+
+
+## Usage
+
+Usage as a Node library:
+
+    $ node
+    > var editorconfig = require('./editorconfig');
+    undefined
+    > editorconfig.parse('/home/zoidberg/humans/anatomy.md');
+    { charset: 'utf-8',
+        insert_final_newline: 'true',
+        end_of_line: 'lf',
+        tab_width: '8',
+        trim_trailing_whitespace: 'sometimes' }
+
+
+Usage as a command line tool:
+
+```
+$ ./bin/editorconfig
+
+    Usage: editorconfig [OPTIONS] FILEPATH1 [FILEPATH2 FILEPATH3 ...]
+
+    EditorConfig Node.js Core Version 0.11.4-development
+
+    FILEPATH can be a hyphen (-) if you want path(s) to be read from stdin.
+
+    Options:
+
+        -h, --help     output usage information
+        -V, --version  output the version number
+        -f <path>      Specify conf filename other than ".editorconfig"
+        -b <version>   Specify version (used by devs to test compatibility)
+```
+
+Example:
+
+    $ ./bin/editorconfig /home/zoidberg/humans/anatomy.md
+    charset=utf-8
+    insert_final_newline=true
+    end_of_line=lf
+    tab_width=8
+    trim_trailing_whitespace=sometimes
+
+
+## Development
+
+To install dependencies for this package run this in the package directory:
+
+    $ npm install
+
+Next, run:
+
+    $ npm link
+
+The global editorconfig will now point to the files in your development
+repository instead of a globally-installed version from npm. You can now use
+editorconfig directly to test your changes.
+
+If you ever update from the central repository and there are errors, it might
+be because you are missing some dependencies. If that happens, just run npm
+link again to get the latest dependencies.
+
+To test the command line interface:
+
+    $ editorconfig <filepath>
+
+
+# Testing
+
+[CMake][] must be installed to run the tests.
+
+To run the tests:
+
+    $ npm test
+
+To run the tests with increased verbosity (for debugging test failures):
+
+    $ npm run-script test-verbose
+
+[EditorConfig C Core]: https://github.com/editorconfig/editorconfig-core
+[EditorConfig Python Core]: https://github.com/editorconfig/editorconfig-core-py
+[node]: http://nodejs.org/
+[cmake]: http://www.cmake.org

package/bin/editorconfig

@@ -1,39 +1,42 @@
-#!/usr/bin/env node
-
-var path = require("path");
-var program = require("commander");
-
-var editorconfig = require("../editorconfig");
-var package = require("../package.json");
-
-
-program.version("EditorConfig Node.js Core Version " + package.version);
-
-program
-  .usage([
-      "[OPTIONS] FILEPATH1 [FILEPATH2 FILEPATH3 ...]",
-      program._version,
-      "FILEPATH can be a hyphen (-) if you want path(s) to be read from stdin."
-    ].join("\n\n  "))
-  .option("-f <path>",     "Specify conf filename other than \".editorconfig\"")
-  .option("-b <version>",  "Specify version (used by devs to test compatibility)")
-  .option("-v, --version", "Display version information")
-  .parse(process.argv);
-
-// Throw away the native -V flag in lieu of the one we've manually specified
-// to adhere to testing requirements
-program.options.shift();
-
-if ( ! program.args.length) {
-  program.help();
-}
-
-program.args.forEach(function(filePath) {
-  var parsed = editorconfig.parse(filePath, {config: program.F, version: program.B});
-  if (program.args.length > 1) {
-    console.log("[%s]", filePath);
-  }
-  Object.keys(parsed).forEach(function(key) {
-    console.log(key + "=" + parsed[key]);
-  });
-});
+#!/usr/bin/env node
+
+var path = require("path");
+var program = require("commander");
+var Promise = require("bluebird");
+
+var editorconfig = require("../editorconfig");
+var package = require("../package.json");
+
+program.version("EditorConfig Node.js Core Version " + package.version);
+
+program
+  .usage([
+      "[OPTIONS] FILEPATH1 [FILEPATH2 FILEPATH3 ...]",
+      program._version,
+      "FILEPATH can be a hyphen (-) if you want path(s) to be read from stdin."
+    ].join("\n\n  "))
+  .option("-f <path>",     "Specify conf filename other than \".editorconfig\"")
+  .option("-b <version>",  "Specify version (used by devs to test compatibility)")
+  .option("-v, --version", "Display version information")
+  .parse(process.argv);
+
+// Throw away the native -V flag in lieu of the one we've manually specified
+// to adhere to testing requirements
+program.options.shift();
+
+var files = program.args;
+
+if (!files.length) {
+  program.help();
+}
+
+Promise.map(files, function(filePath) {
+  return editorconfig.parse(filePath, {config: program.F, version: program.B});
+}).each(function(parsed, i, length) {
+  if (length > 1) {
+    console.log("[%s]", files[i]);
+  }
+  Object.keys(parsed).forEach(function(key) {
+    console.log(key + "=" + parsed[key]);
+  });
+});

package/editorconfig.js

@@ -1,15 +1,24 @@
-var fs = require('fs');
+var os = require('os');
 var path = require('path');
+var Promise = require('bluebird');
+var whenReadFile = Promise.promisify(require('fs').readFile);
 
 var minimatch = require('./lib/fnmatch');
 var iniparser = require('./lib/ini');
 var Version = require('./lib/version');
 var pkg = require('./package.json');
 
-
-var knownProps = ['end_of_line', 'indent_style', 'indent_size',
-  'insert_final_newline', 'trim_trailing_whitespace', 'charset'];
-
+var knownProps = [
+  'end_of_line',
+  'indent_style',
+  'indent_size',
+  'insert_final_newline',
+  'trim_trailing_whitespace',
+  'charset'
+].reduce(function (set, prop) {
+  set[prop] = true;
+  return set;
+}, {});
 
 function fnmatch(filepath, glob) {
   var matchOptions = {matchBase: true, dot: true, noext: true};
@@ -17,21 +26,27 @@ function fnmatch(filepath, glob) {
   return minimatch(filepath, glob, matchOptions);
 }
 
-
-function getConfigFileNames(filepath, configname) {
-  var old_dirname = filepath;
-  var dirname = old_dirname;
+function getConfigFileNames(filepath, options) {
   var paths = [];
   do {
-    paths.push(path.join(dirname, configname || ".editorconfig"));
-    old_dirname = dirname;
-    dirname = path.dirname(old_dirname);
-  } while(dirname != old_dirname);
+    filepath = path.dirname(filepath);
+    paths.push(path.join(filepath, options.config));
+  } while (filepath !== options.root);
   return paths;
 }
 
-function processMatches(matches, version) {
+function getFilepathRoot(filepath) {
+  if (path.parse !== undefined) {
+    // Node.js >= 0.11.15
+    return path.parse(filepath).root;
+  }
+  if (os.platform() === 'win32') {
+    return path.resolve(filepath).match(/^(\\\\[^\\]+\\)?[^\\]+\\/)[0];
+  }
+  return '/';
+}
 
+function processMatches(matches, version) {
   // Set indent_size to "tab" if indent_size is unspecified and
   // indent_style is set to "tab".
   if ("indent_style" in matches && matches.indent_style === "tab" &&
@@ -42,99 +57,109 @@ function processMatches(matches, version) {
   // Set tab_width to indent_size if indent_size is specified and
   // tab_width is unspecified
   if ("indent_size" in matches && !("tab_width" in matches) &&
-    matches.indent_size !== "tab")
+  matches.indent_size !== "tab")
     matches.tab_width = matches.indent_size;
 
   // Set indent_size to tab_width if indent_size is "tab"
   if("indent_size" in matches && "tab_width" in matches &&
-    matches.indent_size === "tab")
+  matches.indent_size === "tab")
     matches.indent_size = matches.tab_width;
 
   return matches;
 }
 
-
-function processOptions(options) {
+function processOptions(options, filepath) {
   options = options || {};
-  options.version = new Version(options.version || pkg.version);
-  return options;
+  return {
+    config: options.config || '.editorconfig',
+    version: new Version(options.version || pkg.version),
+    root: path.resolve(options.root || getFilepathRoot(filepath))
+  };
 }
 
-
-function parseFromFiles(filepath, configs, options) {
-  var matches = {};
-
-  configs.reverse().forEach(function (file) {
+function parseFromFiles(filepath, files, options) {
+  return getConfigsForFiles(files).then(function (configs) {
+    return configs.reverse();
+  }).reduce(function (matches, file) {
     var pathPrefix = path.dirname(file.name);
-    var config = file.contents;
-    config.forEach(function (section) {
-      var fullGlob;
-      var glob = section[0];
-      var options = section[1];
+    file.contents.forEach(function (section) {
+      var glob = section[0], options = section[1];
       if (!glob) return;
-      if (glob.indexOf('/') === -1) {
-        fullGlob = path.join(pathPrefix, "**/" + glob);
-      } else if (glob.indexOf('/') === 0) {
-        fullGlob = path.join(pathPrefix, glob.substring(1));
-      } else {
-        fullGlob = path.join(pathPrefix, glob);
+      switch (glob.indexOf('/')) {
+        case -1: glob = "**/" + glob; break;
+        case  0: glob = glob.substring(1); break;
       }
-      if (fnmatch(filepath, fullGlob)) {
-        for (var key in options) {
-          var value = options[key];
-          if (knownProps.indexOf(key) !== -1) {
-            value = value.toLowerCase();
-          }
-          try {
-            value = JSON.parse(value);
-          } catch(e){}
-          matches[key.toLowerCase()] = value;
+      var fullGlob = path.join(pathPrefix, glob);
+      if (!fnmatch(filepath, fullGlob)) return;
+      for (var key in options) {
+        var value = options[key];
+        key = key.toLowerCase();
+        if (knownProps[key]) {
+          value = value.toLowerCase();
+        }
+        try {
+          value = JSON.parse(value);
+        } catch(e) {}
+        if (typeof value === 'undefined' || value === null) {
+          // null and undefined are values specific to JSON (no special meaning
+          // in editorconfig) & should just be returned as regular strings.
+          value = String(value);
         }
+        matches[key] = value;
       }
     });
+    return matches;
+  }, {}).then(function (matches) {
+    return processMatches(matches, options.version);
   });
+}
 
-  return processMatches(matches, options.version);
-
+function StopReduce(array) {
+  this.array = array;
 }
 
+StopReduce.prototype = Object.create(Error.prototype);
 
 function getConfigsForFiles(files) {
-  var configs = [];
-  for (var i = 0; i < files.length; i++) {
-    files[i].contents = iniparser.parseString(files[i].contents);
-    configs.push(files[i]);
-    if (/^true$/i.test(files[i].contents[0][1].root)) break;
-  }
-  return configs;
+  return Promise.reduce(files, function (configs, file) {
+    var contents = iniparser.parseString(file.contents);
+    configs.push({
+      name: file.name,
+      contents: contents
+    });
+    if ((contents[0][1].root || '').toLowerCase() === 'true') {
+      return Promise.reject(new StopReduce(configs));
+    }
+    return configs;
+  }, []).catch(StopReduce, function (stop) {
+    return stop.array;
+  });
 }
 
-
 function readConfigFiles(filepaths) {
-  var files = [];
-  filepaths.forEach(function (configFilePath) {
-    if (fs.existsSync(configFilePath)) {
-      files.push({
-        name: configFilePath,
-        contents: fs.readFileSync(configFilePath, 'utf-8')
-      });
-    }
+  return Promise.map(filepaths, function (path) {
+    return whenReadFile(path, 'utf-8').catch(function () {
+      return '';
+    }).then(function (contents) {
+      return {name: path, contents: contents};
+    });
   });
-  return files;
 }
 
-
-module.exports.parseFromFiles = function(filepath, files, options) {
-  filepath = path.resolve(filepath);
-  options = processOptions(options);
-  return parseFromFiles(filepath, getConfigsForFiles(files), options);
+module.exports.parseFromFiles = function (filepath, files, options) {
+  return new Promise (function (resolve, reject) {
+    filepath = path.resolve(filepath);
+    options = processOptions(options, filepath);
+    resolve(parseFromFiles(filepath, files, option));
+  });
 };
 
-
-module.exports.parse = function(filepath, options) {
-  filepath = path.resolve(filepath);
-  options = processOptions(options);
-  var filepaths = getConfigFileNames(path.dirname(filepath), options.config);
-  var files = readConfigFiles(filepaths);
-  return parseFromFiles(filepath, getConfigsForFiles(files), options);
+module.exports.parse = function (filepath, options) {
+  return new Promise (function (resolve, reject) {
+    filepath = path.resolve(filepath);
+    options = processOptions(options, filepath);
+    var filepaths = getConfigFileNames(filepath, options);
+    var files = readConfigFiles(filepaths);
+    resolve(parseFromFiles(filepath, files, options));
+  });
 };