# eslint-config-nayya

> Shared JavaScript/TypeScript code styles

Latest version **0.7.0** (published 2022-04-11) · ISC license · 0 weekly downloads

## Install

```sh
npm install eslint-config-nayya
pnpm add eslint-config-nayya
yarn add eslint-config-nayya
bun add eslint-config-nayya
```

## 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.7.0 |
| Published | 2022-04-11 |
| First published | 2021-09-07 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 14.17.0 |
| Dependencies | 0 |
| Unpacked size | 4.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | nayya |
| Maintainers | nayya |

## Links

- npm: https://www.npmjs.com/package/eslint-config-nayya
- npm.io page: https://npm.io/package/eslint-config-nayya

## Recent versions

- 0.7.0 (latest) — 2022-04-11
- 0.2.6 — 2021-09-23
- 0.2.5 — 2021-09-23
- 0.2.4 — 2021-09-07
- 0.2.3 — 2021-09-07
- 0.2.2 — 2021-09-07
- 0.2.1 — 2021-09-07

## README

# Shared ESLint/Prettier/TypeScript configs

## How to use this config in your project

1. Install the package

    ```bash
    npx install-peerdeps --yarn --dev eslint-config-nayya
    ```

2. Create your `.eslintrc.js`

    ```javascript
    module.exports = { extends: 'eslint-config-nayya' };
    ```

3. Create your `.prettierrc.js`

    ```javascript
    module.exports = require('eslint-config-nayya/prettier.config');
    ```

4. Create your `tsconfig.json`

    ```json
    {
      "extends": "eslint-config-nayya/tsconfig.json",
      "include": ["src"]
    }
    ```

    NOTE: Replace ["src"] with the directory or directories that contain your TypeScript source.

5. If you get an error about not being able to find `tsconfig.json`, try this instead for `.eslintrc.js`:

    ```javascript
    const config = require('eslint-config-nayya');

    config.parserOptions.tsconfigRootDir = __dirname;

    module.exports = config;
    ```


## Development

Use `yarn link` or `yalc` to test changes locally.

Add tests in `test/` with the extension `.test.ts` or `.test.tsx`.

To run tests:

```bash
yarn test
```

NOTE: ESLint may output errors for files like `.eslintrc.js` in this repository. Use the `test/` directory to test the linting.

## Publishing

```bash
# To log in to npmjs.com
yarn login

# To publish a patch version
yarn publish --patch

# To publish a minor version
yarn publish --minor

# To publish a major version
yarn publish --major
```

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