<commit_before># eslint-config-algolia

[![Version][version-svg]][package-url] [![Build Status][travis-svg]][travis-url] [![License][license-image]][license-url] [![Downloads][downloads-image]][downloads-url]

This is [Algolia](https://www.algolia.com/)'s [ESLint](http://eslint.org/) configuration.


<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**

- [Usage](#usage)
- [Ignoring files](#ignoring-files)
- [Using as a global eslint config](#using-as-a-global-eslint-config)
- [Test](#test)
- [Release](#release)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Usage

```sh
npm install eslint-config-algolia --save-dev
```

create an `.eslintrc.js` file:
```js
module.exports = {
  "extends": ["algolia"]
};
```

### Jasmine

We have a specific set of rules if you are using [Jasmine](https://jasmine.github.io/) (or [Jest](https://facebook.github.io/jest/)).

create an `.eslintrc.js` file:
```js
module.exports = {
  "extends": ["algolia", "algolia/jasmine"]
};
```

### Tips

If you are using [any editors plugin](http://eslint.org/docs/user-guide/integrations.html#editors) for ESLint then it will show you warnings/errors.

Also activate fix errors on save in your editor. ESLint is able to fix many errors for you given your ESLint configuration.

Now you can create an npm `lint` [script](https://docs.npmjs.com/files/package.json#scripts) that will run `eslint .` to lint all files.

## Ignoring files
<commit_msg>docs(deps): force installation of eslint*<commit_after># eslint-config-algolia

[![Version][version-svg]][package-url] [![Build Status][travis-svg]][travis-url] [![License][license-image]][license-url] [![Downloads][downloads-image]][downloads-url]

This is [Algolia](https://www.algolia.com/)'s [ESLint](http://eslint.org/) configuration.


<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**

- [Usage](#usage)
- [Ignoring files](#ignoring-files)
- [Using as a global eslint config](#using-as-a-global-eslint-config)
- [Test](#test)
- [Release](#release)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Usage

```sh
npm install eslint-config-algolia babel-eslint eslint eslint-import-resolver-webpack eslint-plugin-import eslint-plugin-jasmine eslint-plugin-react --save-dev
```

create an `.eslintrc.js` file:
```js
module.exports = {
  "extends": ["algolia"]
};
```

### Jasmine

We have a specific set of rules if you are using [Jasmine](https://jasmine.github.io/) (or [Jest](https://facebook.github.io/jest/)).

create an `.eslintrc.js` file:
```js
module.exports = {
  "extends": ["algolia", "algolia/jasmine"]
};
```

### Tips

If you are using [any editors plugin](http://eslint.org/docs/user-guide/integrations.html#editors) for ESLint then it will show you warnings/errors.

Also activate fix errors on save in your editor. ESLint is able to fix many errors for you given your ESLint configuration.

Now you can create an npm `lint` [script](https://docs.npmjs.com/files/package.json#scripts) that will run `eslint .` to lint all files.

## Ignoring files

{'fraction_non_alphanumeric': 0.16585956416464892, 'fraction_numerical': 0.0, 'mean_word_length': 4.536013400335008, 'pattern_counts': {'":': 4, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 8, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2029949', 'n_tokens_mistral': 1147, 'n_tokens_neox': 1077, 'n_words': 316}