Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

editorconfig-checker

Package Overview
Dependencies
Maintainers
1
Versions
55
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

editorconfig-checker

A tool to verify that your files are in harmony with your .editorconfig

  • 2.0.8
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

editorconfig-checker

Logo

Build Status dependencies devDependencies Greenkeeper badge code style: prettier Total alerts Language grade: JavaScript

What?

This is a tool to check if your files consider your .editorconfig. Most tools - like linters for example - only test one filetype and need an extra configuration. This tool only needs your editorconfig to check all files.

Sample Output

Important

This is only a wrapper for the core editorconfig-checker. You should have a look at this repository to know how this tool can be used and what possibilities/caveats are there. This version can be used in the same way as the core as every argument is simply passed down to it.

Installation

Installation via npm/yarn is recommended:

yarn add --dev editorconfig-checker
./node_modules/.bin/editorconfig-checker

npm install --save-dev editorconfig-checker
./node_modules/.bin/editorconfig-checker

# or in a npm-script just
editorconfig-checker

Otherwise you could clone the repository and execute the script manually.

git clone git@github.com:editorconfig-checker/editorconfig-checker.javascript.git
&& cd editorconfig-checker.javascript
&& make setup
&& ./editorconfig-checker.javascript/dist/index

Usage

There is an alias from editorconfig-checker to ec so you can exchange every occurrence of editorconfig-checker with ec.

If you installed it via npm you have a binary in your node_modules/.bin folder called editorconfig-checker. Then you could create a script in your package.json like this:

"scripts": {
    "lint:editorconfig": "editorconfig-checker"
}

Usage output:

USAGE:
    -e string
        a regex which files should be excluded from checking - needs to be a valid regular expression
    -exclude string
        a regex which files should be excluded from checking - needs to be a valid regular expression
    -h    print the help
    -help
        print the help
    -i    ignore default excludes
    -ignore
        ignore default excludes
    -v    print debugging information
    -verbose
        print debugging information
    -version
        print the version number

Support

If you have any questions or just want to chat join #editorconfig-checker on freenode(IRC). If you don't have an IRC-client set up you can use the freenode webchat.

Keywords

FAQs

Package last updated on 21 Apr 2019

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc