Skip to content

Commit c04c0df

Browse files
committed
update readme and changelog ui
1 parent d8b9ca4 commit c04c0df

2 files changed

Lines changed: 32 additions & 12 deletions

File tree

packages/ui/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
44
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
55

6-
## [2.0.0] - 2026-03-19
6+
## [2.0.0] - 2026-03-30
77

88
### Changed
99
- ESLint config now exported as an array to support global `ignores`

packages/ui/README.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,30 +20,48 @@ npm install -D @hystax/eslint-config-ui
2020
In your project’s _eslint.config.mjs_, import and use the shared configuration.
2121

2222
Basic example (UI project)
23+
2324
```javascript
2425
import config from "@hystax/eslint-config-ui";
26+
27+
// The config is an array; the first element contains global ignore
2528
export default config;
2629
```
2730

28-
You can also use an array form if you plan to combine multiple configs:
31+
### 🧩 Combining with other configs or local overrides
2932

3033
```javascript
3134
import config from "@hystax/eslint-config-ui";
32-
export default [config];
35+
export default [
36+
...config,
37+
{
38+
// Add or override rules here
39+
rules: {
40+
"no-console": "warn",
41+
"import/order": [
42+
"error",
43+
{ groups: ["builtin", "external", "internal"] },
44+
],
45+
},
46+
},
47+
];
3348
```
3449

35-
### 🧩 Override file globs or rules
50+
### 🧩 Add or override global ignores
51+
3652
```javascript
3753
import config from "@hystax/eslint-config-ui";
54+
55+
const globalIgnores = config[0];
56+
const configRules = config.slice(1);
57+
3858
export default [
3959
{
40-
...config,
41-
files: ["src/**/*.{ts,tsx}"],
42-
rules: {
43-
...config.rules,
44-
"no-console": "warn"
45-
}
46-
}
60+
// Extend existing global ignores or override them
61+
...globalIgnores,
62+
ignores: [...(globalIgnores.ignores || []), "./dist"],
63+
},
64+
...configRules,
4765
];
4866
```
4967

@@ -55,6 +73,8 @@ export default [
5573

5674
- Designed for consistency across all Hystax frontend projects.
5775

76+
- The first element of the exported array contains global ignores, so it’s important to spread the array if adding additional rules.
77+
5878
## 📄 License
5979

60-
[Apache License Version 2.0](https://choosealicense.com/licenses/apache-2.0/)
80+
[Apache License Version 2.0](https://choosealicense.com/licenses/apache-2.0/)

0 commit comments

Comments
 (0)