Fix whitespace, typos and markup

salesforce-ux · May 4, 2016 · 37d16f4 · 37d16f4
1 parent d27430c
commit 37d16f4
Show file tree

Hide file tree

Showing 8 changed files with 33 additions and 31 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -4,4 +4,4 @@ node_js:
 install:
 - npm install
 script:
-- npm test
+- npm test
diff --git a/README.md b/README.md
@@ -160,7 +160,7 @@ gulp.src('./design/props.json')
 
 ***
 
-####`theo.registerTransform(type, valueTransforms)`
+#### `theo.registerTransform(type, valueTransforms)`
 
 Register a new transform. Existing transforms with the same name
 will be overwritten.
@@ -204,7 +204,7 @@ No valueTransforms will be applied
 
 ***
 
-####`theo.registerValueTransform(name, matcher, transformer)` <a name="registerValueTransform"></a>
+#### `theo.registerValueTransform(name, matcher, transformer)` <a name="registerValueTransform"></a>
 
 Register a new valueTransform. Existing valueTransforms with the same name
 will be overwritten.
@@ -245,7 +245,7 @@ Parse the value as a color and return an 6 digit hex string
 Parse the value as a color and return an 8 digit hex string
 
 **percentage/float**  
-Parse a string percentage value and return a float represention
+Parse a string percentage value and return a float representation
 
 **relative/pixel**  
 Parse a relative size value (em/rem) and return a pixel representation.
@@ -304,7 +304,7 @@ gulp.src('design/props.json')
 
 ***
 
-####`theo.registerFormat(name, formatter)`
+#### `theo.registerFormat(name, formatter)`
 
 Register a new format. Existing formats with the same name
 will be overwritten.
@@ -466,14 +466,14 @@ define(function() {
 });
 ```
 
-###### styleguide
+###### Styleguide
 
-See [salesforce-ux.github.io/design-properties]()
+See <https://salesforce-ux.github.io/design-properties>.
 
 
 ***
 
-####`theo.plugins.getResult([callback])`
+#### `theo.plugins.getResult([callback])`
 
 Get the result of a transform/format
 

diff --git a/src/props/formats/html.jsx b/src/props/formats/html.jsx
@@ -250,9 +250,10 @@ let Styleguide = React.createClass({
               <h1>Design Attribute Guide</h1>
             </div>
           </header>
-            <div className="container">
-              <main role="main">
-                <table>
+          <div className="container">
+            <main role="main">
+              <table>
+                <tbody>
                   {this.renderSection('text-color', 'Text Colors')}
                   {this.renderSection('background-color', 'Background Colors')}
                   {this.renderSection('gradient', 'Gradients')}
@@ -269,9 +270,10 @@ let Styleguide = React.createClass({
                   {this.renderSection('radius', 'Radius')}
                   {this.renderSection('time', 'Time')}
                   {this.renderSection('media-query', 'Media Queries')}
-                </table>
-              </main>
-            </div>
+                </tbody>
+              </table>
+            </main>
+          </div>
         </body>
       </html>
     )
@@ -280,7 +282,7 @@ let Styleguide = React.createClass({
 
 module.exports = function(json) {
   return `
-    <!doctype html>
+    <!DOCTYPE html>
     ${React.renderToStaticMarkup(<Styleguide json={json} />)}
   `;
-};
+};
diff --git a/src/props/index.js b/src/props/index.js
@@ -235,7 +235,7 @@ registerFormat('list.scss', (json, options) => {
 
 registerFormat('map.scss', (json, options) => {
   options = _.defaults({}, options, {
-    nameSuffix: '-map' 
+    nameSuffix: '-map'
   });
   let items = _.map(json.props, prop => {
     let name = kebabCase(prop.name);
@@ -261,7 +261,7 @@ registerFormat('map.scss', (json, options) => {
 
 registerFormat('map.variables.scss', (json, options) => {
   options = _.defaults({}, options, {
-    nameSuffix: '-map-variables' 
+    nameSuffix: '-map-variables'
   });
   _.transform(json.props, (result, value, name, props) => {
     props[name].value = `$${kebabCase(name)}`;
@@ -429,7 +429,7 @@ module.exports = {
      *
      * @param {function} [callback]
      * @return {stream}
-     */    
+     */
     getResult(callback) {
       return through.obj((file, enc, next) => {
         if (typeof callback === 'function' && file.isBuffer()) {

diff --git a/src/props/prop-set.js b/src/props/prop-set.js
@@ -18,7 +18,7 @@ let util        = require('./util');
 let TheoError   = require('./util/error');
 
 class PropSet {
-  
+
   constructor(file, valueTransforms, options={}) {
     if (typeof file.isBuffer !== 'function' || typeof file.isBuffer === 'undefined') {
       throw TheoError('transform() must use vinyl files');
@@ -173,7 +173,7 @@ class PropSet {
       // Extract the meta data
       let meta = prop['.meta'];
       if (this.options.includeMeta !== true) {
-        delete prop['.meta'];        
+        delete prop['.meta'];
       }
       // Transform the value
       this._transformValue(prop, meta);

diff --git a/test/props/index.js b/test/props/index.js
@@ -29,7 +29,7 @@ function isError(error) {
 }
 
 describe('$props', function() {
-  
+
   describe('#getValueTransform()', function() {
     it('throws an error if the valueTransform is not registered', function() {
       assert.throws(function() {
@@ -253,7 +253,7 @@ describe('$props.plugins', function() {
     });
     it('formats props', function(done) {
       var error, result;
-      var samplePath = path.resolve(__dirname, 'mock', 'sample.json'); 
+      var samplePath = path.resolve(__dirname, 'mock', 'sample.json');
       var postResult;
       gulp.src(samplePath)
         .on('error', function(err) {
@@ -274,7 +274,7 @@ describe('$props.plugins', function() {
     });
     it('filters props before formatting', function(done) {
       var error, result;
-      var samplePath = path.resolve(__dirname, 'mock', 'sample.json'); 
+      var samplePath = path.resolve(__dirname, 'mock', 'sample.json');
       //var preResult = JSON.parse(fs.readFileSync(samplePath));
       var postResult;
       gulp.src(samplePath)
@@ -291,7 +291,7 @@ describe('$props.plugins', function() {
     });
     it('maps props before formatting', function(done) {
       var error, result;
-      var samplePath = path.resolve(__dirname, 'mock', 'sample.json'); 
+      var samplePath = path.resolve(__dirname, 'mock', 'sample.json');
       //var preResult = JSON.parse(fs.readFileSync(samplePath));
       var postResult;
       gulp.src(samplePath)
@@ -314,7 +314,7 @@ describe('$props.plugins', function() {
     });
     it('renames the file correctly', function(done) {
       var resultFile;
-      var samplePath = path.resolve(__dirname, 'mock', 'sample.json'); 
+      var samplePath = path.resolve(__dirname, 'mock', 'sample.json');
       gulp.src(samplePath)
         .on('finish', function() {
           assert(resultFile.relative === 'sample.scss');
@@ -434,7 +434,7 @@ describe('$props.plugins', function() {
 });
 
 describe('$props:valueTransforms', function() {
-  
+
   describe('color/rgb', function() {
     var t = $props.getValueTransform('color/rgb').transformer;
     it('converts hex to rgb', function() {
@@ -835,7 +835,7 @@ describe('$props:formats', function() {
   describe('html', function() {
     before($format('raw', 'html', paths.sink));
     it('outputs html', function() {
-      var re = new RegExp(_.escapeRegExp('<!doctype html>'));
+      var re = new RegExp(_.escapeRegExp('<!DOCTYPE html>'));
       assert(re.test(result));
     });
     it('has example rows', function() {

diff --git a/test/props/prop-set.js b/test/props/prop-set.js
@@ -29,7 +29,7 @@ function isError(error) {
 describe('PropSet', function() {
 
   var def, file, t1, t2, set;
-  
+
   beforeEach(function() {
     var p = path.resolve(__dirname, 'mock', 'c.json');
     var f = fs.readFileSync(p);
@@ -320,7 +320,7 @@ describe('PropSet', function() {
       assert(!t1.transformer.called);
     });
   });
-  
+
   describe('#transform', function() {
     it('transforms the props', transformProps);
     it('returns the PropSet', function() {

diff --git a/test/stream-util/index.js b/test/stream-util/index.js
@@ -41,7 +41,7 @@ describe('$stream', function() {
   beforeEach(function() {
     files = [];
   });
-  
+
   describe('#filter()', function() {
     it('throws an error if a non functional argument is passed', function() {
       assert.throws(function() {