mirror of
https://github.com/antebudimir/eslint-plugin-vanilla-extract.git
synced 2025-12-31 08:53:33 +00:00
docs 📝: update milestones
This commit is contained in:
parent
f2ad87c882
commit
8916be7d16
3 changed files with 14 additions and 8 deletions
18
README.md
18
README.md
|
|
@ -2,8 +2,7 @@
|
||||||
|
|
||||||
[](https://www.npmjs.com/package/@antebudimir/eslint-plugin-vanilla-extract)
|
[](https://www.npmjs.com/package/@antebudimir/eslint-plugin-vanilla-extract)
|
||||||
|
|
||||||
An ESLint plugin for enforcing CSS ordering in [vanilla-extract](https://github.com/vanilla-extract-css/vanilla-extract) css styles. Available presets are for alphabetical and
|
An ESLint plugin for enforcing best practices in [vanilla-extract](https://github.com/vanilla-extract-css/vanilla-extract) CSS styles, including CSS property ordering and additional linting rules. Available presets are for alphabetical and [concentric](https://rhodesmill.org/brandon/2011/concentric-css/) CSS ordering. The plugin also supports a custom group ordering option based on groups available in [concentric CSS](src/css-rules/concentric-order/concentric-groups.ts).
|
||||||
[concentric](https://rhodesmill.org/brandon/2011/concentric-css/) CSS ordering. The plugin also supports a custom group ordering option based on groups available in concentric CSS.
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
|
|
@ -16,6 +15,7 @@ An ESLint plugin for enforcing CSS ordering in [vanilla-extract](https://github.
|
||||||
- Handles multiple vanilla-extract APIs (style, styleVariants, recipe, globalStyle, etc.)
|
- Handles multiple vanilla-extract APIs (style, styleVariants, recipe, globalStyle, etc.)
|
||||||
- Handles complex cases like nested objects, arrays of styles, and pseudo selectors
|
- Handles complex cases like nested objects, arrays of styles, and pseudo selectors
|
||||||
- Works with camelCase properties as used in vanilla-extract
|
- Works with camelCase properties as used in vanilla-extract
|
||||||
|
- Additional linting rules for enhanced code quality (see roadmap for upcoming features)
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
|
|
@ -182,7 +182,7 @@ export const myStyle = style({
|
||||||
|
|
||||||
## Concentric CSS Model
|
## Concentric CSS Model
|
||||||
|
|
||||||
Here's a list of all available groups from the provided concentricGroups array:
|
Here's a list of all available groups from the provided [concentricGroups](src/css-rules/concentric-order/concentric-groups.ts) array:
|
||||||
|
|
||||||
1. boxSizing
|
1. boxSizing
|
||||||
2. position
|
2. position
|
||||||
|
|
@ -228,12 +228,18 @@ The roadmap outlines the project's current status and future plans:
|
||||||
|
|
||||||
### Current Work
|
### Current Work
|
||||||
|
|
||||||
- Compatibility testing to determine if the plugin works with ESLint v8. **Note**: There are no plans to ensure compatibility if issues arise. Upcoming features will be prioritized.
|
- `fontFace` and `globalFontFace` linting support.
|
||||||
|
|
||||||
### Upcoming Features
|
### Upcoming Features
|
||||||
|
|
||||||
- Begin work on test coverage.
|
- Test coverage.
|
||||||
- Support for additional vanilla-extract APIs, including `fontFace`, `globalFontFace`.
|
- `no-empty-blocks` rule to disallow empty blocks.
|
||||||
|
- `no-unknown-units` rule to disallow unknown units.
|
||||||
|
- `no-number-trailing-zeros` rule to disallow trailing zeros in numbers.
|
||||||
|
- `no-zero-unit` rule to disallow units when the value is zero.
|
||||||
|
- `np-px-unit` rule to disallow use of `px` units with configurable whitelist.
|
||||||
|
- `prefer-logical-properties` rule to enforce use of logical properties.
|
||||||
|
- `prefer-theme-tokens` rule to enforce use of theme tokens instead of hard-coded values when available.
|
||||||
- Option to sort properties within user-defined concentric groups alphabetically instead of following the concentric order. **Note**: This feature will only be implemented if there's sufficient interest from the community.
|
- Option to sort properties within user-defined concentric groups alphabetically instead of following the concentric order. **Note**: This feature will only be implemented if there's sufficient interest from the community.
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "@antebudimir/eslint-plugin-vanilla-extract",
|
"name": "@antebudimir/eslint-plugin-vanilla-extract",
|
||||||
"version": "1.3.0",
|
"version": "1.3.1",
|
||||||
"description": "ESLint plugin for enforcing CSS ordering in vanilla-extract styles",
|
"description": "ESLint plugin for enforcing CSS ordering in vanilla-extract styles",
|
||||||
"author": "Ante Budimir",
|
"author": "Ante Budimir",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,7 @@ import customOrderRule from './css-rules/custom-order/rule-definition.js';
|
||||||
export const vanillaExtract = {
|
export const vanillaExtract = {
|
||||||
meta: {
|
meta: {
|
||||||
name: '@antebudimir/eslint-plugin-vanilla-extract',
|
name: '@antebudimir/eslint-plugin-vanilla-extract',
|
||||||
version: '1.3.0',
|
version: '1.3.1',
|
||||||
},
|
},
|
||||||
rules: {
|
rules: {
|
||||||
'alphabetical-order': alphabeticalOrderRule,
|
'alphabetical-order': alphabeticalOrderRule,
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue