# @skivvy/skivvy-package-eslint

> Lint source files using ESLint

Latest version **0.1.3** (published 2015-08-31) · ISC license · 0 weekly downloads

## Install

```sh
npm install @skivvy/skivvy-package-eslint
pnpm add @skivvy/skivvy-package-eslint
yarn add @skivvy/skivvy-package-eslint
bun add @skivvy/skivvy-package-eslint
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2015-08-31 |
| First published | 2015-05-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Tim Kendrick |
| Maintainers | skivvy, timkendrick |
| Keywords | skivvy-package, eslint, lint, linter |

## Links

- npm: https://www.npmjs.com/package/@skivvy/skivvy-package-eslint
- Repository: https://github.com/skivvyjs/skivvy-package-eslint
- Homepage: https://github.com/skivvyjs/skivvy-package-eslint#readme
- Issues: https://github.com/skivvyjs/skivvy-package-eslint/issues
- npm.io page: https://npm.io/package/@skivvy/skivvy-package-eslint

## Dependencies (1)

- [eslint](https://npm.io/package/eslint.md) ^1.0.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 0.1.3 (latest) — 2015-08-31
- 0.1.2 — 2015-08-31
- 0.1.1 — 2015-05-26
- 0.1.0 — 2015-05-26

## README

# Skivvy package: `eslint`
[![npm version](https://img.shields.io/npm/v/@skivvy/skivvy-package-eslint.svg)](https://www.npmjs.com/package/@skivvy/skivvy-package-eslint)
![Stability](https://img.shields.io/badge/stability-stable-brightgreen.svg)
[![Build Status](https://travis-ci.org/skivvyjs/skivvy-package-eslint.svg?branch=master)](https://travis-ci.org/skivvyjs/skivvy-package-eslint)

> Lint source files using ESLint


## Installation

```bash
skivvy install eslint
```


## Overview

This package allows you to lint JavaScript files using [ESLint](http://eslint.org/) from within the [Skivvy](https://www.npmjs.com/package/skivvy) task runner.


## Configuration settings:

| Name | Type | Required | Default | Description |
| ---- | ---- | -------- | ------- | ----------- |
| `user` | `string` | No | `"world"` | Username for example task |


## Included tasks

### `eslint`

Lint source files using ESLint

#### Usage:

```bash
skivvy run eslint
```


#### Configuration settings:

| Name | Type | Required | Default | Description |
| ---- | ---- | -------- | ------- | ----------- |
| `files` | `string` `Array<string>` | Yes | N/A | Files to lint |
| `options` | `object` | No | `{}` | [ESLint API](http://eslint.org/docs/developer-guide/nodejs-api#cliengine) options |
| `options.configFile` | `string` | No | `null` | The configuration file to use |
| `options.envs` | `Array<string>` | No | `null` | An array of environments to load |
| `options.extensions` | `Array<string>` | No | `[".js"]` | An array of filename extensions that should be checked for code |
| `options.globals` | `Array<string>` | No | `[]` | An array of global variables to declare |
| `options.ignore` | `boolean` | No | `true` | `false` disables use of `.eslintignore` |
| `options.ignorePath` | `string` | No | `null` | The ignore file to use instead of `.eslintignore` |
| `options.reset` | `boolean` | No | `false` | True disables all default rules and environments |
| `options.baseConfig` | `boolean` `object` | No | `null` | Set to `false` to disable use of base config. Could be set to an object to override default base config as well. |
| `options.rulePaths` | `Array<string>` | No | `[]` | An array of directories to load custom rules from |
| `options.rules` | `{}` | No | `null` | An object of rules to use |
| `options.useEslintrc` | `boolean` | No | `true` | Set to `false` to disable use of `.eslintrc` files |

---
_Source: https://npm.io/package/@skivvy/skivvy-package-eslint · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._