Skip to content

Commit

Permalink
feat: add convert to DTCG spec utility WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
jorenbroekema committed May 15, 2024
1 parent 96439c7 commit fec4ae4
Show file tree
Hide file tree
Showing 3 changed files with 406 additions and 0 deletions.
350 changes: 350 additions & 0 deletions __tests__/utils/convertToDTCG.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,350 @@
/*
* Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
import { expect } from 'chai';
import { convertToDTCG } from '../../lib/utils/convertToDTCG.js';

describe('utils', () => {
describe('convertToDTCG', () => {
it('should swap value, type and description to use $ property prefix', () => {
const result = convertToDTCG(
{
colors: {
red: {
value: '#ff0000',
type: 'color',
description: 'A red color',
},
green: {
value: '#00ff00',
type: 'color',
description: 'A green color',
},
blue: {
value: '#0000ff',
type: 'color',
description: 'A blue color',
},
},
},
{ applyTypesToGroup: false },
);
expect(result).to.eql({
colors: {
red: {
$value: '#ff0000',
$type: 'color',
$description: 'A red color',
},
green: {
$value: '#00ff00',
$type: 'color',
$description: 'A green color',
},
blue: {
$value: '#0000ff',
$type: 'color',
$description: 'A blue color',
},
},
});
});

it('should apply type to the upper most common ancestor', () => {
const result = convertToDTCG({
colors: {
red: {
value: '#ff0000',
type: 'color',
},
green: {
value: '#00ff00',
type: 'color',
},
blue: {
value: '#0000ff',
type: 'color',
},
},
dimensions: {
sm: {
value: '2px',
type: 'dimension',
},
md: {
value: '8px',
type: 'dimension',
},
lg: {
value: '16px',
type: 'dimension',
},
},
});
expect(result).to.eql({
colors: {
$type: 'color',
red: {
$value: '#ff0000',
},
green: {
$value: '#00ff00',
},
blue: {
$value: '#0000ff',
},
},
dimensions: {
$type: 'dimension',
sm: {
$value: '2px',
},
md: {
$value: '8px',
},
lg: {
$value: '16px',
},
},
});
});

it('should keep types as is when not shared with all siblings', () => {
const result = convertToDTCG({
colors: {
red: {
value: '#ff0000',
type: 'color',
},
green: {
value: '#00ff00',
type: 'color',
},
blue: {
value: '#0000ff',
type: 'different-type',
},
},
dimensions: {
sm: {
value: '2px',
type: 'dimension',
},
md: {
value: '8px',
type: 'dimension',
},
lg: {
value: '16px',
type: 'dimension',
},
},
});
expect(result).to.eql({
colors: {
red: {
$value: '#ff0000',
$type: 'color',
},
green: {
$value: '#00ff00',
$type: 'color',
},
blue: {
$value: '#0000ff',
$type: 'different-type',
},
},
dimensions: {
$type: 'dimension',
sm: {
$value: '2px',
},
md: {
$value: '8px',
},
lg: {
$value: '16px',
},
},
});
});

it('should work with any number of nestings', () => {
const result = convertToDTCG({
colors: {
red: {
value: '#ff0000',
type: 'color',
},
grey: {
100: {
value: '#aaaaaa',
type: 'color',
},
200: {
deeper: {
value: '#cccccc',
type: 'color',
},
},
400: {
value: '#dddddd',
type: 'color',
},
500: {
foo: {
bar: {
qux: {
value: '#eeeeee',
type: 'color',
},
},
},
},
},
green: {
value: '#00ff00',
type: 'color',
},
blue: {
value: '#0000ff',
type: 'color',
},
},
});
expect(result).to.eql({
$type: 'color',
colors: {
red: {
$value: '#ff0000',
},
grey: {
100: {
$value: '#aaaaaa',
},
200: {
deeper: {
$value: '#cccccc',
},
},
400: {
$value: '#dddddd',
},
500: {
foo: {
bar: {
qux: {
$value: '#eeeeee',
},
},
},
},
},
green: {
$value: '#00ff00',
},
blue: {
$value: '#0000ff',
},
},
});
});

it('should handle scenarios where not all types are the same', () => {
const result = convertToDTCG({
colors: {
red: {
value: '#ff0000',
type: 'color',
},
grey: {
100: {
value: '#aaaaaa',
type: 'color',
},
200: {
deeper: {
value: '#cccccc',
type: 'color',
},
},
400: {
value: '#dddddd',
type: 'color',
},
500: {
foo: {
bar: {
qux: {
value: '#eeeeee',
type: 'different-type',
},
},
},
},
},
green: {
value: '#00ff00',
type: 'color',
},
blue: {
value: '#0000ff',
type: 'color',
},
},
});
expect(result).to.eql({
colors: {
red: {
$value: '#ff0000',
$type: 'color',
},
grey: {
100: {
$value: '#aaaaaa',
$type: 'color',
},
200: {
$type: 'color',
deeper: {
$value: '#cccccc',
},
},
400: {
$value: '#dddddd',
$type: 'color',
},
500: {
$type: 'different-type',
foo: {
bar: {
qux: {
$value: '#eeeeee',
},
},
},
},
},
green: {
$value: '#00ff00',
$type: 'color',
},
blue: {
$value: '#0000ff',
$type: 'color',
},
},
});
});
});
});
Loading

0 comments on commit fec4ae4

Please sign in to comment.