# @youngcapital/eslint-config-yc-base

> eslint yc base has been created to use in any JS vanilla project with nodejs setup.

Latest version **3.0.1** (published 2020-09-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install @youngcapital/eslint-config-yc-base
pnpm add @youngcapital/eslint-config-yc-base
yarn add @youngcapital/eslint-config-yc-base
bun add @youngcapital/eslint-config-yc-base
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2020-09-02 |
| First published | 2020-01-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 4.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | YoungCapital |
| Maintainers | edwinb89, karsthammer, khen |

## Links

- npm: https://www.npmjs.com/package/@youngcapital/eslint-config-yc-base
- Repository: git@github.com:youngcapital/yc-linter
- npm.io page: https://npm.io/package/@youngcapital/eslint-config-yc-base

## Dependencies (4)

- [eslint-plugin-jest](https://npm.io/package/eslint-plugin-jest.md) ^23.13.2
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.20.1
- [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) ^3.1.3
- [eslint-config-airbnb-base](https://npm.io/package/eslint-config-airbnb-base.md) ^14.1.0

## Recent versions

- 3.0.1 (latest) — 2020-09-02
- 3.0.0 — 2020-09-02
- 2.0.1 — 2020-08-31
- 2.0.0 — 2020-06-24
- 1.2.1 — 2020-01-22
- 1.1.1 — 2020-01-17

## README

# eslint-config-yc-base

eslint yc base has been created to use in any JS vanilla project with nodejs setup.

It inherits some basic packages like:

- eslint-config-airbnb-base
- eslint-plugin-import
- eslint-plugin-jest
- eslint-plugin-prettier
- prettier

## Usage

### ESLint

- Make sure you have eslint >=6.8.0 installed according to the peerDependencies of this project
- Install the package
- Create `.eslintrc.js` on the root of your project
- Add the block of code below:
  ```
  module.exports = {
    extends: [
      '@youngcapital/eslint-config-yc-base'
    ]
  };
  ```
- Or you could also add `eslintConfig` tag on your package.json as below:
  ```
  {
    "eslintConfig": {
      "extends": "@youngcapital/eslint-config-yc-base"
    }
  }
  ```

### Prettier

- make sure you have correct prettier version (check `peerDependencies.prettier` in [package.json](package.json))
- install the package (e.g. `yarn add --dev @youngcapital/eslint-config-yc-base`)
- update your package.json to include

```json
{
  "prettier": "@youngcapital/eslint-config-yc-base/.prettierrc.js"
}
```

Please follow [official documentation](https://prettier.io/docs/en/configuration.html#sharing-configurations) for more details.

## Migrations

### to v.3

After upgrading your project to use v.3 of `@youngcapital/eslint-config-yc-base` you'll probably want to reformat the code in your repository.  
Please follow [this article](https://www.moxio.com/blog/43/ignoring-bulk-change-commits-with-git-blame) to achieve it in the least painful way.

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