Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize package file name exports #4700

Merged
merged 11 commits into from
Jan 17, 2025
Merged

Standardize package file name exports #4700

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f7befa8
Pull in updated color names
taysea Jan 15, 2025
5cc62ce
Create good-gorillas-suffer.md
taysea Jan 16, 2025
18f7e5d
Merge branch 'master' into update-color-names
taysea Jan 16, 2025
cc68e5a
Merge branch 'update-color-names' of github.com:grommet/hpe-design-sy…
taysea Jan 16, 2025
6584232
Rename primitive mode from base to default, update file exports from …
taysea Jan 16, 2025
933c718
Remove default from component file export names
taysea Jan 16, 2025
110bbd3
Remove unneeded modes for color and dimension ESM/CommonJS exports
taysea Jan 16, 2025
a9dcb58
Create cuddly-elephants-happen.md
taysea Jan 16, 2025
63b4ef4
Merge branch 'master' into standardize-file-names
taysea Jan 16, 2025
f90d9b7
Merge branch 'standardize-file-names' of github.com:grommet/hpe-desig…
taysea Jan 16, 2025
2f5f7b2
Merge branch 'master' into standardize-file-names
taysea Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/cuddly-elephants-happen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"hpe-design-tokens": minor
---

- Renamed exports from "base" to "primitives" (e.g., "base.css" --> "primitives.css").
- Removed "default" from CJS/ESM component token exports (e.g., "components.default.cjs" --> "components.js"). No effect on import.
- Removed light/dark, medium/small modes from ESM/CommonJS exports. Because these now return CSS variable refs, we don't need separate mode exports. (e.g., "color.light.js" --> "color.js").
4 changes: 2 additions & 2 deletions aries-site/src/pages/design-tokens/all-design-tokens.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@ const structuredTokens = {
};

Object.keys(tokens).forEach(mode => {
// base, component, light, dark, etc.
// primitives, component, light, dark, etc.
Object.keys(tokens[mode]).forEach(token => {
const currentToken = tokens[mode][token];

const parts = token.split('.');
const category = parts[1];
let level;
if (mode === 'base') level = 'primitive';
if (mode === 'primitives') level = 'primitive';
else if (mode === 'components') level = 'component';
else level = 'semantic';

Expand Down
38 changes: 17 additions & 21 deletions design-tokens/src/scripts/build-style-dictionary.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ let extendedDictionary = HPEStyleDictionary;
* ----------------------------------- */
try {
extendedDictionary = await HPEStyleDictionary.extend({
source: [`${TOKENS_DIR}/primitive/primitives.base.json`],
source: [`${TOKENS_DIR}/primitive/primitives.default.json`],
platforms: {
grommet: {
transformGroup: 'js/w3c',
buildPath: GROMMET_DIR,
prefix: PREFIX,
files: [
{
destination: 'base.js',
destination: 'primitives.js',
format: 'javascript/esm',
},
],
Expand All @@ -39,7 +39,7 @@ try {
prefix: PREFIX,
files: [
{
destination: 'base.js',
destination: 'primitives.js',
format: 'javascript/esm',
},
],
Expand All @@ -50,7 +50,7 @@ try {
prefix: PREFIX,
files: [
{
destination: 'base.cjs',
destination: 'primitives.cjs',
format: 'javascript/commonJs',
},
],
Expand All @@ -61,7 +61,7 @@ try {
prefix: PREFIX,
files: [
{
destination: 'base.css',
destination: 'primitives.css',
format: 'css/variables',
options: {
outputReferences: true,
Expand All @@ -73,7 +73,7 @@ try {
transformGroup: 'js/w3c',
buildPath: DOCS_DIR,
prefix: PREFIX,
files: [{ destination: 'base.js', format: 'jsonFlat' }],
files: [{ destination: 'primitives.js', format: 'jsonFlat' }],
},
},
});
Expand All @@ -88,7 +88,7 @@ try {
try {
extendedDictionary = await HPEStyleDictionary.extend({
source: [
`${TOKENS_DIR}/primitive/primitives.base.json`,
`${TOKENS_DIR}/primitive/primitives.default.json`,
`${TOKENS_DIR}/semantic/color.light.json`, // using light mode to have a reference name available
`${TOKENS_DIR}/semantic/global.default.json`,
],
Expand Down Expand Up @@ -186,7 +186,7 @@ try {
colorModeFiles.forEach(async file => {
const [theme, mode] = getThemeAndMode(file);
extendedDictionary = await HPEStyleDictionary.extend({
source: [`${TOKENS_DIR}/primitive/primitives.base.json`, file],
source: [`${TOKENS_DIR}/primitive/primitives.default.json`, file],
platforms: {
grommet: {
transformGroup: 'js/w3c',
Expand All @@ -208,9 +208,7 @@ try {
prefix: PREFIX,
files: [
{
destination: `color.${
theme ? `${theme}-${mode}` : `${mode || ''}`
}.js`,
destination: 'color.js',
format: 'javascript/esm',
filter: token => token.filePath === file,
},
Expand All @@ -222,9 +220,7 @@ try {
prefix: PREFIX,
files: [
{
destination: `color.${
theme ? `${theme}-${mode}` : `${mode || ''}`
}.cjs`,
destination: 'color.cjs',
format: 'javascript/commonJs',
filter: token => token.filePath === file,
},
Expand Down Expand Up @@ -288,7 +284,7 @@ try {
const mode = res[1];
extendedDictionary = await HPEStyleDictionary.extend({
source: [
`${TOKENS_DIR}/primitive/primitives.base.json`,
`${TOKENS_DIR}/primitive/primitives.default.json`,
`${TOKENS_DIR}/semantic/color.light.json`,
`${TOKENS_DIR}/semantic/global.default.json`,
file,
Expand All @@ -312,7 +308,7 @@ try {
prefix: PREFIX,
files: [
{
destination: `dimension.${mode}.js`,
destination: 'dimension.js',
format: 'javascript/esm',
filter: token => token.filePath === file,
},
Expand All @@ -324,7 +320,7 @@ try {
prefix: PREFIX,
files: [
{
destination: `dimension.${mode}.cjs`,
destination: 'dimension.cjs',
format: 'javascript/commonJs',
filter: token => token.filePath === file,
},
Expand Down Expand Up @@ -378,7 +374,7 @@ try {
try {
extendedDictionary = await HPEStyleDictionary.extend({
source: [
`${TOKENS_DIR}/primitive/primitives.base.json`,
`${TOKENS_DIR}/primitive/primitives.default.json`,
`${TOKENS_DIR}/semantic/global.default.json`,
`${TOKENS_DIR}/semantic/color.light.json`, // using light mode to have a reference name available
`${TOKENS_DIR}/semantic/dimension.medium.json`, // using medium mode to have a reference name available
Expand All @@ -392,7 +388,7 @@ try {
prefix: PREFIX,
files: [
{
destination: 'components.default.js',
destination: 'components.js',
filter: token =>
token.filePath.includes(`${TOKENS_DIR}/component/`),
format: 'esmGrommetRefs',
Expand All @@ -405,7 +401,7 @@ try {
prefix: PREFIX,
files: [
{
destination: 'components.default.js',
destination: 'components.js',
filter: token =>
token.filePath.includes(`${TOKENS_DIR}/component/`),
format: 'esmGrommetRefs',
Expand All @@ -418,7 +414,7 @@ try {
prefix: PREFIX,
files: [
{
destination: 'components.default.cjs',
destination: 'components.cjs',
filter: token =>
token.filePath.includes(`${TOKENS_DIR}/component/`),
format: 'javascript/commonJs',
Expand Down
0 ...ens/tokens/primitive/primitives.base.json → .../tokens/primitive/primitives.default.json
View file
Open in desktop
File renamed without changes.
24 changes: 12 additions & 12 deletions design-tokens/tokens/semantic/color.dark.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,12 +137,12 @@
}
}
},
"ok": {
"info": {
"DEFAULT": {
"REST": {
"$type": "color",
"$value": "{base.color.green.500-Opacity30}",
"$description": "Use for backgrounds communicating success.",
"$value": "{base.color.blue.400-Opacity12}",
"$description": "Use for backgrounds communicating neutral information.",
"$extensions": {
"com.figma": {
"hiddenFromPublishing": false,
Expand All @@ -153,12 +153,12 @@
}
}
},
"critical": {
"unknown": {
"DEFAULT": {
"REST": {
"$type": "color",
"$value": "{base.color.red.800-Opacity30}",
"$description": "Use for backgrounds communicating errors or danger.",
"$value": "{base.color.white.opacity6}",
"$description": "Use for backgrounds communicating an unknown status.",
"$extensions": {
"com.figma": {
"hiddenFromPublishing": false,
Expand All @@ -169,12 +169,12 @@
}
}
},
"unknown": {
"critical": {
"DEFAULT": {
"REST": {
"$type": "color",
"$value": "{base.color.white.opacity6}",
"$description": "Use for backgrounds communicating an unknown status.",
"$value": "{base.color.red.800-Opacity30}",
"$description": "Use for backgrounds communicating errors or danger.",
"$extensions": {
"com.figma": {
"hiddenFromPublishing": false,
Expand All @@ -185,12 +185,12 @@
}
}
},
"info": {
"ok": {
"DEFAULT": {
"REST": {
"$type": "color",
"$value": "{base.color.blue.400-Opacity12}",
"$description": "Use for backgrounds communicating neutral information.",
"$value": "{base.color.green.500-Opacity30}",
"$description": "Use for backgrounds communicating success.",
"$extensions": {
"com.figma": {
"hiddenFromPublishing": false,
Expand Down
24 changes: 12 additions & 12 deletions design-tokens/tokens/semantic/color.light.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,12 +137,12 @@
}
}
},
"ok": {
"info": {
"DEFAULT": {
"REST": {
"$type": "color",
"$value": "{base.color.green.400-Opacity24}",
"$description": "Use for backgrounds communicating success.",
"$value": "{base.color.blue.400-Opacity24}",
"$description": "Use for backgrounds communicating neutral information.",
"$extensions": {
"com.figma": {
"hiddenFromPublishing": false,
Expand All @@ -153,12 +153,12 @@
}
}
},
"critical": {
"unknown": {
"DEFAULT": {
"REST": {
"$type": "color",
"$value": "{base.color.red.500-Opacity24}",
"$description": "Use for backgrounds communicating errors or danger.",
"$value": "{base.color.black.opacity4}",
"$description": "Use for backgrounds communicating an unknown status.",
"$extensions": {
"com.figma": {
"hiddenFromPublishing": false,
Expand All @@ -169,12 +169,12 @@
}
}
},
"unknown": {
"critical": {
"DEFAULT": {
"REST": {
"$type": "color",
"$value": "{base.color.black.opacity4}",
"$description": "Use for backgrounds communicating an unknown status.",
"$value": "{base.color.red.500-Opacity24}",
"$description": "Use for backgrounds communicating errors or danger.",
"$extensions": {
"com.figma": {
"hiddenFromPublishing": false,
Expand All @@ -185,12 +185,12 @@
}
}
},
"info": {
"ok": {
"DEFAULT": {
"REST": {
"$type": "color",
"$value": "{base.color.blue.400-Opacity24}",
"$description": "Use for backgrounds communicating neutral information.",
"$value": "{base.color.green.400-Opacity24}",
"$description": "Use for backgrounds communicating success.",
"$extensions": {
"com.figma": {
"hiddenFromPublishing": false,
Expand Down
Loading