1.0.1

jonathantneal · jonathantneal · commit 126ad55276b5 · 2018-10-10T08:14:36.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changes to PostCSS Short Overflow
 
+### 1.0.1 (October 9, 2018)
+
+- Fixed: Missing `skip` token
+- Updated documentation
+
 ### 1.0.0 (October 9, 2018)
 
 - Initial version
diff --git a/README.md b/README.md
@@ -64,9 +64,47 @@ postcss([
 
 #### prefix
 
-The `prefix` option determines the prefix applied to properties being processed
-(e.g. `x` for `-x-overflow`). Wrapping dashes (`-`) are automatically
-applied.
+The `prefix` option defines a prefix required by properties being transformed.
+Wrapping dashes are automatically applied, so that `x` would transform
+`-x-overflow`.
+
+```js
+postcssShortOverflow({ prefix: 'x' });
+```
+
+```pcss
+html {
+  -x-overflow: hidden auto;
+}
+
+/* becomes */
+
+html {
+  overflow-x: hidden;
+  overflow-y: auto;
+}
+```
+
+#### skip
+
+The `skip` option defines the skip token used to ignore portions of the
+shorthand.
+
+```js
+postcssShortOverflow({ skip: '-' });
+```
+
+```pcss
+[contenteditable] {
+  overflow: - auto;
+}
+
+/* becomes */
+
+[contenteditable] {
+  overflow-y: auto;
+}
+```
 
 [cli-img]: https://img.shields.io/travis/jonathantneal/postcss-short-overflow.svg
 [cli-url]: https://travis-ci.org/jonathantneal/postcss-short-overflow
diff --git a/index.js b/index.js
@@ -1,31 +1,31 @@
 import postcss from 'postcss';
 
 export default postcss.plugin('postcss-short-overflow', opts => {
-	// get the dashed prefix
 	const prefix = 'prefix' in Object(opts) ? `-${opts.prefix}-` : '';
+	const skip = 'skip' in Object(opts) ? String(opts.skip) : '*';
 
 	// get the (conditionally prefixed) property pattern
-	const propertyRegExp = new RegExp(`^${prefix}(overflow)$`);
+	const overflowPropertyRegExp = new RegExp(`^${prefix}(overflow)$`);
 
 	return root => {
 		// walk each matching declaration
-		root.walkDecls(propertyRegExp, decl => {
+		root.walkDecls(overflowPropertyRegExp, decl => {
 			// conditionally remove the prefix from the property
-			const [, property] = decl.prop.match(propertyRegExp);
+			const [, property] = decl.prop.match(overflowPropertyRegExp);
 
 			if (prefix) {
 				decl.prop = property;
 			}
 
 			// conditionally update multiple overflow values
-			var [overflowX, overflowY] = postcss.list.space(decl.value);
+			const [overflowX, overflowY] = postcss.list.space(decl.value);
 
 			if (overflowY) {
-				if (overflowX !== '*') {
+				if (overflowX !== skip) {
 					decl.cloneBefore({ prop: 'overflow-x', value: overflowX });
 				}
 
-				if (overflowY !== '*') {
+				if (overflowY !== skip) {
 					decl.cloneBefore({ prop: 'overflow-y', value: overflowY });
 				}
 
