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.

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

feat(format): stylus support #527

Merged
merged 1 commit into from
Feb 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions __tests__/formats/__snapshots__/all.test.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -694,3 +694,11 @@ exports[`formats all should match sketch/palette/v2 snapshot 1`] = `
]
}"
`;

exports[`formats all should match stylus/variables snapshot 1`] = `
"
// Do not edit directly
// Generated on Sat, 01 Jan 2000 00:00:00 GMT

$color_red= #FF0000; // comment"
`;
78 changes: 78 additions & 0 deletions __tests__/formats/stylusVariable.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
/*
* 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.
*/

var formats = require('../../lib/common/formats');
var stylus = require('stylus');
const createDictionary = require('../../lib/utils/createDictionary');
const createFormatArgs = require('../../lib/utils/createFormatArgs');

var file = {
"destination": "__output/",
"format": "stylus/variables",
"name": "foo"
};

const propertyName = "color-base-red-400";
const propertyValue = "#EF5350";

const properties = {
color: {
base: {
red: {
400: {
"name": propertyName,
"value": propertyValue,
"original": {
"value": propertyValue
},
"attributes": {
"category": "color",
"type": "base",
"item": "red",
"subitem": "400"
},
"path": [
"color",
"base",
"red",
"400"
]
}
}
}
}
};

const formatter = formats['stylus/variables'].bind(file);
const dictionary = createDictionary({ properties });

describe('formats', () => {
describe('stylus/variables', () => {

it('should have a valid stylus syntax', () => {
const stylusArguments = createFormatArgs({
dictionary,
file,
platform: {}
});
stylus.render(formatter(stylusArguments, {}, file),
function (err, css) {
if (err) {
throw new Error(err);
}
expect(css).toBeDefined();
});
});

});
});
29 changes: 27 additions & 2 deletions lib/common/formats.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,22 +37,31 @@ function fileHeader(showFileHeader = true, commentStyle) {
}

function formattedVariables(format, dictionary, outputReferences = false) {
var prefix, commentStyle, indentation;
var prefix, commentStyle, indentation, separator;

switch(format) {
case 'css':
prefix = '--';
indentation = ' ';
separator = ':';
break;
case 'sass':
prefix = '$';
commentStyle = 'short';
indentation = '';
separator = ':';
break;
case 'less':
prefix = '@';
commentStyle = 'short';
indentation = '';
separator = ':';
break;
case 'stylus':
prefix = '$';
commentStyle = 'short';
indentation = '';
separator = '=';
break;
}

Expand All @@ -72,7 +81,7 @@ function formattedVariables(format, dictionary, outputReferences = false) {
}
})
.map(function(prop) {
var to_ret_prop = `${indentation}${prefix}${prop.name}: `;
var to_ret_prop = `${indentation}${prefix}${prop.name}${separator} `;
let value = prop.value;

if (outputReferences && dictionary.usesReference(prop.original.value)) {
Expand Down Expand Up @@ -302,6 +311,22 @@ module.exports = {
return fileHeader(options.showFileHeader, 'short') + iconsWithPrefix('@', dictionary.allProperties, options, 'short');
},

/**
* Creates a Stylus file with variable definitions based on the style dictionary
*
* @memberof Formats
* @kind member
* @example
* ```stylus
* $color-background-base= #f0f0f0;
* $color-background-alt= #eeeeee;
* ```
klausbayrhammer marked this conversation as resolved.
Show resolved Hide resolved
*/
'stylus/variables': function({dictionary, options}) {
return fileHeader(options.showFileHeader, 'short') +
formattedVariables('stylus', dictionary, options.outputReferences);
},

/**
* Creates a CommonJS module with the whole style dictionary
*
Expand Down
90 changes: 89 additions & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@
"lint-staged": "^10.2.7",
"node-sass": "^4.14.1",
"standard-version": "^9.0.0",
"stylus": "^0.54.8",
"tsd": "^0.11.0",
"yaml": "^1.10.0"
}
Expand Down