feat: exclude option (#41)

* feat: exclude option

* style: formatting

* chore: update deps

* docs: fix option files

* fix: default values

* chore: order options

* test: add test for exclude option

* test: increase coverage

Author: ricardogobbosouza

README.md

@@ -113,21 +113,28 @@ A string indicating the root of your files.
 
 Path to `eslint` instance that will be used for linting. If the `eslintPath` is a folder like a official eslint, or specify a `formatter` option. now you dont have to install `eslint`.
 
-### `files`
+### `extensions`
 
 - Type: `String|Array[String]`
-- Default: `'.'`
+- Default: `'js'`
 
-Specify directories, files, or globs. Must be relative to `options.context`.
-Directories are traveresed recursively looking for files matching `options.extensions`.
-File and glob patterns ignore `options.extensions`.
+Specify extensions that should be checked.
 
-### `extensions`
+### `exclude`
 
 - Type: `String|Array[String]`
-- Default: `'js'`
+- Default: `'node_modules'`
 
-Specify extensions that should be checked.
+Specify the files and/or directories to exclude. Must be relative to `options.context`.
+
+### `files`
+
+- Type: `String|Array[String]`
+- Default: `null`
+
+Specify directories, files, or globs. Must be relative to `options.context`.
+Directories are traveresed recursively looking for files matching `options.extensions`.
+File and glob patterns ignore `options.extensions`.
 
 ### `fix`
 

declarations/getESLint.d.ts

@@ -16,10 +16,11 @@ export type Options = {
   emitError?: boolean | undefined;
   emitWarning?: boolean | undefined;
   eslintPath?: string | undefined;
+  exclude?: string | string[] | undefined;
+  extensions?: string | string[] | undefined;
   failOnError?: boolean | undefined;
   failOnWarning?: boolean | undefined;
   files?: string | string[] | undefined;
-  extensions?: string | string[] | undefined;
   fix?: boolean | undefined;
   formatter?: string | import('./options').FormatterFunction | undefined;
   lintDirtyModulesOnly?: boolean | undefined;

declarations/index.d.ts

@@ -5,10 +5,11 @@ export type Options = {
   emitError?: boolean | undefined;
   emitWarning?: boolean | undefined;
   eslintPath?: string | undefined;
+  exclude?: string | string[] | undefined;
+  extensions?: string | string[] | undefined;
   failOnError?: boolean | undefined;
   failOnWarning?: boolean | undefined;
   files?: string | string[] | undefined;
-  extensions?: string | string[] | undefined;
   fix?: boolean | undefined;
   formatter?: string | import('./options').FormatterFunction | undefined;
   lintDirtyModulesOnly?: boolean | undefined;

declarations/linter.d.ts

@@ -31,10 +31,11 @@ export type Options = {
   emitError?: boolean | undefined;
   emitWarning?: boolean | undefined;
   eslintPath?: string | undefined;
+  exclude?: string | string[] | undefined;
+  extensions?: string | string[] | undefined;
   failOnError?: boolean | undefined;
   failOnWarning?: boolean | undefined;
   files?: string | string[] | undefined;
-  extensions?: string | string[] | undefined;
   fix?: boolean | undefined;
   formatter?: string | import('./options').FormatterFunction | undefined;
   lintDirtyModulesOnly?: boolean | undefined;

declarations/options.d.ts

@@ -18,10 +18,11 @@
  * @property {boolean=} emitError
  * @property {boolean=} emitWarning
  * @property {string=} eslintPath
+ * @property {string|string[]=} exclude
+ * @property {string|string[]=} extensions
  * @property {boolean=} failOnError
  * @property {boolean=} failOnWarning
  * @property {string|string[]=} files
- * @property {string|string[]=} extensions
  * @property {boolean=} fix
  * @property {string|FormatterFunction=} formatter
  * @property {boolean=} lintDirtyModulesOnly
@@ -54,10 +55,11 @@ export type Options = {
   emitError?: boolean | undefined;
   emitWarning?: boolean | undefined;
   eslintPath?: string | undefined;
+  exclude?: (string | string[]) | undefined;
+  extensions?: (string | string[]) | undefined;
   failOnError?: boolean | undefined;
   failOnWarning?: boolean | undefined;
   files?: (string | string[]) | undefined;
-  extensions?: (string | string[]) | undefined;
   fix?: boolean | undefined;
   formatter?: (string | FormatterFunction) | undefined;
   lintDirtyModulesOnly?: boolean | undefined;