feat(formats): add file object to formatter method (#439)

__tests__/buildFile.test.js

@@ -32,30 +32,30 @@ describe('buildFile', () => {
 
   it('should error if format doesnt exist or isnt a function', () => {
     expect(
-      buildFile.bind(null, '__tests__/__output/test.txt', {}, {}, {})
+      buildFile.bind(null, {destination: '__tests__/__output/test.txt'}, {}, {})
     ).toThrow('Please enter a valid file format');
     expect(
-      buildFile.bind(null, '__tests__/__output/test.txt', [], {}, {})
+      buildFile.bind(null, {destination: '__tests__/__output/test.txt', format: {}}, {}, {})
     ).toThrow('Please enter a valid file format');
     expect(
-      buildFile.bind(null, '__tests__/__output/test.txt', null, {}, {})
+      buildFile.bind(null, {destination: '__tests__/__output/test.txt', format: []}, {}, {})
     ).toThrow('Please enter a valid file format');
   });
 
   it('should error if destination doesnt exist or isnt a string', () => {
     expect(
-      buildFile.bind(null, {}, format, {}, {})
+      buildFile.bind(null, {format}, {}, {})
     ).toThrow('Please enter a valid destination');
     expect(
-      buildFile.bind(null, [], format, {}, {})
+      buildFile.bind(null, {format, destination: []}, {}, {})
     ).toThrow('Please enter a valid destination');
     expect(
-      buildFile.bind(null, null, format, {}, {})
+      buildFile.bind(null, {format, destination: {}}, {}, {})
     ).toThrow('Please enter a valid destination');
   });
 
-  let dest = './__tests__/__output/test.collisions';
-  var PROPERTY_NAME_COLLISION_WARNINGS = GroupMessages.GROUP.PropertyNameCollisionWarnings + ":" + dest;
+  let destination = './__tests__/__output/test.collisions';
+  var PROPERTY_NAME_COLLISION_WARNINGS = GroupMessages.GROUP.PropertyNameCollisionWarnings + ":" + destination;
   it('should generate warning messages for output name collisions', () => {
     let name = 'someName';
     let properties = {
@@ -71,7 +71,7 @@ describe('buildFile', () => {
     };
 
     GroupMessages.clear(PROPERTY_NAME_COLLISION_WARNINGS);
-    buildFile(dest, format, {}, properties);
+    buildFile({destination, format}, {}, properties);
 
     let collisions = properties.allProperties.map((properties) => {
       let propertyPathText = chalk.keyword('orangered')(properties.path.join('.'));
@@ -86,7 +86,13 @@ describe('buildFile', () => {
   });
 
   it('should write to a file properly', () => {
-    buildFile('test.txt', format, {buildPath: '__tests__/__output/'}, {});
+    buildFile({
+        destination: 'test.txt',
+        format
+      },{
+        buildPath: '__tests__/__output/'
+      },{}
+    );
     expect(helpers.fileExists('./__tests__/__output/test.txt')).toBeTruthy();
   });
 });

__tests__/cleanDir.test.js

@@ -31,9 +31,9 @@ describe('cleanDir', () => {
   });
 
   it('should delete a dir properly', () => {
-    buildFile('test.txt', format, {buildPath: '__tests__/__output/extradir1/extradir2/'}, {});
-    cleanFile('test.txt', format, {buildPath: '__tests__/__output/extradir1/extradir2/'}, {});
-    cleanDir('test.txt', format, {buildPath: '__tests__/__output/extradir1/extradir2/'}, {});
+    buildFile({destination:'test.txt', format}, {buildPath: '__tests__/__output/extradir1/extradir2/'}, {});
+    cleanFile({destination:'test.txt', format}, {buildPath: '__tests__/__output/extradir1/extradir2/'}, {});
+    cleanDir({destination:'test.txt', format}, {buildPath: '__tests__/__output/extradir1/extradir2/'}, {});
     expect(helpers.dirDoesNotExist('./__tests__/__output/extradir1/extradir2')).toBeTruthy();
     expect(helpers.dirDoesNotExist('./__tests__/__output/extradir1')).toBeTruthy();
   });

__tests__/cleanFile.test.js

@@ -30,14 +30,14 @@ describe('cleanFile', () => {
   });
 
   it('should delete a file properly', () => {
-    buildFile('test.txt', format, {buildPath: '__tests__/__output/'}, {});
-    cleanFile('test.txt', format, {buildPath: '__tests__/__output/'}, {});
+    buildFile({destination:'test.txt', format}, {buildPath: '__tests__/__output/'}, {});
+    cleanFile({destination:'test.txt', format}, {buildPath: '__tests__/__output/'}, {});
     expect(helpers.fileDoesNotExist('./__tests__/__output/test.txt')).toBeTruthy();
   });
 
   describe('if a file does not exist', () => {
     it('should not throw', () => {
-      expect(() => cleanFile('non-existent.txt', format, { buildPath: '__tests__/__output/' }, {})).not.toThrow();
+      expect(() => cleanFile({destination: 'non-existent.txt', format}, { buildPath: '__tests__/__output/' }, {})).not.toThrow();
     })
   })
 

__tests__/formats/all.test.js

@@ -67,7 +67,7 @@ describe('formats', () => {
     global.Date = function() { return constantDate };
 
     var formatter = formats[key].bind(file);
-    var output = formatter(dictionary, file);
+    var output = formatter(dictionary, {}, file);
 
     // reset the global Date object
     global.Date = globalDate;

__tests__/formats/es6Constants.test.js

@@ -59,7 +59,7 @@ describe('formats', () => {
     });
 
     it('should be a valid JS file', () => {
-      fs.writeFileSync('./__tests__/__output/output.js', formatter(dictionary) );
+      fs.writeFileSync('./__tests__/__output/output.js', formatter(dictionary, {}, file) );
       var test = require('../__output/output.js');
       expect(test.red).toEqual(dictionary.allProperties[0].value);
     });

__tests__/formats/javascriptModule.test.js

@@ -47,7 +47,7 @@ describe('formats', () => {
     });
 
     it('should be a valid JS file', () => {
-      fs.writeFileSync('./__tests__/__output/output.js', formatter(dictionary) );
+      fs.writeFileSync('./__tests__/__output/output.js', formatter(dictionary, {}, file) );
       var test = require('../__output/output.js');
       expect(test.color.red.value).toEqual(dictionary.properties.color.red.value);
     });

__tests__/formats/javascriptObject.test.js

@@ -35,7 +35,7 @@ describe('formats', () => {
 
     it('should be valid JS syntax', done => {
       try {
-        vm.runInNewContext(formatter(dictionary))
+        vm.runInNewContext(formatter(dictionary, {}, file))
         return done();
       } catch (err) {
         return done(new Error(err));

__tests__/formats/javascriptUmd.test.js

@@ -47,7 +47,7 @@ describe('formats', () => {
     });
 
     it('should be a valid JS file', () => {
-      fs.writeFileSync('./__tests__/__output/umd.js', formatter(dictionary) );
+      fs.writeFileSync('./__tests__/__output/umd.js', formatter(dictionary, {}, file) );
       var test = require('../__output/umd.js');
       expect(test.color.red.value).toEqual(dictionary.properties.color.red.value);
     });

__tests__/formats/json.test.js

@@ -42,7 +42,7 @@ describe('formats', () => {
     });
 
     it('should be a valid JSON file', () => {
-      fs.writeFileSync('./__tests__/__output/output.json', formatter(dictionary) );
+      fs.writeFileSync('./__tests__/__output/output.json', formatter(dictionary, {}, file) );
       var test = require('../__output/output.json');
       expect(test.color.red.value).toEqual(dictionary.properties.color.red.value);
     });

__tests__/formats/jsonFlat.test.js

@@ -54,7 +54,7 @@ describe('formats', () => {
     });
 
     it('should be a valid JSON file', () => {
-      fs.writeFileSync('./__tests__/__output/output.flat.json', formatter(dictionary) );
+      fs.writeFileSync('./__tests__/__output/output.flat.json', formatter(dictionary, {}, file) );
       var test = require('../__output/output.flat.json');
       expect(test['color-base-red']).toEqual(dictionary.allProperties[0].value);
     });

__tests__/formats/jsonNested.test.js

@@ -50,7 +50,7 @@ describe('formats', function() {
     });
 
     it('should be a valid JSON file', function() {
-      fs.writeFileSync('./__tests__/__output/json-nested.json', formatter(dictionary));
+      fs.writeFileSync('./__tests__/__output/json-nested.json', formatter(dictionary, {}, file));
       var test = require('../__output/json-nested.json');
       expect(test.color.base.red.primary)
         .toEqual(dictionary.properties.color.base.red.primary.value);

__tests__/formats/lessIcons.test.js

@@ -49,7 +49,7 @@ describe('formats', () => {
   describe('less/icons', () => {
 
     it('should have a valid less syntax', done => {
-      less.render(formatter(dictionary, config))
+      less.render(formatter(dictionary, config, file))
         .then(function(output) {
           expect(output).toBeDefined();
           done();

__tests__/formats/lessVariables.test.js

@@ -51,7 +51,7 @@ describe('formats', () => {
   describe('less/variables', () => {
 
     it('should have a valid less syntax', done => {
-      less.render(formatter(dictionary))
+      less.render(formatter(dictionary, {}, file))
         .then(function(output) {
           expect(output).toBeDefined();
           done();

__tests__/formats/scssIcons.test.js

@@ -50,7 +50,7 @@ describe('formats', () => {
 
     it('should have a valid scss syntax', done => {
       scss.render({
-        data: formatter(dictionary, config),
+        data: formatter(dictionary, config, file),
       }, function(err, result) {
         if(err) {
           return done(new Error(err));

__tests__/formats/scssMaps.test.js

@@ -220,7 +220,7 @@ describe('formats', () => {
       global.Date = function() { return constantDate };
 
       var formatter = formats[key].bind(file);
-      var output = formatter(dictionary, file);
+      var output = formatter(dictionary, {}, file);
 
       // reset the global Date object (or node-sass will complain!)
       global.Date = globalDate;

__tests__/formats/scssVariables.test.js

@@ -53,7 +53,7 @@ describe('formats', () => {
 
     it('should have a valid scss syntax', done => {
       scss.render({
-        data: formatter(dictionary),
+        data: formatter(dictionary, {}, file),
       }, function(err, result) {
         if(err) {
           return done(new Error(err));

lib/buildFile.js

@@ -21,19 +21,21 @@ var path = require('path'),
  * Takes the style property object and a format and returns a
  * string that can be written to a file.
  * @memberOf StyleDictionary
- * @param {String} destination
- * @param {Function} format
+ * @param {Object} file
  * @param {Object} platform
  * @param {Object} dictionary
- * @param {Function} filter
  * @returns {null}
  */
-function buildFile(destination, format, platform, dictionary, filter) {
+function buildFile(file = {}, platform = {}, dictionary = {}) {
+  var { destination, filter, format } = file || {};
+
   if (typeof format !== 'function')
     throw new Error('Please enter a valid file format');
   if (typeof destination !== 'string')
     throw new Error('Please enter a valid destination');
 
+  // to maintain backwards compatability we bind the format to the file object
+  format = format.bind(file);
   var fullDestination = destination;
 
   // if there is a build path, prepend the full destination with it
@@ -75,7 +77,7 @@ function buildFile(destination, format, platform, dictionary, filter) {
 
   let propertyNamesCollisionCount = GroupMessages.count(PROPERTY_NAME_COLLISION_WARNINGS);
 
-  fs.writeFileSync(fullDestination, format(filteredProperties, platform));
+  fs.writeFileSync(fullDestination, format(filteredProperties, platform, file));
   console.log((propertyNamesCollisionCount>0 ? '⚠️ ' : chalk.bold.green('✔︎ ')) + ' ' + fullDestination);
 
   if(propertyNamesCollisionCount > 0) {

lib/buildFiles.js

@@ -31,7 +31,7 @@ function buildFiles(dictionary, platform) {
 
   _.each(platform.files, function (file) {
     if (file.format) {
-      buildFile(file.destination, file.format.bind(file), platform, dictionary, file.filter);
+      buildFile(file, platform, dictionary);
     } else {
       throw new Error('Please supply a format');
     }

lib/cleanDir.js

@@ -20,14 +20,13 @@ var path  = require('path'),
  * Takes the style property object and a format and returns a
  * string that can be written to a file.
  * @memberOf StyleDictionary
- * @param {String} destination
- * @param {Function} format (unused)
+ * @param {Object} file
  * @param {Object} platform
  * @param {Object} dictionary (unused)
- * @param {Function} filter (unused)
  * @returns {null}
  */
-function cleanDir(destination, format, platform, dictionary, filter) {
+function cleanDir(file = {}, platform = {}, dictionary = {}) {
+  var { destination } = file;
 
   if (typeof destination !== 'string')
     throw new Error('Please enter a valid destination');

lib/cleanDirs.js

@@ -32,7 +32,7 @@ function cleanDirs(dictionary, platform) {
   // while neither the format or dictionary are used by clean file I'm passing them in for symmetry to buildFile
   _.each(platform.files, function (file) {
     if (file.format) {
-      cleanDir(file.destination, file.format.bind(file), platform, dictionary);
+      cleanDir(file, platform, dictionary);
     } else {
       throw new Error('Please supply a format')
     }

lib/cleanFile.js

@@ -27,7 +27,8 @@ var path  = require('path'),
  * @param {Function} filter (unused)
  * @returns {null}
  */
-function cleanFile(destination, format, platform, dictionary, filter) {
+function cleanFile(file = {}, platform = {}, dictionary = {}) {
+  var { destination } = file;
 
   if (typeof destination !== 'string')
     throw new Error('Please enter a valid destination');
@@ -37,8 +38,6 @@ function cleanFile(destination, format, platform, dictionary, filter) {
     destination = platform.buildPath + destination;
   }
 
-  var dirname = path.dirname(destination);
-
   if (!fs.existsSync(destination)) {
     console.log(chalk.bold.red('!') + ' ' + destination + ', does not exist');
     return;

lib/cleanFiles.js

@@ -32,7 +32,7 @@ function cleanFiles(dictionary, platform) {
   // while neither the format or dictionary are used by clean file I'm passing them in for symmetry to buildFile
   _.each(platform.files, function (file) {
     if (file.format) {
-      cleanFile(file.destination, file.format.bind(file), platform, dictionary);
+      cleanFile(file, platform, dictionary);
     } else {
       throw new Error('Please supply a template or formatter')
     }