Skip to content

Commit

Permalink
docs: update docs for rule filename-naming-convention
Browse files Browse the repository at this point in the history
  • Loading branch information
dukeluo authored and milos-sikic-nimbus-tech committed Jul 5, 2023
1 parent 4421d1f commit d5be3b1
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/rules/filename-naming-convention.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Allows you to enforce a consistent naming pattern for the filename of the specif

## Rule Details

This rule aims to format the filename of the specified file. This rule uses the glob match syntax to match a file and declare the naming pattern for the filename.
This rule aims to format the filename of the specified file. This rule uses the glob match syntax to match target files and declare the naming pattern for the filename.

There are six naming conventions built into this rule, including `CAMEL_CASE`, `PASCAL_CASE`, `SNAKE_CASE`, `KEBAB_CASE`, `SCREAMING_SNAKE_CASE` and `FLAT_CASE`.

Expand Down Expand Up @@ -80,7 +80,7 @@ src/Portal/Portal.types.ts

#### naming pattern object

You need to specify a different naming pattern for different file. The plugin will only check files you explicitly selected:
The key is used to select target files, while the value is used to declare the naming pattern for the filename. You can specify a different naming pattern for different files. The plugin will only check files you explicitly selected:

```js
module.exports = {
Expand Down

0 comments on commit d5be3b1

Please sign in to comment.