style-dictionary 3.7.2 → 3.8.0

package/examples/advanced/custom-file-header/node_modules/style-dictionary/lib/exportPlatform.js

@@ -1,132 +0,0 @@
-/*
- * 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.
- */
-
-const resolveObject = require('./utils/resolveObject'),
-    getName = require('./utils/references/getName'),
-    transformObject = require('./transform/object'),
-    transformConfig = require('./transform/config'),
-    GroupMessages = require('./utils/groupMessages');
-
-const PROPERTY_REFERENCE_WARNINGS = GroupMessages.GROUP.PropertyReferenceWarnings;
-
-/**
- * Exports a tokens object with applied
- * platform transforms.
- *
- * This is useful if you want to use a style
- * dictionary in JS build tools like webpack.
- *
- * @static
- * @memberof module:style-dictionary
- * @param {String} platform - The platform to be exported.
- * Must be defined on the style dictionary.
- * @returns {Object}
- */
-function exportPlatform(platform) {
-  if (!platform || !this.options.platforms[platform]) {
-    throw new Error('Please supply a valid platform');
-  }
-
-  // We don't want to mutate the original object
-  const platformConfig = transformConfig(this.options.platforms[platform], this);
-
-  let exportableResult = this.properties;
-
-  // list keeping paths of props with applied value transformations
-  const transformedPropRefs = [];
-  // list keeping paths of props that had references in it, and therefore
-  // could not (yet) have transformed
-  const deferredPropValueTransforms = [];
-
-  const transformationContext = {
-    transformedPropRefs,
-    deferredPropValueTransforms
-  };
-
-  let deferredPropCount = 0;
-  let finished;
-
-  while(typeof finished === "undefined") {
-    // We keep up transforming and resolving until all props are resolved
-    // and every defined transformation was executed. Remember: transformations
-    // can only be executed, if the value to be transformed, has no references
-    // in it. So resolving may lead to enable further transformations, and sub
-    // sequent resolving may enable even more transformations - and so on.
-    // So we keep this loop running until sub sequent transformations are ineffective.
-    //
-    // Take the following example:
-    //
-    // color.brand = {
-    //   value: "{color.base.green}"
-    // }
-    //
-    // color.background.button.primary.base = {
-    //   value: "{color.brand.value}",
-    //   color: {
-    //     desaturate: 0.5
-    //   }
-    // }
-    //
-    // color.background.button.primary.hover = {
-    //   value: "{color.background.button.primary.base}",
-    //   color: {
-    //     darken: 0.2
-    //   }
-    // }
-    //
-    // As you can see 'color.background.button.primary.hover' is a variation
-    // of 'color.background.button.primary.base' which is a variation of
-    // 'color.base.green'. These transitive references are solved by running
-    // this loop until all properties are transformed and resolved.
-
-    // We need to transform the object before we resolve the
-    // variable names because if a value contains concatenated
-    // values like "1px solid {color.border.base}" we want to
-    // transform the original value (color.border.base) before
-    // replacing that value in the string.
-    const transformed = transformObject(exportableResult, platformConfig, transformationContext);
-
-    // referenced values, that have not (yet) been transformed should be excluded from resolving
-    const ignorePathsToResolve = deferredPropValueTransforms.map(p => getName([p, 'value']));
-    exportableResult = resolveObject(transformed, {ignorePaths: ignorePathsToResolve});
-
-    const newDeferredPropCount = deferredPropValueTransforms.length;
-
-    // nothing left to transform -> ready
-    if (newDeferredPropCount === 0) {
-      finished = true;
-    // or deferred count doesn't go down, that means there
-    // is a circular reference -> ready (but errored)
-    } else if (deferredPropCount === newDeferredPropCount) {
-      // if we didn't resolve any deferred references then we have a circular reference
-      // the resolveObject method will find the circular references
-      // we do this in case there are multiple circular references
-      resolveObject(transformed);
-      finished = true;
-    } else {
-      // neither of these things, keep going.
-      deferredPropCount = newDeferredPropCount;
-    }
-  }
-
-  if (GroupMessages.count(PROPERTY_REFERENCE_WARNINGS) > 0) {
-    const warnings = GroupMessages.flush(PROPERTY_REFERENCE_WARNINGS).join('\n');
-    console.log(`\n${PROPERTY_REFERENCE_WARNINGS}:\n${warnings}\n\n`);
-    throw new Error('Problems were found when trying to resolve property references');
-  }
-
-  return exportableResult;
-}
-
-
-module.exports = exportPlatform;

package/examples/advanced/custom-file-header/node_modules/style-dictionary/lib/extend.js

@@ -1,153 +0,0 @@
-/*
- * 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.
- */
-
-require('json5/lib/register');
-require.extensions[".jsonc"] = require("./utils/jsonc").register;
-
-var combineJSON = require('./utils/combineJSON'),
-    deepExtend = require('./utils/deepExtend'),
-    path = require('path'),
-    _ = require('./utils/es6_'),
-    GroupMessages = require('./utils/groupMessages');
-
-var PROPERTY_VALUE_COLLISIONS = GroupMessages.GROUP.PropertyValueCollisions;
-
-/**
- * Either a string to a JSON file that contains configuration for the style dictionary or a plain Javascript object
- * that contains the configuration.
- * @typedef {(object|string)} Config
- * @prop {String[]} source - Paths to token files
- * @prop {Platform} platforms.platform - A platform
- * @example
- * ```json
- * {
- *   "source": ["tokens/*.json"],
- *   "platforms": {
- *     "scss": {
- *       "transformGroup": "scss",
- *       "buildPath": "web/sass/",
- *       "files": [
- *         {
- *           "format": "scss/variables",
- *           "destination": "_variables.scss"
- *         }
- *       ],
- *       "actions": ["copy_assets"]
- *     }
- *   }
- * }
- * ```
- */
-
-/**
- * An object representing a platform
- * @typedef {Object} Platform
- * @prop {String} transformGroup
- * @prop {String} transforms
- */
-
-/**
- * Create a Style Dictionary
- * @static
- * @memberof module:style-dictionary
- * @param {Config} config - Configuration options to build your style dictionary. If you pass a string,
- * it will be used as a path to a JSON config file. You can also pass an object with the configuration.
- * @returns {module:style-dictionary}
- * @example
- * ```js
- * const StyleDictionary = require('style-dictionary').extend('config.json');
- *
- * const StyleDictionary = require('style-dictionary').extend({
- *   source: ['tokens/*.json'],
- *   platforms: {
- *     scss: {
- *       transformGroup: 'scss',
- *       buildPath: 'build/',
- *       files: [{
- *         destination: 'variables.scss',
- *         format: 'scss/variables'
- *       }]
- *     }
- *     // ...
- *   }
- * });
- * ```
- */
-function extend(opts) {
-  let options, to_ret;
-  let inlineTokens = {};
-  let includeTokens = {};
-  let sourceTokens = {};
-
-  // Overloaded method, can accept a string as a path that points to a JS or
-  // JSON file or a plain object. Potentially refactor.
-  if (_.isString(opts)) {
-    options = require(path.resolve(process.cwd(), opts));
-  } else {
-    options = opts;
-  }
-
-  // Creating a new object and copying over the options
-  // Also keeping an options object in case
-  to_ret = deepExtend([{}, this, {options: options}, options]);
-
-  // grab the inline tokens, ones either defined in the configuration object
-  // or that already exist from extending another style dictionary instance
-  // with `properties` or `tokens` keys
-  inlineTokens = deepExtend([{}, (to_ret.tokens||{}), (to_ret.properties||{})]);
-
-  // Update tokens with includes from dependencies
-  if (options.include) {
-    if (!_.isArray(options.include))
-      throw new Error('include must be an array');
-
-    includeTokens = combineJSON(options.include, true, null, false, to_ret.parsers);
-
-    to_ret.include = null; // We don't want to carry over include references
-  }
-
-  // Update tokens with current package's source
-  // These highest precedence
-  if (options.source) {
-    if (!_.isArray(options.source))
-      throw new Error('source must be an array');
-
-    sourceTokens = combineJSON(options.source, true, function Collision(prop) {
-      GroupMessages.add(
-        PROPERTY_VALUE_COLLISIONS,
-        `Collision detected at: ${prop.path.join('.')}! Original value: ${prop.target[prop.key]}, New value: ${prop.copy[prop.key]}`
-      );
-    }, true, to_ret.parsers);
-
-    if(GroupMessages.count(PROPERTY_VALUE_COLLISIONS) > 0) {
-      var collisions = GroupMessages.flush(PROPERTY_VALUE_COLLISIONS).join('\n');
-      console.log(`\n${PROPERTY_VALUE_COLLISIONS}:\n${collisions}\n\n`);
-      if (options.log === 'error') {
-        throw new Error('Collisions detected');
-      }
-    }
-
-    to_ret.source = null; // We don't want to carry over the source references
-  }
-
-  // Merge inline, include, and source tokens
-  const tokens = deepExtend([{}, inlineTokens, includeTokens, sourceTokens]);
-
-  // Add tokens to both .tokens and .properties
-  to_ret.tokens = tokens;
-  to_ret.properties = tokens;
-
-  return to_ret;
-}
-
-module.exports = extend;

package/examples/advanced/custom-file-header/node_modules/style-dictionary/lib/filterProperties.js

@@ -1,90 +0,0 @@
-/*
- * 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 _ = require("./utils/es6_")
-
-/**
- * Takes a nested object of properties and filters them using the provided
- * function.
- *
- * @param {Object} properties
- * @param {Function} filter - A function that receives a property object and
- *   returns `true` if the property should be included in the output or `false`
- *   if the property should be excluded from the output.
- * @returns {Object[]} properties - A new object containing only the properties
- *   that matched the filter.
- */
-function filterPropertyObject(properties, filter) {
-  // Use reduce to generate a new object with the unwanted properties filtered
-  // out
-  return _.reduce(properties, (result, value, key) => {
-    // If the value is not an object, we don't know what it is. We return it as-is.
-    if (!_.isObject(value)) {
-      return result
-    // If the value has a `value` member we know it's a property, pass it to
-    // the filter function and either include it in the final `result` object or
-    // exclude it (by returning the `result` object without it added).
-    } else if (typeof value.value !== 'undefined') {
-      return filter(value) ? _.assign(result, { [key]: value }) : result
-    // If we got here we have an object that is not a property. We'll assume
-    // it's an object containing multiple properties and recursively filter it
-    // using the `filterPropertyObject` function.
-    } else {
-      const filtered = filterPropertyObject(value, filter)
-      // If the filtered object is not empty then add it to the final `result`
-      // object. If it is empty then every property inside of it was filtered
-      // out, then exclude it entirely from the final `result` object.
-      return _.isEmpty(filtered) ? result : _.assign(result, { [key]: filtered })
-    }
-  }, {})
-}
-
-/**
- * Takes an array of properties and filters them using the provided function.
- *
- * @param {Object[]} properties
- * @param {Function} filter - A function that receives a property object and
- *   returns `true` if the property should be included in the output or `false`
- *   if the property should be excluded from the output.
- * @returns {Object[]} properties - A new array containing only the properties
- *   that matched the filter.
- */
-function filterPropertyArray(properties, filter) {
-  // Go lodash!
-  return _.filter(properties, filter)
-}
-
-/**
- * Takes a dictionary and filters the `allProperties` array and the `properties`
- * object using a function provided by the user.
- *
- * @param {Object} dictionary
- * @param {Function} filter - A function that receives a token object
- *   and returns `true` if the token should be included in the output
- *   or `false` if the token should be excluded from the output
- * @returns {Object} dictionary - A new dictionary containing only the
- *   properties that matched the filter (or the original dictionary if no filter
- *   function was provided).
- */
-function filterProperties(dictionary, filter) {
-  if (!filter) {
-    return dictionary
-  } else {
-    return {
-      allProperties: filterPropertyArray(dictionary.allProperties, filter),
-      properties: filterPropertyObject(dictionary.properties, filter)
-    };
-  }
-}
-
-module.exports = filterProperties

package/examples/advanced/custom-file-header/node_modules/style-dictionary/lib/register/action.js

@@ -1,63 +0,0 @@
-/*
- * 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.
- */
-
-/**
- * Adds a custom action to Style Dictionary. Custom
- * actions can do whatever you need, such as: copying files,
- * base64'ing files, running other build scripts, etc.
- * After you register a custom action, you then use that
- * action in a platform your config.json
- *
- * You can perform operations on files generated by the style dictionary
- * as actions run after these files are generated.
- * Actions are run sequentially, if you write synchronous code then
- * it will block other actions, or if you use asynchronous code like Promises
- * it will not block.
- *
- * @static
- * @memberof module:style-dictionary
- * @param {Object} action
- * @param {String} action.name - The name of the action
- * @param {Function} action.do - The action in the form of a function.
- * @param {Function} [action.undo] - A function that undoes the action.
- * @returns {module:style-dictionary}
- * @example
- * ```js
- * StyleDictionary.registerAction({
- *   name: 'copy_assets',
- *   do: function(dictionary, config) {
- *     console.log('Copying assets directory');
- *     fs.copySync('assets', config.buildPath + 'assets');
- *   },
- *   undo: function(dictionary, config) {
- *     console.log('Cleaning assets directory');
- *     fs.removeSync(config.buildPath + 'assets');
- *   }
- * });
- * ```
- */
-function registerAction(options) {
-  if (typeof options.name !== 'string')
-    throw new Error('name must be a string');
-  if (typeof options.do !== 'function')
-    throw new Error('do must be a function');
-
-  this.action[options.name] = {
-    do: options.do,
-    undo: options.undo
-  };
-
-  return this;
-}
-
-module.exports = registerAction;

package/examples/advanced/custom-file-header/node_modules/style-dictionary/lib/register/fileHeader.js

@@ -1,48 +0,0 @@
-/*
- * 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.
- */
-
-/**
- * Add a custom file header to the style dictionary. File headers are used in
- * formats to display some information about how the file was built in a comment.
- * @static
- * @memberof module:style-dictionary
- * @param {Object} options
- * @param {String} options.name - Name of the format to be referenced in your config.json
- * @param {function} options.fileHeader - Function that returns an array of strings, which will be mapped to comment lines. It takes a single argument which is the default message array. See [file headers](formats.md#file-headers) for more information.
- * @returns {module:style-dictionary}
- * @example
- * ```js
- * StyleDictionary.registerFileHeader({
- *   name: 'myCustomHeader',
- *   fileHeader: function(defaultMessage) {
- *     return [
- *       ...defaultMessage,
- *       `hello, world!`
- *     ];
- *   }
- * })
- * ```
- */
-
-function registerFileHeader(options) {
-  if (typeof options.name !== 'string')
-    throw new Error('Can\'t register file header; options.name must be a string');
-  if (typeof options.fileHeader !== 'function')
-    throw new Error('Can\'t register file header; options.fileHeader must be a function');
-
-  this.fileHeader[options.name] = options.fileHeader;
-
-  return this;
-}
-
-module.exports = registerFileHeader;

package/examples/advanced/custom-file-header/node_modules/style-dictionary/lib/register/filter.js

@@ -1,43 +0,0 @@
-/*
- * 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.
- */
-
-/**
- * Add a custom filter to the style dictionary
- * @static
- * @memberof module:style-dictionary
- * @param {Object} filter
- * @param {String} filter.name - Name of the filter to be referenced in your config.json
- * @param {Function} filter.matcher - Matcher function, return boolean if the token should be included.
- * @returns {module:style-dictionary}
- * @example
- * ```js
- * StyleDictionary.registerFilter({
- *   name: 'isColor',
- *   matcher: function(token) {
-  *     return token.attributes.category === 'color';
-  *   }
- * })
- * ```
- */
-function registerFilter(options) {
-  if (typeof options.name !== 'string')
-    throw new Error('Can\'t register filter; filter.name must be a string');
-  if (typeof options.matcher !== 'function')
-    throw new Error('Can\'t register filter; filter.matcher must be a function');
-
-  this.filter[options.name] = options.matcher;
-
-  return this;
-}
-
-module.exports = registerFilter;

package/examples/advanced/custom-file-header/node_modules/style-dictionary/lib/register/format.js

@@ -1,74 +0,0 @@
-/*
- * 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.
- */
-
-/**
- * @module format
- */
-
-/**
- * The formatter function that is called when Style Dictionary builds files.
- *
- * @function formatter
- * @memberof module:format
- * @param {Object} args - A single argument to support named parameters and destructuring.
- * @param {Object} args.dictionary - The transformed and resolved dictionary object
- * @param {Object} args.dictionary.tokens - Object structure of the tokens that has been transformed and references resolved.
- * @param {Array} args.dictionary.allTokens - Flattened array of all the tokens. This makes it easy to output a list, like a list of SCSS variables.
- * @param {function(value): Boolean} args.dictionary.usesReference - Use this function to see if a token's value uses a reference. This is the same function style dictionary uses internally to detect a reference.
- * @param {function(value): Value} args.dictionary.getReferences - Use this function to get the tokens that it references. You can use this to output a reference in your custom format. For example: `dictionary.getReferences(token.original.value) // returns an array of the referenced token objects`
- * @param {Object} args.platform - The platform configuration this format is being called in.
- * @param {Object} args.file - The file configuration this format is being called in.
- * @param {Object} args.options - Merged options object that combines platform level configuration and file level configuration. File options take precedence.
- * @returns {String}
- * @example
- * ```js
- * StyleDictionary.registerFormat({
- *   name: 'myCustomFormat',
- *   formatter: function({dictionary, platform, options, file}) {
- *     return JSON.stringify(dictionary.tokens, null, 2);
- *   }
- * })
- * ```
- */
-
-/**
- * Add a custom format to the style dictionary
- * @static
- * @memberof module:style-dictionary
- * @param {Object} format
- * @param {String} format.name - Name of the format to be referenced in your config.json
- * @param {function} format.formatter - Function to perform the format. Takes a single argument. See [creating custom formats](formats.md#creating-formats)
- * Must return a string, which is then written to a file.
- * @returns {module:style-dictionary}
- * @example
- * ```js
- * StyleDictionary.registerFormat({
- *   name: 'json',
- *   formatter: function({dictionary, platform, options, file}) {
- *     return JSON.stringify(dictionary.tokens, null, 2);
- *   }
- * })
- * ```
- */
-function registerFormat(options) {
-  if (typeof options.name !== 'string')
-    throw new Error('Can\'t register format; format.name must be a string');
-  if (typeof options.formatter !== 'function')
-    throw new Error('Can\'t register format; format.formatter must be a function');
-
-  this.format[options.name] = options.formatter;
-
-  return this;
-}
-
-module.exports = registerFormat;

package/examples/advanced/custom-file-header/node_modules/style-dictionary/lib/register/parser.js

@@ -1,42 +0,0 @@
-/*
- * 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.
- */
-
-/**
- * Adds a custom parser to parse style dictionary files
- * @static
- * @memberof module:style-dictionary
- * @param {Regex} pattern - A file path regular expression to match which files this parser should be be used on. This is similar to how webpack loaders work. `/\.json$/` will match any file ending in '.json', for example.
- * @param {Function} parse - Function to parse the file contents. Takes 1 argument, which is an object with 2 attributes: contents wich is the string of the file contents and filePath. The function should return a plain Javascript object.
- * @returns {module:style-dictionary}
- * @example
- * ```js
- * StyleDictionary.registerParser({
- *   pattern: /\.json$/,
- *   parse: ({contents, filePath}) => {
- *     return JSON.parse(contents);
- *   }
- * })
- * ```
- */
-function registerParser(options) {
-  if (!(options.pattern instanceof RegExp))
-    throw new Error(`Can't register parser; parser.pattern must be a regular expression`);
-  if (typeof options.parse !== 'function')
-    throw new Error('Can\'t register parser; parser.parse must be a function');
-
-  this.parsers.push(options);
-
-  return this;
-}
-
-module.exports = registerParser;