Merge branch 'master' of https://github.com/css-blocks/css-property-parser

Author: Mahir Shah

.eslintrc.json

@@ -5,7 +5,7 @@
   "env": {
     "node": true
   },
-  "extends": "airbnb",
+  "extends": "airbnb/base",
   "rules": {
     "max-len": [
       "error",
@@ -35,4 +35,4 @@
     "global-require": "off",
     "valid-jsdoc": "error"
   }
-}
+}

css-property-parser.d.ts

@@ -6,34 +6,51 @@ declare namespace CssPropertyParser {
   }
 
   /**
-   * Given a property and value attempts to expand the value into its longhand equivalents. Returns an object
-   * mapping the property longhand names to the longhand values. If the property cannot be expanded (i.e. the property
-   * is not a shorthand property) simply returns an object mapping the original property to the original value.
+   * Given a property and value attempts to expand the value into its longhand
+   * equivalents. Returns an object mapping the property longhand names to the
+   * longhand values. If the property cannot be expanded (i.e. the property is
+   * not a shorthand property) simply returns an object mapping the original
+   * property to the original value.
    *
    * @param {string} propertyName - the property name for the given value
    * @param {string} propertyValue - the value of the property
-   * @param {boolean} [recursivelyResolve=true] - recursively resolve additional longhand properties if the shorthands
-   *                                              expand to additional shorthands. For example, the border property
-   *                                              expands to border-width, which expands further to border-left-width,
-   *                                              border-right-width, etc.
+   * @param {boolean} [recursivelyResolve=true] - recursively resolve additional
+   *   longhand properties if the shorthands expand to additional shorthands. For
+   *   example, the border property expands to border-width, which expands
+   *   further to border-left-width, border-right-width, etc.
+   * @param {boolean} [includeInitialValues=false] - when expanding the shorthand
+   *   property, fill in any missing longhand values with their initial value.
+   *   For example, the property declaration "border: 1px" only explicitly sets the
+   *   "border-width" longhand property. If this param is true, the returned object
+   *   will fill in the initial values for "border-style" and "border-color". By
+   *   default, the returned object will only contain the "border-width".
    */
   function expandShorthandProperty(
     propertyName: string,
     propertyValue: string,
-    recursivelyResolve?: boolean
+    recursivelyResolve?: boolean,
+    includeInitialValues?: boolean,
   ): Declarations;
 
  /**
-  * Given a shorthand property, returns an array of the computed properties for that shorthand property. If given
-  * a known property that is not a shorthand, simply returns the given property. If given an unknown property,
-  * returns an empty array.
+  * Given a shorthand property, returns an array of the computed properties for
+  * that shorthand property. If given a known property that is not a shorthand,
+  * simply returns the given property. If given an unknown property, returns an
+  * empty array.
   *
-  * @param {string} shorthandProperty - the shorthand property name. For example, "background" or "border".
-  * @returns {Array} - an array containing the computed properties for the given shorthand property. Returns an
-  *                    empty array if the given property is not a valid property.
+  * @param {string} shorthandProperty - the shorthand property name. For
+  *   example, "background" or "border".
+  * @param {boolean} recursivelyResolve - recursively resolve additional
+  *   longhand properties if the shorthands expand to additional shorthands. For
+  *   example, the border property expands to border-width, which expands further
+  *   to border-left-width, border-right-width, etc.
+  * @returns {Array} - an array containing the computed properties for the given
+  *   shorthand property. Returns an empty array if the given property is not a
+  *   valid property.
   */
   function getShorthandComputedProperties(
-    shorthandProperty: string
+    shorthandProperty: string,
+    recursivelyResolve: boolean
   ): Array<string>;
 
   /**
@@ -57,4 +74,4 @@ declare namespace CssPropertyParser {
     value: string
   ): boolean;
 
-}
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "css-property-parser",
-  "version": "1.0.0",
+  "version": "0.1.0",
   "description": "Validate css properties and expand shorthand css properties",
   "main": "src/index.js",
   "scripts": {
@@ -25,8 +25,6 @@
     "eslint": "^3.19.0",
     "eslint-config-airbnb": "^15.1.0",
     "eslint-plugin-import": "^2.7.0",
-    "eslint-plugin-jsx-a11y": "^5.1.1",
-    "eslint-plugin-react": "^7.2.1",
     "microtime": "^2.1.6",
     "mocha": "^3.5.0",
     "pre-commit": "^1.2.2",