# @code-rub/filter-files

> ## Usage

Latest version **1.3.1** (published 2022-05-04) · 0 weekly downloads

## Install

```sh
npm install @code-rub/filter-files
pnpm add @code-rub/filter-files
yarn add @code-rub/filter-files
bun add @code-rub/filter-files
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.1 |
| Published | 2022-05-04 |
| First published | 2021-12-19 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | agentender |

## Links

- npm: https://www.npmjs.com/package/@code-rub/filter-files
- npm.io page: https://npm.io/package/@code-rub/filter-files

## Recent versions

- 1.3.1 (latest) — 2022-05-04
- 1.3.0 — 2022-03-29
- 1.2.1 — 2022-02-10
- 1.2.0 — 2022-02-10
- 1.1.5 — 2021-12-19
- 1.1.4 — 2021-12-19
- 1.1.3 — 2021-12-19

## README

# @code-rub/filter-files plugin

## Usage

Install with npm or yarn:
- `npm i --save-dev @code-rub/filter-files`
- `yarn add --dev @code-rub/filter-files`

Setup inside of your code-rub.config.js file:
- Add `@code-rub/filter-files` to the plugins array.
- Add an entry to `pluginConfiguration` with `@code-rub/filter-files` as the key.
  - Set up any bannedFileNames, bannedGlobPatterns, and allowedFileTypes inside of the config. Below is an example configuration, as used in this repository.

```javascript
module.exports = {
  plugins: [
    '@code-rub/filter-files',
  ],
  pluginConfiguration: {
    '@code-rub/filter-files': {
      allowedFileExtensions: ['.ts', '.js'],
      bannedGlobPatterns: ['*.config.ts'],
      bannedFileNames: ['jest.config.js', 'code-rub.config.js', 'jest.preset.js'],
    },
  },
};
```

---
_Source: https://npm.io/package/@code-rub/filter-files · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._