https://github.com/borysshulyak/eslint-disable-files

The package that would help you to add the `/* eslint-disable */` for each file
https://github.com/borysshulyak/eslint-disable-files

eslint utils

Last synced: 26 days ago
JSON representation

The package that would help you to add the `/* eslint-disable */` for each file

• Host: GitHub
• URL: https://github.com/borysshulyak/eslint-disable-files
• Owner: BorysShulyak
• License: mit
• Created: 2023-06-19T09:45:54.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-12T03:14:34.000Z (about 1 year ago)
• Last Synced: 2024-10-28T16:56:18.418Z (3 months ago)
• Topics: eslint, utils
• Language: JavaScript
• Homepage:
• Size: 763 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# eslint-disable-files

## Table of Contents

- [✨ Features](#-features)

- [🦾 Installation](#-installation)

- [♾️Usage](#-usage)

- [⚙️ API](#-api)

- [🛠️ Contributing](#-contributing)

- [🗺️ Roadmap](#-roadmap)

- [❤️Support or Donate](#-support-or-donate)

- [💕Special Thanks](#-special-thanks)

## ✨ Features

- Add `/* eslint-disable */` for all the files.

## 🦾 Installation

```bash

yarn add @borisshulyak/eslint-disable-files@latest

```

**OR**

```bash

npm install @borisshulyak/eslint-disable-files@latest

```

## ♾️ Usage

- Create a temporary file `tempEslintDisableFiles.js` in some folder.

- Paste the following code to the file:

```javascript

import { eslintDisableFiles } from '@borisshulyak/eslint-disable-files';

eslintDisableFiles()

```

- Run the file with Node.js from any folder.

- All the files by the following pattern `/\.[cm]?[jt]sx?$/` in the current folder would have the `/* eslint-disable */` as the first line.

## ⚙️ API

`eslintDisableFiles` - method with the following arguments:

| Argument | Type | Default |

| --- | --- | --- |

| `rootDir` | String | `‘./’` |

| `pattern` | RegExp | `/\.[cm]?[jt]sx?$/` |

## 🛠️ Contributing

See the [CONTRIBUTING.md](https://github.com/BorysShulyak/eslint-disable-files/blob/main/CONTRIBUTING.md)document.

## 🗺️ Roadmap

- Create the backward method `eslintEnableFile`

## ❤️ Support or Donate

If you are enjoying this plugin and feel extra appreciative, you could [buy me a book](https://bmc.link/borisshulyak)

📖 or 3 📖📖📖.

## 💕 Special Thanks

- I want to say thank you to**my wife Diana**for her love, daily support, motivation and inspiration.