Release v1.0.0

voischev · voischev · commit 42ca3de0637c · 2015-09-27T00:53:36.000+03:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,22 @@
+# This file is for unifying the coding style for different editors and IDEs.
+# More information at http://EditorConfig.org
+
+# No .editorconfig files above the root directory
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+end_of_line = lf
+indent_style = space
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{bemjson.js,deps.js}]
+indent_size = 4
+
+[{bower,package}.json]
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,7 @@
+# OS
+.DS_Store
+._*
+
+# NODEJS
+node_modules
+npm-debug.log
diff --git a/.jscsrc b/.jscsrc
@@ -0,0 +1,26 @@
+{
+    "disallowSpacesInCallExpression": true,
+    "disallowSpaceAfterObjectKeys": true,
+    "disallowNewlineBeforeBlockStatements": true,
+    "disallowMultipleLineBreaks": true,
+    "requireSemicolons": true,
+    "requireFunctionDeclarations": true,
+    "requireCommaBeforeLineBreak": true,
+    "disallowTrailingComma": true,
+    "disallowTrailingWhitespace": true,
+    "disallowSpacesInFunction": {
+        "beforeOpeningRoundBrace": true
+    },
+    "requireSpacesInFunction": {
+        "beforeOpeningCurlyBrace": true
+    },
+    "disallowSpacesInConditionalExpression": {
+        "afterTest": true,
+        "afterConsequent": true
+    },
+    "excludeFiles": [
+        ".git/**",
+        "node_modules/**"
+    ],
+    "fileExtensions": [".js"]
+}
diff --git a/.jshintignore b/.jshintignore
@@ -0,0 +1 @@
+node_modules
diff --git a/.jshintrc b/.jshintrc
@@ -0,0 +1,8 @@
+{
+    "eqeqeq": true,
+    "expr": true,
+    "maxlen": 120,
+    "undef": true,
+    "unused": true,
+    "node": true
+}
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,7 @@
+node_modules/
+test/
+npm-debug.log
+.editorconfig
+.jscsrc
+.jshintignore
+.jshintrc
diff --git a/README.md b/README.md
@@ -0,0 +1,45 @@
+# PostHTML-include
+[![npm version](https://badge.fury.io/js/posthtml-include.svg)](http://badge.fury.io/js/posthtml-include)
+
+## Usage
+
+__index.html__
+```html
+<html>
+<head>
+    <title>index.html</title>
+</head>
+<body>
+    <include src="component/button/button.html">
+</body>
+</html>
+```
+
+__component/button/button.html__
+```html
+<button class="button"><div class="button__text">Button</div></button>
+```
+
+```javascript
+var posthtml = require('posthtml'),
+    html = require('fs').writeFileSync('index.html').toString();
+
+posthtml()
+    .use(require('posthtml-include')({ encoding: 'utf-8' }))
+    .process(html)
+    .then(function(result) {
+        console.log(result.html);
+        //<html>
+        //<head>
+        //    <title>index.html</title>
+        //</head>
+        //<body>
+        //    <button class="button"><div class="button__text">Text</div></button>
+        //</body>
+        //</html>
+    })
+```
+
+## Options
+
+__encoding__: default `utf-8`
diff --git a/index.js b/index.js
@@ -0,0 +1,22 @@
+var toTree = require('posthtml/lib/parser').toTree;
+var fs = require('fs');
+var path = require('path');
+
+module.exports = function(options) {
+    options = options || {};
+
+    return function(tree) {
+        tree.match({ tag: 'include' }, function(node) {
+            var src = node.attrs.src || false,
+                content;
+            if (src) {
+                content = toTree(fs.readFileSync(path.resolve(src), options.encoding || 'utf-8'));
+            }
+            return {
+                tag: false,
+                content: content
+            };
+        });
+        return tree;
+    };
+};
diff --git a/package.json b/package.json
@@ -0,0 +1,37 @@
+{
+  "name": "posthtml-include",
+  "version": "1.0.0",
+  "description": "Include file in HTML",
+  "main": "index.js",
+  "dependencies": {
+    "posthtml": "^0.3.0"
+  },
+  "devDependencies": {
+    "chai": "^3.2.0",
+    "jscs": "^1.13.1",
+    "jshint": "^2.8.0",
+    "mocha": "^2.2.5"
+  },
+  "scripts": {
+    "test": "npm run lint && mocha",
+    "lint": "jshint . && jscs . -v"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/posthtml/posthtml-include.git"
+  },
+  "keywords": [
+    "html",
+    "include",
+    "postproccessor",
+    "parser",
+    "transform",
+    "manipulation"
+  ],
+  "author": "Ivan Voischev <voischev.ivan@ya.ru>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/posthtml/posthtml-include/issues"
+  },
+  "homepage": "https://github.com/posthtml/posthtml-include#readme"
+}
diff --git a/test/blocks/button/button.html b/test/blocks/button/button.html
@@ -0,0 +1 @@
+<div class="button"><div class="button__text">Text</div></div>
diff --git a/test/mocha.opts b/test/mocha.opts
@@ -0,0 +1,2 @@
+--inline-diffs
+--reporter spec
diff --git a/test/test.js b/test/test.js
@@ -0,0 +1,30 @@
+/* jshint mocha: true, maxlen: false */
+var plugin = require('..');
+var posthtml = require('posthtml');
+var expect = require('chai').expect;
+
+var HTMLINCLUDE = '<html><head><title>Test</title></head><body><include src="./test/blocks/button/button.html"></body></html>',
+    HTML = '<html><head><title>Test</title></head><body><div class="button"><div class="button__text">Text</div></div>\n</body></html>';
+
+function test(input, output, options, done) {
+    posthtml()
+        .use(plugin(options))
+        .process(input)
+        .then(function(result) {
+            expect(output).to.eql(result.html);
+            done();
+        }).catch(function(error) {
+            done(error);
+        });
+}
+
+describe('Simple test', function() {
+    it('include html', function(done) {
+        test(
+            HTMLINCLUDE,
+            HTML,
+            { encoding: 'utf-8' },
+            done
+        );
+    });
+});

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+<div class="button"><div class="button__text">Text</div></div>`