Creates PostCSS plugin boilerplate repo

Adds comment annotation plugin

Adds travis.yml

Updates README

Author: matthewferry

.gitignore

@@ -0,0 +1,6 @@
+# Dependencies
+node_modules
+
+# Debugging
+*.log
+.DS_Store

.travis.yml

@@ -0,0 +1,4 @@
+language: node_js
+node_js:
+  - stable
+  - "6"

CHANGELOG.md

@@ -0,0 +1,2 @@
+# Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).

LICENSE

@@ -1,21 +1,20 @@
-MIT License
+The MIT License (MIT)
 
-Copyright (c) 2017 Matthew Ferry
+Copyright 2016 Matthew Ferry <[email protected]>
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,69 @@
+# PostCSS Comment Annotation [![Build Status][ci-img]][ci]
+
+[PostCSS] plugin for annotating comments, inspired by and based on
+[morishitter](https://github.com/morishitter)'s [CSS Annotation](https://github.com/morishitter/css-annotation).
+
+[PostCSS]: https://github.com/postcss/postcss
+[ci-img]:  https://travis-ci.org/matthewferry/postcss-comment-annotation.svg
+[ci]:      https://travis-ci.org/matthewferry/postcss-comment-annotation
+
+## Install
+`npm install postcss-comment-annotation`
+
+## Example
+Annotate your CSS with key/value pairs. Keys without a defined value
+results in a value of `true`.
+```css
+/*
+@define Foo
+
+@description
+Foo is a base component
+*/
+.foo { }
+
+/*
+@define Bar
+@parent Foo
+@modifier
+
+@description
+Bar modifies Foo
+*/
+.foo-bar { }
+```
+
+Outputs an array to `result.commentAnnotations`.
+```js
+[
+  {
+    "define": "Foo",
+    "description": "Foo is a base component"
+  }, {
+    "define": "Bar",
+    "parent": "Foo",
+    "modifier": true,
+    "description": "Bar modifies Foo"
+  }
+]
+```
+
+## Usage
+
+```js
+postcss([
+  require('postcss-comment-annotation')({
+    prefix: '@'
+  })
+])
+```
+
+## Options
+
+### prefix
+
+Takes `string`.
+Define the prefix to signify keys in your annotations.
+Default value: `@`.
+
+## [Changelog](./CHANGELOG.md)

index.js

@@ -0,0 +1,50 @@
+const postcss = require('postcss');
+
+module.exports = postcss.plugin('postcss-comment-annotation', (opts) => {
+    opts = opts || {};
+
+    const prefix = opts.prefix || '@';
+    const matchComment = `(\\${prefix}(?:\\r?\\n|.)+?)(?=\\${prefix}|$)`;
+    const matchKeyVal =
+      `\\${prefix}(\\w*)\\s((?:\\r?\\n|.)*?)(?=\\r?\\n\\r?\\n|$)`;
+    const matchBool = `\\${prefix}(\\w+)\\s*(?=\\n|$)`;
+
+    return (root, result) => {
+        result.commentAnnotations = [];
+
+        root.walkComments((comment) => {
+            const annotationArray = comment.text.match(
+                new RegExp(matchComment, 'g')
+            );
+            const annotationObj = {};
+
+            if (annotationArray) {
+                annotationArray.forEach((annotation) => {
+                    // Match @rule with single or multiline value after it
+                    if (annotation.match(new RegExp(matchKeyVal, 'g')) &&
+                      RegExp.$2 !== '\n') {
+                        const key = RegExp.$1;
+                        const val = RegExp.$2;
+
+                        val.replace(/^\s/g, '');
+
+                        // Create key:value pair
+                        annotationObj[key] = val;
+                    }
+
+                    // Match single @rule and treat as true
+                    if (annotation.match(new RegExp(matchBool, 'g'))) {
+                        const key = RegExp.$1;
+                        annotationObj[key] = annotationObj[key] || true;
+                    }
+                });
+
+                if (Object.getOwnPropertyNames(annotationObj).length !== 0) {
+                    annotationObj.type = 'comment-annotation';
+                    annotationObj.plugin = 'comment-annotation';
+                    result.commentAnnotations.push(annotationObj);
+                }
+            }
+        });
+    };
+});

index.test.js

@@ -0,0 +1,73 @@
+const postcss = require('postcss');
+const plugin = require('./');
+
+const css = `
+/*
+@define Link
+
+@boolean
+
+@description
+Pink anchors
+are super hip
+*/
+a { color: blue; }
+/* #define Empty comment block #boolean*/
+/* @define Empty comment block @boolean*/
+`;
+
+const opts = {
+    prefix: '#'
+};
+
+it('should not modify any output CSS', () => {
+    return postcss([ plugin ]).process(css)
+        .then(result => {
+            expect(result.css).toEqual(css);
+        });
+});
+
+it('should return array of objects for each annotated comment block', () => {
+    return postcss([ plugin ]).process(css)
+        .then(result => {
+            expect(result.commentAnnotations).toHaveLength(2);
+        });
+});
+
+it('should create annotation property for default prefixed keys', () => {
+    return postcss([ plugin ]).process(css)
+        .then(result => {
+            expect(result.commentAnnotations[0]).toHaveProperty('define');
+        });
+});
+
+it('should use option prefix to create annotation property', () => {
+    return postcss([plugin(opts)]).process(css)
+        .then(result => {
+            expect(result.commentAnnotations[0]).toHaveProperty('define');
+        });
+});
+
+it('should create a value for single line annotations', () => {
+    return postcss([plugin]).process(css)
+        .then(result => {
+            expect(result.commentAnnotations[0])
+                .toHaveProperty('define', 'Link');
+        });
+});
+
+it('should create a value for multi line annotations', () => {
+    return postcss([plugin]).process(css)
+        .then(result => {
+            expect(result.commentAnnotations[0])
+                .toHaveProperty('description', 'Pink anchors\nare super hip');
+        });
+});
+
+it('should take key without value as boolean', () => {
+    return postcss([plugin]).process(css)
+        .then(result => {
+            expect(result.commentAnnotations[0])
+              .toHaveProperty('boolean', true);
+        });
+});

package.json

@@ -0,0 +1,36 @@
+{
+  "name": "postcss-comment-annotation",
+  "version": "0.0.0",
+  "description": "PostCSS plugin for annotating comments",
+  "keywords": [
+    "postcss",
+    "css",
+    "postcss-plugin",
+    "comments",
+    "annotation"
+  ],
+  "author": "Matthew Ferry <[email protected]>",
+  "license": "MIT",
+  "repository": "matthewferry/postcss-comment-annotation",
+  "bugs": {
+    "url": "https://github.com/matthewferry/postcss-comment-annotation/issues"
+  },
+  "homepage": "https://github.com/matthewferry/postcss-comment-annotation",
+  "dependencies": {
+    "postcss": "^6.0.1"
+  },
+  "devDependencies": {
+    "eslint": "^3.19.0",
+    "eslint-config-postcss": "^2.0.2",
+    "jest": "^20.0.0"
+  },
+  "scripts": {
+    "test": "jest && eslint *.js"
+  },
+  "eslintConfig": {
+    "extends": "eslint-config-postcss/es5",
+    "env": {
+      "jest": true
+    }
+  }
+}