editorconfig 0.12.2 → 0.13.3

package/README.md

@@ -1,6 +1,6 @@
 # EditorConfig JavaScript Core
 
-[![Build Status](https://travis-ci.org/editorconfig/editorconfig-core-js.png?branch=master)](https://travis-ci.org/editorconfig/editorconfig-core-js)
+[![Build Status](https://travis-ci.org/editorconfig/editorconfig-core-js.svg?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][].
@@ -12,31 +12,120 @@ You need [node][] to use this package.
 
 To install this package (system-wide):
 
-    $ npm install editorconfig
+```bash
+$ npm install editorconfig
+```
 
 To install the package system-wide:
 
-    $ npm install -g editorconfig
-
+```bash
+$ npm install -g editorconfig
+```
 
 ## Usage
 
-Usage as a Node library:
+### in Node.js:
+
+#### parse(filePath[, options])
+
+options is an object with the following defaults:
+
+```js
+{
+  config: '.editorconfig',
+  version: pkg.version,
+  root: '/'
+};
+```
+
+Search for `.editorconfig` starting from the current directory to the root directory.
+
+Example:
+
+```js
+var editorconfig = require('editorconfig');
+var path = require('path');
+var filePath = path.join(__dirname, '/sample.js');
+var promise = editorconfig.parse(filePath);
+promise.then(function onFulfilled(result) {
+  console.log(result);
+});
+
+/*
+  {
+    indent_style: 'space',
+    indent_size: 2,
+    end_of_line: 'lf',
+    charset: 'utf-8',
+    trim_trailing_whitespace: true,
+    insert_final_newline: true,
+    tab_width: 2
+  };
+*/
+```
+
+#### parseSync(filePath[, options])
+
+Synchronous version of `editorconfig.parse()`.
+
+#### parseString(fileContent)
+
+The `parse()` function above uses `parseString()` under the hood. If you have your file contents
+just pass it to `parseString()` and it'll return the same results as `parse()`.
 
-    $ 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' }
+#### parseFromFiles(filePath, configs[, options])
 
+options is an object with the following defaults:
 
-Usage as a command line tool:
+```js
+{
+  config: '.editorconfig',
+  version: pkg.version,
+  root: '/'
+};
+```
+
+Specify the `.editorconfig`.
+
+Example:
 
+```js
+var editorconfig = require('editorconfig');
+var fs = require('fs');
+var path = require('path');
+var configPath = path.join(__dirname, '/.editorconfig');
+var configs = [
+  {
+    name: configPath,
+    contents: fs.readFileSync(configPath, 'utf8')
+  }
+];
+var filePath = path.join(__dirname, '/sample.js');
+var promise = editorconfig.parseFromFiles(filePath, configs);
+promise.then(function onFulfilled(result) {
+  console.log(result)
+});
+
+/*
+  {
+    indent_style: 'space',
+    indent_size: 2,
+    end_of_line: 'lf',
+    charset: 'utf-8',
+    trim_trailing_whitespace: true,
+    insert_final_newline: true,
+    tab_width: 2
+  };
+*/
 ```
+
+#### parseFromFilesSync(filePath, configs[, options])
+
+Synchronous version of `editorconfig.parseFromFiles()`.
+
+### in Command Line
+
+```bash
 $ ./bin/editorconfig
 
     Usage: editorconfig [OPTIONS] FILEPATH1 [FILEPATH2 FILEPATH3 ...]
@@ -55,23 +144,28 @@ $ ./bin/editorconfig
 
 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
-
+```bash
+$ ./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
+```bash
+$ npm install
+```
 
 Next, run:
 
-    $ npm link
+```bash
+$ 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
@@ -83,8 +177,9 @@ link again to get the latest dependencies.
 
 To test the command line interface:
 
-    $ editorconfig <filepath>
-
+```bash
+$ editorconfig <filepath>
+```
 
 # Testing
 
@@ -92,11 +187,15 @@ To test the command line interface:
 
 To run the tests:
 
-    $ npm test
+```bash
+$ npm test
+```
 
 To run the tests with increased verbosity (for debugging test failures):
 
-    $ npm run-script test-verbose
+```bash
+$ npm run-script test-verbose
+```
 
 [EditorConfig C Core]: https://github.com/editorconfig/editorconfig-core
 [EditorConfig Python Core]: https://github.com/editorconfig/editorconfig-core-py

package/editorconfig.js

@@ -1,11 +1,13 @@
+var Promise = require('bluebird');
+var fs = require('fs');
 var os = require('os');
 var path = require('path');
-var Promise = require('bluebird');
-var whenReadFile = Promise.promisify(require('fs').readFile);
+var semver = require('semver');
+var util = require('util');
+var whenReadFile = Promise.promisify(fs.readFile);
 
-var minimatch = require('./lib/fnmatch');
 var iniparser = require('./lib/ini');
-var Version = require('./lib/version');
+var minimatch = require('./lib/fnmatch');
 var pkg = require('./package.json');
 
 var knownProps = [
@@ -50,7 +52,7 @@ 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" &&
-    !("indent_size" in matches) && version.gte(new Version(0, 10))) {
+    !("indent_size" in matches) && semver.gte(version, "0.10.0")) {
     matches.indent_size = "tab";
   }
 
@@ -72,11 +74,39 @@ function processOptions(options, filepath) {
   options = options || {};
   return {
     config: options.config || '.editorconfig',
-    version: new Version(options.version || pkg.version),
+    version: options.version || pkg.version,
     root: path.resolve(options.root || getFilepathRoot(filepath))
   };
 }
 
+function buildFullGlob(pathPrefix, glob) {
+  switch (glob.indexOf('/')) {
+    case -1: glob = "**/" + glob; break;
+    case  0: glob = glob.substring(1); break;
+  }
+  return path.join(pathPrefix, glob);
+}
+
+function extendProps(props, options) {
+  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);
+    }
+    props[key] = value;
+  }
+  return props;
+}
+
 function parseFromFiles(filepath, files, options) {
   return getConfigsForFiles(files).then(function (configs) {
     return configs.reverse();
@@ -85,28 +115,9 @@ function parseFromFiles(filepath, files, options) {
     file.contents.forEach(function (section) {
       var glob = section[0], options = section[1];
       if (!glob) return;
-      switch (glob.indexOf('/')) {
-        case -1: glob = "**/" + glob; break;
-        case  0: glob = glob.substring(1); break;
-      }
-      var fullGlob = path.join(pathPrefix, glob);
+      var fullGlob = buildFullGlob(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;
-      }
+      matches = extendProps(matches, options);
     });
     return matches;
   }, {}).then(function (matches) {
@@ -114,6 +125,23 @@ function parseFromFiles(filepath, files, options) {
   });
 }
 
+function parseFromFilesSync(filepath, files, options) {
+  var configs = getConfigsForFilesSync(files);
+  configs.reverse();
+  var matches = {};
+  configs.forEach(function(config) {
+    var pathPrefix = path.dirname(config.name);
+    config.contents.forEach(function(section) {
+      var glob = section[0], options = section[1];
+      if (!glob) return;
+      var fullGlob = buildFullGlob(pathPrefix, glob);
+      if (!fnmatch(filepath, fullGlob)) return;
+      matches = extendProps(matches, options);
+    });
+  });
+  return processMatches(matches, options.version);
+}
+
 function StopReduce(array) {
   this.array = array;
 }
@@ -136,6 +164,22 @@ function getConfigsForFiles(files) {
   });
 }
 
+function getConfigsForFilesSync(files) {
+  var configs = [];
+  for (var i in files) {
+    var file = files[i];
+    var contents = iniparser.parseString(file.contents);
+    configs.push({
+      name: file.name,
+      contents: contents
+    });
+    if ((contents[0][1].root || '').toLowerCase() === 'true') {
+      break;
+    }
+  };
+  return configs;
+}
+
 function readConfigFiles(filepaths) {
   return Promise.map(filepaths, function (path) {
     return whenReadFile(path, 'utf-8').catch(function () {
@@ -146,14 +190,34 @@ function readConfigFiles(filepaths) {
   });
 }
 
+function readConfigFilesSync(filepaths) {
+  var files = [];
+  var file;
+  filepaths.forEach(function(filepath) {
+    try {
+      file = fs.readFileSync(filepath, 'utf8');
+    } catch (e) {
+      file = '';
+    }
+    files.push({name: filepath, contents: file});
+  });
+  return files;
+}
+
 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));
+    resolve(parseFromFiles(filepath, files, options));
   });
 };
 
+module.exports.parseFromFilesSync = function (filepath, files, options) {
+  filepath = path.resolve(filepath);
+  options = processOptions(options, filepath);
+  return parseFromFilesSync(filepath, files, options);
+};
+
 module.exports.parse = function (filepath, options) {
   return new Promise (function (resolve, reject) {
     filepath = path.resolve(filepath);
@@ -163,3 +227,11 @@ module.exports.parse = function (filepath, options) {
     resolve(parseFromFiles(filepath, files, options));
   });
 };
+
+module.exports.parseSync = function (filepath, options) {
+    filepath = path.resolve(filepath);
+    options = processOptions(options, filepath);
+    var filepaths = getConfigFileNames(filepath, options);
+    var files = readConfigFilesSync(filepaths);
+    return parseFromFilesSync(filepath, files, options);
+};

package/lib/ini.js

@@ -23,7 +23,7 @@ var regex = {
  * @param: {Function} callback, the function that will be called when parsing is done
  * @return: none
  */
-module.exports.parse = function (file, callback) {
+exports.parse = function (file, callback) {
   if (!callback) {
     return;
   }
@@ -36,11 +36,11 @@ module.exports.parse = function (file, callback) {
   });
 };
 
-module.exports.parseSync = function (file) {
+exports.parseSync = function (file) {
   return parse(fs.readFileSync(file, 'utf8'));
 };
 
-function parse (data) {
+exports.parseString = function (data) {
   var sectionBody = {};
   var sectionName = null;
   var value = [[sectionName, sectionBody]];
@@ -60,6 +60,4 @@ function parse (data) {
     }
   });
   return value;
-}
-
-module.exports.parseString = parse;
+};

package/package.json

@@ -1,15 +1,18 @@
 {
   "name": "editorconfig",
-  "version": "0.12.2",
+  "version": "0.13.3",
   "description": "EditorConfig File Locator and Interpreter for Node.js",
   "keywords": [
     "editorconfig",
     "core"
   ],
   "main": "editorconfig.js",
+  "bin": {
+    "editorconfig": "bin/editorconfig"
+  },
   "contributors": [
     "Hong Xu (topbug.net)",
-    "Jed Hunsaker <jed.hunsaker[at]gmail.com>",
+    "Jed Mao (https://github.com/jedmao/)",
     "Trey Hunner (http://treyhunner.com)"
   ],
   "directories": {
@@ -18,9 +21,9 @@
   },
   "scripts": {
     "pretest": "cmake .",
-    "test": "ctest .",
-    "test-verbose": "ctest -VV --output-on-failure .",
-    "codepaint": "codepainter xform -e **/**.js"
+    "test": "npm run lint && ctest .",
+    "test-verbose": "npm run lint && ctest -VV --output-on-failure .",
+    "lint": "eclint check --indent_size ignore editorconfig.js README.md \"bin/**\" \"lib/**\""
   },
   "repository": {
     "type": "git",
@@ -28,17 +31,17 @@
   },
   "bugs": "https://github.com/editorconfig/editorconfig-core-js/issues",
   "author": "EditorConfig Team",
-  "license": {
-    "type": "MIT",
-    "url": "http://editorconfig.mit-license.org/2012"
-  },
+  "license": "MIT",
   "dependencies": {
-    "bluebird": "^2.3.6",
-    "commander": "~1.1.1",
-    "lru-cache": "~2.0.0",
-    "sigmund": "~1.0.0"
+    "bluebird": "^3.0.5",
+    "commander": "^2.9.0",
+    "lru-cache": "^3.2.0",
+    "semver": "^5.1.0",
+    "sigmund": "^1.0.1"
   },
   "devDependencies": {
-    "codepainter": "^0.4.4"
+    "eclint": "^1.1.5",
+    "mocha": "^2.3.4",
+    "should": "^7.1.1"
   }
 }

package/lib/version.js

@@ -1,48 +0,0 @@
-function Version(version) {
-  var args = arguments;
-  this.components = typeof version === "string" ?
-    version.split(".").map(function(x){return parseInt(x, 10);}) :
-    Object.keys(arguments).map(function(k){return args[k];});
-
-  var len = this.components.length;
-  this.major = len ? this.components[0] : 0;
-  this.minor = len > 1 ? this.components[1] : 0;
-  this.build = len > 2 ? this.components[2] : 0;
-  this.revision = len > 3 ? this.components[3] : 0;
-
-  if (typeof version !== "string") {
-    return;
-  }
-
-  var ext = version.split("-");
-  if (ext.length === 2) {
-    this.configuration = ext[1];
-  }
-}
-
-Version.prototype = {
-  toString: function() {
-    var version = this.components.join(".");
-    if (typeof this.configuration !== "undefined") {
-      version += "-" + this.configuration;
-    }
-    return version;
-  },
-  gte: function(other){
-    if (this.major < other.major) {
-      return false;
-    }
-    if (this.minor < other.minor) {
-      return false;
-    }
-    if (this.build < other.build) {
-      return false;
-    }
-    if (this.revision < other.revision) {
-      return false;
-    }
-    return true;
-  }
-};
-
-module.exports = Version;