Add header to all formats

Hey @dbanksdesign, I am trying to get the style-dictionary to work with the design token spec idea outlined by the w3c community group: https://github.com/design-tokens/community-group/issues/1

Getting the tokens out works fine in a custom build file like this

const StyleDictionaryExtended = require('style-dictionary').extend(__dirname + '/config.json');
const {tokens, version, data} = require(__dirname + '/tokens/w3c-design-tokens.json')
console.log('Build started...');
console.log('\n==============================================');
// turning array into a style-dictionary compatible object
StyleDictionaryExtended.properties = tokens.reduce((acc, item) => ({
  ...acc, [item.name]: item
}), {})

However, I would love to add the version and maybe some meta data from the data constants to the header of every transformed output. It seems to be quite cumbersome to create a custom format with StyleDictionaryExtended.registerFormat for every language (sass, json, ios, android) just to add a header.

So I was wondering, is there a way to add some content to the header for all files?

[chazzmoney]

@dbanksdesign can’t we just do it the way we do everything else? Allow registration of formatHelpers / via extend?

[lukasoppermann]

Hey @dbanksdesign that sounds great. I wasn’t sure how long it will take until the release (as I know form my own project that OS is always quite a lot of work).

I would think allowing users to extend the fileHeader function could be a great way. Maybe by adding an array of lines (or a function that returns an array of lines) and those lines will be added to the header?

E.g. in the build.js file

// usage
StyleDictionary.formatHelpers.fileHeader.extend([
`Version: ${version}`,
`Some other org specific info`
])

// Would result in (style = short)

// Do not edit directly\n';
// Generated on dd.mm.yyyy
// Version: 2.3.12
// Some other org specific info

I don’t know if this is a stupid idea as I just quickly dove into the code. But it would be great if one could overwrite or extend the fileHeader once in build.js and it would be used for all formats (without a need to overwrite all the formats).

Does this make sense?