https://github.com/dolsem/eslint-plugin-filename-rules

https://github.com/dolsem/eslint-plugin-filename-rules

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/dolsem/eslint-plugin-filename-rules
• Owner: dolsem
• License: mit
• Created: 2020-08-11T21:31:42.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-13T20:19:18.000Z (about 2 years ago)
• Last Synced: 2024-11-13T19:46:58.489Z (about 2 months ago)
• Language: JavaScript
• Size: 227 KB
• Stars: 36
• Watchers: 3
• Forks: 8
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-plugin-filename-rules

Adds an ESLint rule to enforce filename conventions for linted files. Allows different options for different file extensions. Supports custom regular expressions.

[![NPM Version][npm-image]][npm-url]

[![NPM Downloads][downloads-image]][downloads-url]

[![Build Status][travis-image]][travis-url]

[![Coverage Status][coverage-image]][coverage-url]

[![License: MIT][license-image]][license-url]

## Installation

```bash

$ npm install -D eslint-plugin-filename-rules

```

Add it to your `.eslintrc.js`:

```js

module.exports = {

  plugins: [

    'filename-rules',

  ],

  rules: {

    'filename-rules/match': [2, 'camelcase'],

  },

};

```

## Plugin Options

The following built-in values are supported: `pascalcase`/`PascalCase`, `camelcase`/`camelCase`, `snakecase`/`snake_case`, `kebabcase`/`kebab-case`. You can also provide your own regex:

```js

...

'filename-rules/match': [2, /^([a-z]+-)*[a-z]+(?:\..*)?$/],

...

```

You can also specify different options for different file extensions. In this case the plugin will only check files with extensions you explicitly provided:

```js

...

'filename-rules/match': [2, { '.js': 'camelCase', '.ts': /^([a-z]+-)*[a-z]+(?:\..*)?$/ }],

...

```

You can use the `includePath: true` option to have the pattern matched against the full file path (instead of only the file basename):

```js

...

'filename-rules/match': [2, { includePath: true, pattern: /^([a-z]+-)*[a-z]+(?:\..*)?$/ }],

...

```

The inverse rule `not-match` checks that the files do NOT match the given pattern. Supports all the same options:

```js

...

'filename-rules/not-match': [2, 'camelCase'],

...

```

## License

MIT

[npm-image]: https://img.shields.io/npm/v/eslint-plugin-filename-rules.svg?style=flat-square

[npm-url]: https://npmjs.org/package/eslint-plugin-filename-rules

[downloads-image]: https://img.shields.io/npm/dm/eslint-plugin-filename-rules.svg?style=flat-square

[downloads-url]: https://npmjs.org/package/eslint-plugin-filename-rules

[travis-image]: https://img.shields.io/travis/dolsem/eslint-plugin-filename-rules.svg?style=flat-square

[travis-url]: https://travis-ci.org/dolsem/eslint-plugin-filename-rules

[coverage-image]: https://img.shields.io/coveralls/dolsem/eslint-plugin-filename-rules.svg?style=flat-square

[coverage-url]: https://coveralls.io/github/dolsem/eslint-plugin-filename-rules?branch=master

[license-image]: https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square

[license-url]: https://opensource.org/licenses/MIT