# eslint-plugin-filenames-simple

> An ESLint plugin to check filenames with simple configuration

Latest version **0.9.0** (published 2023-11-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-plugin-filenames-simple
pnpm add eslint-plugin-filenames-simple
yarn add eslint-plugin-filenames-simple
bun add eslint-plugin-filenames-simple
```

## 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.9.0 |
| Published | 2023-11-22 |
| First published | 2020-05-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=14.17.0 |
| Dependencies | 1 |
| Unpacked size | 45.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 56 |
| Author | epaew |
| Maintainers | epaew |
| Keywords | eslint, eslintPlugin, eslint-plugin, file, filename, simple |

## Links

- npm: https://www.npmjs.com/package/eslint-plugin-filenames-simple
- Repository: git@github.com:epaew/eslint-plugin-filenames-simple
- Homepage: https://github.com/epaew/eslint-plugin-filenames-simple
- npm.io page: https://npm.io/package/eslint-plugin-filenames-simple

## Dependencies (1)

- [pluralize](https://npm.io/package/pluralize.md) ^8.0.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 0.9.0 (latest) — 2023-11-22
- 0.8.0 — 2022-10-30
- 0.7.0 — 2021-11-07
- 0.6.0 — 2020-11-23
- 0.5.0 — 2020-10-17
- 0.4.0 — 2020-06-10
- 0.3.1 — 2020-06-06
- 0.3.0 — 2020-06-03
- 0.2.0 — 2020-05-30
- 0.1.1 — 2020-05-29
- 0.1.0 — 2020-05-29

## README

# ESLint plugin filenames simple

[![npm version](https://badge.fury.io/js/eslint-plugin-filenames-simple.svg)](https://badge.fury.io/js/eslint-plugin-filenames-simple)
[![Build Status](https://github.com/epaew/eslint-plugin-filenames-simple/workflows/Run%20Jest/badge.svg)](https://github.com/epaew/eslint-plugin-filenames-simple/actions?query=workflow%3A%22Run+Jest%22+branch%3A%22master%22)
[![Maintainability](https://api.codeclimate.com/v1/badges/964080f3d22b89b276d2/maintainability)](https://codeclimate.com/github/epaew/eslint-plugin-filenames-simple/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/964080f3d22b89b276d2/test_coverage)](https://codeclimate.com/github/epaew/eslint-plugin-filenames-simple/test_coverage)

An ESLint plugin to check filenames with simple configuration.  
This plugin is inspired by [eslint-plugin-filenames](https://github.com/selaux/eslint-plugin-filenames).

## Requirements

- [Node.js](https://nodejs.org/en/download/): >= 14.17
    - Unstable versions of Node.js are not actively supported.
- [ESLint](https://eslint.org/): 7.x, 8.x

## Getting started

1. Install ESLint and this plugin via npm/yarn

   - https://eslint.org/docs/user-guide/getting-started#installation-and-usage

   ```sh
   npm i --save-dev eslint eslint-plugin-filenames-simple
   # or
   yarn add -D eslint eslint-plugin-filenames-simple
   ```

2. Modify your `.eslintrc` file to load the plugin and enable the rules.

   ```javascript
   // select one of the following
   {
     "extends": [
       "plugin:filenames-simple/recommended"       // for pure ECMAScript/TypeScript project
       "plugin:filenames-simple/recommended-react" // for React.js project
       "plugin:filenames-simple/recommended-vue"   // for Vue.js project
     ]
   }
   ```

   ```javascript
   // or configure manually
   {
     "plugins": [
       "filenames-simple"
     ],
     "rules": {
       "filenames-simple/extension": "error",
       "filenames-simple/naming-convention": ["error", { "rule": "kebab-case" }]
     }
   }
   ```

3. Run ESLint and lint your codes.
   ```sh
   npm run eslint --ext .js .
   # or
   yarn run eslint --ext .js .
   ```

## Available rules

- [extension](./docs/rules/extension.md)
- [named-export](./docs/rules/named-export.md)
- [naming-convention](./docs/rules/naming-convention.md)
- [no-index](./docs/rules/no-index.md)
- [pluralize](./docs/rules/pluralize.md)
- [typescript-module-declaration](./docs/rules/typescript-module-declaration.md)

## CHANGELOG

[CHANGELOG](./CHANGELOG.md)

## LICENSE

[MIT](./LICENSE)

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