1.0.0

Author: jonathantneal

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = tab
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{json,md,yml}]
+indent_size = 2
+indent_style = space

.gitignore

@@ -0,0 +1,11 @@
+node_modules
+index.*.*
+package-lock.json
+*.log*
+*.result.css
+.*
+!.editorconfig
+!.gitignore
+!.rollup.js
+!.tape.js
+!.travis.yml

.rollup.js

@@ -0,0 +1,16 @@
+import babel from 'rollup-plugin-babel';
+
+export default {
+	input: 'index.js',
+	output: [
+		{ file: 'index.cjs.js', format: 'cjs', sourcemap: true },
+		{ file: 'index.es.mjs', format: 'es', sourcemap: true }
+	],
+	plugins: [
+		babel({
+			presets: [
+				['@babel/env', { modules: false, targets: { node: 6 } }]
+			]
+		})
+	]
+};

.tape.js

@@ -0,0 +1,18 @@
+module.exports = {
+	'postcss-short-overflow': {
+		'basic': {
+			message: 'supports basic usage'
+		},
+		'prefix': {
+			message: 'supports prefix usage'
+		},
+		'prefix:opt': {
+			message: 'supports { prefix: "x" } prefix usage',
+			options: {
+				prefix: 'x'
+			},
+			expect: 'basic.expect.css',
+			expect: 'basic.result.css'
+		}
+	}
+};

.travis.yml

@@ -0,0 +1,9 @@
+# https://docs.travis-ci.com/user/travis-lint
+
+language: node_js
+
+node_js:
+  - 6
+
+install:
+  - npm install --ignore-scripts

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changes to PostCSS Short Overflow
+
+### 1.0.0 (October 9, 2018)
+
+- Initial version

CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Contributing to PostCSS Short Overflow
+
+You want to help? You rock! Now, take a moment to be sure your contributions
+make sense to everyone else.
+
+## Reporting Issues
+
+Found a problem? Want a new feature?
+
+- See if your issue or idea has [already been reported].
+- Provide a [reduced test case] or a [live example].
+
+Remember, a bug is a _demonstrable problem_ caused by _our_ code.
+
+## Submitting Pull Requests
+
+Pull requests are the greatest contributions, so be sure they are focused in
+scope and avoid unrelated commits.
+
+1. To begin; [fork this project], clone your fork, and add our upstream.
+   ```bash
+   # Clone your fork of the repo into the current directory
+   git clone git@github.com:YOUR_USER/postcss-short-overflow.git
+
+   # Navigate to the newly cloned directory
+   cd postcss-short-overflow
+
+   # Assign the original repo to a remote called "upstream"
+   git remote add upstream git@github.com:jonathantneal/postcss-short-overflow.git
+
+   # Install the tools necessary for testing
+   npm install
+   ```
+
+2. Create a branch for your feature or fix:
+   ```bash
+   # Move into a new branch for your feature
+   git checkout -b feature/thing
+   ```
+   ```bash
+   # Move into a new branch for your fix
+   git checkout -b fix/something
+   ```
+
+3. If your code follows our practices, then push your feature branch:
+   ```bash
+   # Test current code
+   npm test
+   ```
+   ```bash
+   # Push the branch for your new feature
+   git push origin feature/thing
+   ```
+   ```bash
+   # Or, push the branch for your update
+   git push origin update/something
+   ```
+
+That’s it! Now [open a pull request] with a clear title and description.
+
+[already been reported]: issues
+[fork this project]:     fork
+[live example]:          https://codepen.io/pen
+[open a pull request]:   https://help.github.com/articles/using-pull-requests/
+[reduced test case]:     https://css-tricks.com/reduced-test-cases/

INSTALL.md

@@ -0,0 +1,170 @@
+# Installing PostCSS Short Overflow
+
+[PostCSS Short Overflow] runs in all Node environments, with special instructions for:
+
+| [Node](#node) | [PostCSS CLI](#postcss-cli) | [Webpack](#webpack) | [Create React App](#create-react-app) | [Gulp](#gulp) | [Grunt](#grunt) |
+| --- | --- | --- | --- | --- | --- |
+
+## Node
+
+Add [PostCSS Short Overflow] to your project:
+
+```bash
+npm install postcss-short-overflow --save-dev
+```
+
+Use [PostCSS Short Overflow] to process your CSS:
+
+```js
+const postcssShortOverflow = require('postcss-short-overflow');
+
+postcssShortOverflow.process(YOUR_CSS /*, processOptions, pluginOptions */);
+```
+
+Or use it as a [PostCSS] plugin:
+
+```js
+const postcss = require('postcss');
+const postcssShortOverflow = require('postcss-short-overflow');
+
+postcss([
+  postcssShortOverflow(/* pluginOptions */)
+]).process(YOUR_CSS /*, processOptions */);
+```
+
+## PostCSS CLI
+
+Add [PostCSS CLI] to your project:
+
+```bash
+npm install postcss-cli --save-dev
+```
+
+Use [PostCSS Short Overflow] in your `postcss.config.js` configuration file:
+
+```js
+const postcssShortOverflow = require('postcss-short-overflow');
+
+module.exports = {
+  plugins: [
+    postcssShortOverflow(/* pluginOptions */)
+  ]
+}
+```
+
+## Webpack
+
+Add [PostCSS Loader] to your project:
+
+```bash
+npm install postcss-loader --save-dev
+```
+
+Use [PostCSS Short Overflow] in your Webpack configuration:
+
+```js
+const postcssShortOverflow = require('postcss-short-overflow');
+
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.css$/,
+        use: [
+          'style-loader',
+          { loader: 'css-loader', options: { importLoaders: 1 } },
+          { loader: 'postcss-loader', options: {
+            ident: 'postcss',
+            plugins: () => [
+              postcssShortOverflow(/* pluginOptions */)
+            ]
+          } }
+        ]
+      }
+    ]
+  }
+}
+```
+
+## Create React App
+
+Add [React App Rewired] and [React App Rewire PostCSS] to your project:
+
+```bash
+npm install react-app-rewired react-app-rewire-postcss --save-dev
+```
+
+Use [React App Rewire PostCSS] and [PostCSS Short Overflow] in your
+`config-overrides.js` file:
+
+```js
+const reactAppRewirePostcss = require('react-app-rewire-postcss');
+const postcssShortOverflow = require('postcss-short-overflow');
+
+module.exports = config => reactAppRewirePostcss(config, {
+  plugins: () => [
+    postcssShortOverflow(/* pluginOptions */)
+  ]
+});
+```
+
+## Gulp
+
+Add [Gulp PostCSS] to your project:
+
+```bash
+npm install gulp-postcss --save-dev
+```
+
+Use [PostCSS Short Overflow] in your Gulpfile:
+
+```js
+const postcss = require('gulp-postcss');
+const postcssShortOverflow = require('postcss-short-overflow');
+
+gulp.task('css', () => gulp.src('./src/*.css').pipe(
+  postcss([
+    postcssShortOverflow(/* pluginOptions */)
+  ])
+).pipe(
+  gulp.dest('.')
+));
+```
+
+## Grunt
+
+Add [Grunt PostCSS] to your project:
+
+```bash
+npm install grunt-postcss --save-dev
+```
+
+Use [PostCSS Short Overflow] in your Gruntfile:
+
+```js
+const postcssShortOverflow = require('postcss-short-overflow');
+
+grunt.loadNpmTasks('grunt-postcss');
+
+grunt.initConfig({
+  postcss: {
+    options: {
+      use: [
+       postcssShortOverflow(/* pluginOptions */)
+      ]
+    },
+    dist: {
+      src: '*.css'
+    }
+  }
+});
+```
+
+[Gulp PostCSS]: https://github.com/postcss/gulp-postcss
+[Grunt PostCSS]: https://github.com/nDmitry/grunt-postcss
+[PostCSS]: https://github.com/postcss/postcss
+[PostCSS CLI]: https://github.com/postcss/postcss-cli
+[PostCSS Loader]: https://github.com/postcss/postcss-loader
+[PostCSS Short Overflow]: https://github.com/jonathantneal/postcss-short-overflow
+[React App Rewire PostCSS]: https://github.com/csstools/react-app-rewire-postcss
+[React App Rewired]: https://github.com/timarney/react-app-rewired