Skip to content

Commit c66ea20

Browse files
authored
release: version 2025.5.13 (#26)
1 parent 3d2ebe8 commit c66ea20

File tree

4 files changed

+46
-16
lines changed

4 files changed

+46
-16
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,35 @@
88

99
`Style-Forge.Colors` is an atomic CSS palette generator based on the HSL color model. Generate exactly the colors you need — programmatically, interactively, or by name. Perfect for design systems, theming, and scalable UIs.
1010

11+
## 🚀 Quick Start
12+
13+
```bash
14+
npx sf.color
15+
```
16+
17+
or use the full name:
18+
19+
```bash
20+
npx style-forge.colors
21+
```
22+
23+
## ✨ What you can do
24+
* 🎨 Generate atomic HSL-based CSS color files
25+
* ⚙️ Run fully in terminal — no JavaScript or framework required
26+
* 🔁 Combine selected .css files into a palette
27+
* 📦 Use in Tailwind, Vue, React, Svelte, or raw CSS
28+
29+
## 🎨 Supported Input Formats
30+
31+
| Format | Example Input | Example Output |
32+
|--------|-------------------|--------------------------|
33+
| `HSL` | `259 100 42` | `hsl(259, 100%, 42%)` |
34+
| `RGB` | `120 200 255` | `rgb(120, 200, 255)` |
35+
| `HEX` | `#FF00AA` | `#ff00aa` |
36+
37+
You can use any of the above formats when generating a color CSS file.
38+
The output includes a fully scoped, theme-aware CSS module for light, dark, and auto modes.
39+
1140
## 🎯 Modifier Suffixes
1241

1342
Style-Forge Colors provides utility modifiers to fine-tune element behavior:

generators/styleBlocks.js

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,13 @@ export function generateSingleColorCSS(H, S, L) {
2525
lines.push(`${SELECTOR}, ${SELECTOR}\\:st { color: ${LUM}; background-color: ${HSL} }`)
2626

2727
// Text
28-
// lines.push(`${SELECTOR}\\:txt { color: hsl(${H}, ${S}%, ${L > 50 ? 10 : L}%) }`)
2928
lines.push(`${SELECTOR}\\:txt, ${SELECTOR}\\:txt\\:st, ${SELECTOR}\\:txt\\:rv { color: ${HSL} }`)
3029

3130
lines.push('')
3231

3332
// dark
3433
lines.push(`html[data-theme='dark'] ${SELECTOR}, html.dark ${SELECTOR} { color: ${TX_LUM_REV}; background-color: ${BG_LUM_REV} }`)
3534
lines.push(`html[data-theme='dark'] ${SELECTOR}\\:st, html.dark ${SELECTOR}\\:st { color: ${LUM}; background-color: ${HSL} }`)
36-
// lines.push(`html[data-theme='dark'] ${SELECTOR}\\:txt, html.dark ${SELECTOR}\\:txt { color: hsl(${H}, ${S}%, ${L < 50 ? 100 - L : L}%) }`)
3735
lines.push(`html[data-theme='dark'] ${SELECTOR}\\:txt, html.dark ${SELECTOR}\\:txt { color: hsl(${H}, ${S}%, ${90}%) }`)
3836
lines.push(`html[data-theme='dark'] ${SELECTOR}\\:txt\\:st, html.dark ${SELECTOR}\\:txt\\:st { color: ${HSL} }`)
3937
lines.push(`html[data-theme='dark'] ${SELECTOR}\\:txt\\:rv, html.dark ${SELECTOR}\\:txt\\:rv { color: hsl(${H}, ${S}%, ${10}%) }`)
@@ -44,7 +42,6 @@ export function generateSingleColorCSS(H, S, L) {
4442
lines.push(`@media (prefers-color-scheme: dark) {`)
4543
lines.push(` html[data-theme='auto'] ${SELECTOR}, html.auto ${SELECTOR} { color: ${TX_LUM_REV}; background-color: ${BG_LUM_REV} }`)
4644
lines.push(` html[data-theme='auto'] ${SELECTOR}\\:st, html.auto ${SELECTOR}\\:st { color: ${LUM}; background-color: ${HSL} }`)
47-
// lines.push(` html[data-theme='auto'] ${SELECTOR}\\:txt, html.auto ${SELECTOR}\\:txt { color: hsl(${H}, ${S}%, ${L < 50 ? 100 - L : L}%) }`)
4845
lines.push(` html[data-theme='auto'] ${SELECTOR}\\:txt, html.auto ${SELECTOR}\\:txt { color: hsl(${H}, ${S}%, ${90}%) }`)
4946
lines.push(` html[data-theme='auto'] ${SELECTOR}\\:txt\\:st, html.auto ${SELECTOR}\\:txt\\:st { color: ${HSL} }`)
5047
lines.push(` html[data-theme='auto'] ${SELECTOR}\\:txt\\:rv, html.auto ${SELECTOR}\\:txt\\:rv { color: hsl(${H}, ${S}%, ${10}%) }`)

main.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,10 @@ async function main() {
3333
},
3434
])
3535

36-
if (mode === 'Exit') process.exit(0)
36+
if (mode === '🚪 Exit') {
37+
console.log('\n👋 Bye!')
38+
process.exit(0)
39+
}
3740

3841
let format = config.defaultFormat || 'HSL'
3942

package.json

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
{
22
"name": "style-forge.colors",
3-
"version": "2025.5.12",
4-
"description": "Style-Forge Colors CLI: atomic HSL-based color palette generator and CSS module for scalable design systems.",
3+
"version": "2025.5.13",
4+
"description": "Style-Forge Colors: atomic HSL-based color palette generator and CSS module for scalable design systems.",
55
"type": "module",
66
"bin": {
7-
"style-forge.colors": "./main.js"
7+
"style-forge.colors": "./main.js",
8+
"sf.colors": "./main.js"
89
},
910
"repository": {
1011
"type": "git",
@@ -15,16 +16,16 @@
1516
"keywords": [
1617
"style-forge",
1718
"colors",
18-
"color palettes",
19+
"color-palettes",
1920
"theme",
20-
"HSL",
21-
"CSS generator",
22-
"frontend",
23-
"design system",
24-
"atomic CSS",
25-
"CLI",
26-
"UI",
27-
"web design"
21+
"hsl",
22+
"css-generator",
23+
"frontend-development",
24+
"design-system",
25+
"atomic-css",
26+
"cli",
27+
"web-design",
28+
"ui"
2829
],
2930
"dependencies": {
3031
"chalk": "^5.4.1",

0 commit comments

Comments
 (0)