package
EditorConfig File Locator and Interpreter for Node.js
npm install editorconfigGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
The EditorConfig JavaScript core will provide the same functionality as the EditorConfig C Core and EditorConfig Python Core.
You need node to use this package.
To install the package locally:
$ npm install editorconfigTo install the package system-wide:
$ npm install -g editorconfigMost of the API takes an options object, which has the following defaults:
{
config: '.editorconfig',
version: pkg.version,
root: '/',
files: undefined,
cache: undefined,
unset: false,
};Search for .editorconfig files starting from the current directory to the
root directory. Combine all of the sections whose section names match
filePath into a single object.
Example:
const editorconfig = require('editorconfig');
const path = require('path');
const filePath = path.join(__dirname, 'sample.js');
(async () => {
console.log(await editorconfig.parse(filePath, {files: []}));
})();
/*
{
indent_style: 'space',
indent_size: 2,
end_of_line: 'lf',
charset: 'utf-8',
trim_trailing_whitespace: true,
insert_final_newline: true,
tab_width: 2
};
assert.deepEqual(files, [
{ fileName: '[DIRECTORY]/.editorconfig', glob: '*' },
Synchronous version of editorconfig.parse().
The parse() function above uses parseBuffer() under the hood. If you have
the contents of a config file, and want to see what is being processed for
just that file rather than the full directory hierarchy, this might be useful.
This is a thin wrapper around parseBuffer() for backward-compatibility.
Prefer parseBuffer() to avoid an unnecessary UTF8-to-UTF16-to-UTF8
conversion. Deprecated.
Low-level interface, which exists only for backward-compatibility. Deprecated.
Example:
const editorconfig = require('editorconfig');
const fs = require('fs');
const path = require('path');
const configPath = path.join(__dirname, '.editorconfig');
const configs = [
{
name: configPath,
contents: fs.readFileSync(configPath, 'utf8')
}
];
const filePath = path.join(__dirname, '/sample.js');
(async () => {
console.
Synchronous version of editorconfig.parseFromFiles(). Deprecated.
$ ./bin/editorconfig
Usage: editorconfig [options] <FILEPATH...>
Arguments:
FILEPATH Files to find configuration for. Can be a hyphen (-) if you
want path(s) to be read from stdin.
Options:
-v, --version Display version information from the package
-f <path> Specify conf filename other than '.editorconfig'
-b <version>
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$ ./bin/editorconfig --files /home/zoidberg/humans/anatomy.md
/home/zoidberg/.editorconfig [*]
/home/zoidberg/.editorconfig [*.md]
/home/zoidberg/humans/.editorconfig [*]To install dependencies for this package run this in the package directory:
$ npm installNext, run the following commands:
$ npm run build
$ npm linkThe 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>CMake must be installed to run the tests.
To run the tests:
$ npm testTo run the tests with increased verbosity (for debugging test failures):
$ npm run cihildjj
joe-github@cursive.net
Estimated unpacked size across 8 packages.
1.5 MB
Includes dependencies.
4 direct dependencies.