Skip to content

Commit

Permalink
docs(eslint-plugin): add missing rule to README (#593)
Browse files Browse the repository at this point in the history
* Fix eslint-plugin README

* Add change files

* Update change/@griffel-eslint-plugin-af581fe2-88f5-44cb-bb57-3d71b2cfcf03.json

---------

Co-authored-by: Oleksandr Fediashov <[email protected]>
  • Loading branch information
NotWoods and layershifter authored Aug 8, 2024
1 parent 83dc4f0 commit bdb268b
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"comment": "docs: update README",
"type": "none",
"packageName": "@griffel/eslint-plugin",
"email": "[email protected]",
"dependentChangeType": "patch"
}
13 changes: 7 additions & 6 deletions packages/eslint-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,10 @@ You can find more info about enabled rules in the [Supported Rules section](#sup

**Key**: 🔧 = fixable

| Name | Description | 🔧 |
| ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- | --- |
| [`@griffel/hook-naming`](./src/rules/hook-naming.md) | Ensure that hooks returned by the `makeStyles()` function start with "use" ||
| [`@griffel/no-shorthands`](./src/rules/no-shorthands.md) | Enforce usage of CSS longhands ||
| [`@griffel/styles-file`](./src/rules/styles-file.md) | Ensures that all `makeStyles()` and `makeResetStyles()` calls are placed in a `.styles.js` or `.styles.ts` file ||
| [`@griffel/pseudo-element-naming`](./src/rules/pseudo-element-naming.md) | Ensures that all Pseudo Elements start with two colons ||
| Name | Description | 🔧 |
| ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- | --- |
| [`@griffel/hook-naming`](./src/rules/hook-naming.md) | Ensure that hooks returned by the `makeStyles()` function start with "use" ||
| [`@griffel/no-invalid-shorthand-arguments`](./src/rules/no-invalid-shorthand-arguments.md) | All shorthands must not use space separators, and instead pass in multiple arguments ||
| [`@griffel/no-shorthands`](./src/rules/no-shorthands.md) | Enforce usage of CSS longhands ||
| [`@griffel/styles-file`](./src/rules/styles-file.md) | Ensures that all `makeStyles()` and `makeResetStyles()` calls are placed in a `.styles.js` or `.styles.ts` file ||
| [`@griffel/pseudo-element-naming`](./src/rules/pseudo-element-naming.md) | Ensures that all Pseudo Elements start with two colons ||

0 comments on commit bdb268b

Please sign in to comment.