---
category: packages
---

## ui-eslint-config

[![npm][npm]][npm-url] 
[![MIT License][license-badge]][license] 
[![Code of Conduct][coc-badge]][coc]

A shared eslint config made by Instructure Inc.

### Installation

```sh
npm install @instructure/ui-eslint-config
```

### Usage

In your eslint config file:

```js
/* .eslintrc.js */
module.exports = require('@instructure/ui-eslint-config')
```

[npm]: https://img.shields.io/npm/v/@instructure/ui-eslint-config.svg
[npm-url]: https://npmjs.com/package/@instructure/ui-eslint-config
[license-badge]: https://img.shields.io/npm/l/instructure-ui.svg?style=flat-square
[license]: https://github.com/instructure/instructure-ui/blob/master/LICENSE
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://github.com/instructure/instructure-ui/blob/master/CODE_OF_CONDUCT.md