Security News
Cloudflare Adds Security.txt Setup Wizard
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
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
options is an object with the following defaults:
{
config: '.editorconfig',
version: pkg.version,
root: '/'
};
Search for .editorconfig
starting from the current directory to the root directory.
Example:
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
};
*/
Synchronous version of editorconfig.parse()
.
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()
.
options is an object with the following defaults:
{
config: '.editorconfig',
version: pkg.version,
root: '/'
};
Specify the .editorconfig
.
Example:
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
};
*/
Synchronous version of editorconfig.parseFromFiles()
.
$ ./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
To install dependencies for this package run this in the package directory:
$ npm install
Next, run the following commands:
$ npm run build
$ npm run copy
$ npm link ./dist
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-script test-verbose
0.15.3
FAQs
EditorConfig File Locator and Interpreter for Node.js
The npm package editorconfig receives a total of 3,637,622 weekly downloads. As such, editorconfig popularity was classified as popular.
We found that editorconfig demonstrated a not healthy version release cadence and project activity because the last version was released 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
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.