
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
editorconfig
Advanced tools
The editorconfig npm package is used to parse and apply editor configuration from .editorconfig files. These files are designed to maintain consistent coding styles across different editors and IDEs for a project. The package helps in reading the .editorconfig file and applying the configurations to the code editor.
Parse .editorconfig files
This feature allows you to parse an .editorconfig file to retrieve the configurations for a given file path. The parse function returns a promise that resolves with the configuration object.
const editorconfig = require('editorconfig');
editorconfig.parse(filePath).then(config => {
console.log(config);
});
Parse from a specific position in a file
This feature is useful when you want to get the configuration that applies from a specific line number in a file. It can be helpful when dealing with files that may have different configurations at different positions.
const editorconfig = require('editorconfig');
editorconfig.parse(filePath, { start: lineNumber }).then(config => {
console.log(config);
});
Generate editor configurations
This feature allows you to generate the contents of an .editorconfig file based on a given configuration object. The generate function returns a promise that resolves with the string content of the .editorconfig file.
const editorconfig = require('editorconfig');
const configs = {
indent_style: 'space',
indent_size: 2
};
editorconfig.generate(configs).then(content => {
console.log(content);
});
Prettier is an opinionated code formatter that supports many languages and integrates with most editors. Unlike editorconfig, which focuses on maintaining consistent coding styles, Prettier reformats your code according to its own set of rules, which can be customized.
ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code. It is more comprehensive than editorconfig as it can enforce coding standards and also find problematic patterns or code that doesn’t adhere to certain style guidelines.
Stylelint is a modern linter that helps you avoid errors and enforce conventions in your stylesheets. It is similar to editorconfig but is specifically designed for CSS, SCSS, and other styling languages, offering more detailed control over style rules.
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 editorconfig
To install the package system-wide:
$ npm install -g editorconfig
Most 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: '*' },
{ fileName: '[DIRECTORY]/.editorconfig', glob: '*.js' }
])
*/
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.log(await editorconfig.parseFromFiles(filePath, Promise.resolve(configs)))
})();
/*
{
indent_style: 'space',
indent_size: 2,
end_of_line: 'lf',
charset: 'utf-8',
trim_trailing_whitespace: true,
insert_final_newline: true,
tab_width: 2
};
*/
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> Specify version (used by devs to test compatibility)
--files Output file names that contributed to the configuration,
rather than the configuation itself
-h, --help display help for command
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 install
Next, run the following commands:
$ npm run build
$ 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>
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 ci
FAQs
EditorConfig File Locator and Interpreter for Node.js
The npm package editorconfig receives a total of 4,192,585 weekly downloads. As such, editorconfig popularity was classified as popular.
We found that editorconfig demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.