Initial commit

Author: wooorm

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+*.log
+.nyc_output/
+coverage/
+node_modules/
+hast-util-assert.js
+hast-util-assert.min.js

.travis.yml

@@ -0,0 +1,25 @@
+language: node_js
+node_js:
+- '0.11'
+- '0.12'
+- '4.0'
+- '5.0'
+- '6.0'
+after_success: bash <(curl -s https://codecov.io/bash)
+deploy:
+  - provider: npm
+    email: [email protected]
+    api_key:
+      secure: HHbmn1y+n37maEGQxb4VXvXz0mnLU/bXTEGExtIMW6oq3oIjjXcourQJVA7AWZR3b/cSE9eNOFANTAOssiKoW3+xWnhpU/rOVLwCsO6UWkfEq5NrKU7JuD4QannITzcJ1Ti+vF7+qBxwv+QJgZyHZ23PCWk3kxZVg/sgYyIWlJexPQqcWE08962PmgcgpbEfPqw1NR2bHsioNKLsrXgUOdtQsOgx8ezCSC6A4gXs6VzEC0ewymYpmB1n9ttSOH7sR86RITdiDm4KPX5B/pHcsNgE2RnFmadaAK6M826/BppffCLMQP1ltlsucmu8tePO8wYMVVO6fh1pP/IlnAXh+Z42I0U52Q24noUwsTzl4VKwhYqXC0QybTqzglripc4rlERlGRcm8w/kqdrrkJ9X0wPFeou8ZwuOb3Jkq4SV+ZD5B8Q/WHZc6Ljt/Ur7HziN/XSaZGQi7I+IH+T7b9gDbxwsaXVJ3jH59wMy9Ch0QEln+Hnh4i2G3VP31QRlpxlxcfWrUpWs/nx16bURHPD9AyX8NhjmdgueQ/5CXBjcxMqp5l/GkugP7Arv/OkT3Q3MVSeWR9OXLDFtrVryNSdWqUpLLmMbPSygJLvjI7t/VM1SRnQbfOdfAX9H3MzqIouTaLgbUH3bLCyhuZ2nqal+V/iKLtGWISrgIdZ46bdqOTQ=
+    on:
+      tags: true
+      node: '5.0'
+  - provider: releases
+    api_key:
+      secure: qr33cSy/zb/Aw1oa3fmo4X2Wi+p95/KA98xmp1woquDGRFfxnNaLaPbe8zEju/vuGUzKSZJ2olvatXuTgk1FBPUOEoStTfzVO4MK6PM4CUy2b8HOgZckOaMY+hFZSJEaLLU7pYzuucSYGV+lEP6deDbMYL6iZb9Hg0rXvjai2RRqHZWsqFEuvLG7gsbD3vT/msF27aUTf0UwICr7upmBKj7jGNDg04zSQ+GNXjSd8F/c0DmjUTtAiCxYoNHaKDw3iKhYRwA52iWDywJMxCsGJkHTMT661jY4/TlEm10i8WkqZwCMln1CiPD+vqbasKnMo10LiInE0qse4Set5AldXDTnVF4pYxPLBq3xSLt3GbcFx1e7YUlgLAbvNDqjTluw3/Dq0plQ5co6gGyYn3rMlSJlA6kTw6NmmTDKRrheccHXoq28XQYK9yiPSTuSdJRMmx0xbsWiLn+e1jWLmc5jKLp5iOpoH89jPKsMxeQSy8CVPCApNhtEjLEg7qOEGIXWxfllH5cBhrC9lER8FcJ3rGeXMLQ6O/fr341/20nWb8uvlR7p6ItkH7HEmDQsOdhIbdxxiQlsmvL5hVoeuSzBbLvWZEtVIbxGJdRwN0gzr5WmAyZsJFjeOdtYYMK2ftG7+VwLV5c3est5JuyYkS+Rgmpi/pqpcghVCRqI1GlsSEw=
+    file:
+      - "hast-util-assert.js"
+      - "hast-util-assert.min.js"
+    on:
+      tags: true
+      node: '6.0'

LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2016 Titus Wormer <[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:
+
+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.

history.md

@@ -0,0 +1,6 @@
+<!--remark setext-->
+
+<!--lint disable no-multiple-toplevel-headings -->
+
+0.0.0 / 2016-07-25
+==================

index.js

@@ -0,0 +1,75 @@
+/**
+ * @author Titus Wormer
+ * @copyright 2016 Titus Wormer
+ * @license MIT
+ * @module hast-util-assert
+ * @fileoverview Assert `hast` nodes.
+ */
+
+'use strict';
+
+/* Dependencies. */
+var assert = require('assert');
+var zwitch = require('zwitch');
+var mapz = require('mapz');
+var unist = require('unist-util-assert');
+
+/* Construct. */
+var hast = zwitch('type');
+
+/* Expose. */
+module.exports = exports = unist.wrap(hast);
+
+exports.parent = unist.wrap(parent);
+exports.text = unist.text;
+exports.void = unist.void;
+exports.wrap = unist.wrap;
+exports.all = mapz(exports, {key: 'children', indices: false});
+
+/* Core interface. */
+hast.invalid = hast.unknown = unknown;
+
+/* Per-type handling. */
+hast.handlers = {
+  root: unist.wrap(root),
+  element: unist.wrap(element),
+  doctype: unist.wrap(doctype),
+  comment: exports.text,
+  text: exports.text
+};
+
+function unknown(node, ancestor) {
+  unist(node, ancestor);
+}
+
+function parent(node) {
+  unist.parent(node);
+  exports.all(node);
+}
+
+function root(node, ancestor) {
+  parent(node);
+
+  assert.equal(ancestor, undefined, '`root` should not have a parent');
+}
+
+function element(node) {
+  parent(node);
+
+  assert.equal(typeof node.tagName, 'string', '`element` should have a `tagName`');
+  assert.notEqual(node.tagName, '', '`element.tagName` should not be empty');
+}
+
+function doctype(node) {
+  unist.void(node);
+
+  assert.equal(typeof node.name, 'string', '`doctype` should have a `name`');
+
+  if (node.public != null) {
+    assert.equal(typeof node.public, 'string', '`doctype.public` should be `string`');
+  }
+
+  if (node.system != null) {
+    assert.equal(typeof node.system, 'string', '`doctype.system` should be `string`');
+  }
+}

package.json

@@ -0,0 +1,78 @@
+{
+  "name": "hast-util-assert",
+  "version": "0.0.0",
+  "description": "Assert HAST nodes",
+  "license": "MIT",
+  "keywords": [
+    "assert",
+    "hast",
+    "util",
+    "utility"
+  ],
+  "files": [
+    "index.js"
+  ],
+  "repository": "https://github.com/wooorm/hast-util-assert",
+  "bugs": "https://github.com/wooorm/hast-util-assert/issues",
+  "author": "Titus Wormer <[email protected]> (http://wooorm.com)",
+  "contributors": [
+    "Titus Wormer <[email protected]> (http://wooorm.com)"
+  ],
+  "dependencies": {
+    "mapz": "^1.0.0",
+    "unist-util-assert": "^1.0.0",
+    "zwitch": "^1.0.0"
+  },
+  "devDependencies": {
+    "browserify": "^13.0.1",
+    "esmangle": "^1.0.1",
+    "nyc": "^7.0.0",
+    "remark-cli": "^1.0.0",
+    "remark-comment-config": "^4.0.0",
+    "remark-github": "^5.0.0",
+    "remark-lint": "^4.0.0",
+    "remark-validate-links": "^4.0.0",
+    "tape": "^4.0.0",
+    "xo": "^0.16.0"
+  },
+  "scripts": {
+    "build-md": "remark . --quiet --frail",
+    "build-bundle": "browserify index.js -s hastUtilAssert > hast-util-assert.js",
+    "build-mangle": "esmangle < hast-util-assert.js > hast-util-assert.min.js",
+    "build": "npm run build-md && npm run build-bundle && npm run build-mangle",
+    "lint": "xo",
+    "test-api": "node test",
+    "test-coverage": "nyc --reporter lcov tape test",
+    "test": "npm run build && npm run lint && npm run test-coverage"
+  },
+  "xo": {
+    "space": true,
+    "rules": {
+      "no-eq-null": "off",
+      "eqeqeq": "off",
+      "guard-for-in": "off"
+    },
+    "ignores": [
+      "hast-util-assert.js",
+      "hast-util-assert.min.js"
+    ]
+  },
+  "nyc": {
+    "check-coverage": true,
+    "lines": 100,
+    "functions": 100,
+    "branches": 100
+  },
+  "remarkConfig": {
+    "output": true,
+    "plugins": [
+      "comment-config",
+      "github",
+      "lint",
+      "validate-links"
+    ],
+    "settings": {
+      "bullet": "*"
+    }
+  }
+}

readme.md

@@ -0,0 +1,63 @@
+# hast-util-assert [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]
+
+<!--lint disable heading-increment no-duplicate-headings-->
+
+Assert [HAST][] nodes.
+
+## Installation
+
+[npm][npm-install]:
+
+```bash
+npm install hast-util-assert
+```
+
+## Usage
+
+```javascript
+var assert = require('hast-util-assert');
+
+assert({type: 'root', children: []});
+assert({type: 'element', tagName: 'a', properties: {}, children: []});
+// All OK.
+
+assert({children: []});
+// AssertionError: node should have a type: `{ children: [] }`
+
+assert({type: 'element', properties: {}, children: []});
+// AssertionError: `element` should have a `tagName`: `{ type: 'element', properties: {}, children: [] }`
+```
+
+## API
+
+### `assert(node)`
+
+Assert that `node` is a valid [HAST][] node.  If `node` has `children`,
+all children will be asserted as well.
+
+The `assert.parent`, `assert.text`, `assert.void`, and `assert.wrap`
+methods from [`unist-util-assert`][unist-util-assert] are also included.
+
+## License
+
+[MIT][license] © [Titus Wormer][author]
+
+<!-- Definitions -->
+
+[travis-badge]: https://img.shields.io/travis/wooorm/hast-util-assert.svg
+
+[travis]: https://travis-ci.org/wooorm/hast-util-assert
+
+[codecov-badge]: https://img.shields.io/codecov/c/github/wooorm/hast-util-assert.svg
+
+[codecov]: https://codecov.io/github/wooorm/hast-util-assert
+
+[npm-install]: https://docs.npmjs.com/cli/install
+
+[license]: LICENSE
+
+[author]: http://wooorm.com
+
+[hast]: https://github.com/wooorm/hast
+
+[unist-util-assert]: https://github.com/wooorm/unist-util-assert

test/children.js

@@ -0,0 +1,53 @@
+/**
+ * @author Titus Wormer
+ * @copyright 2016 Titus Wormer
+ * @license MIT
+ * @module hast-util-assert
+ * @fileoverview Test suite for `hast-util-assert`.
+ */
+
+'use strict';
+
+/* eslint-env node */
+
+/* Dependencies. */
+var test = require('tape');
+var assert = require('..');
+
+test('children', function (t) {
+  t.throws(
+    function () {
+      assert({type: 'paragraph', children: {alpha: 'bravo'}});
+    },
+    /^AssertionError: `children` should be an array: `{ type: 'paragraph', children: { alpha: 'bravo' } }`$/,
+    'should throw if given a non-node child in children'
+  );
+
+  t.throws(
+    function () {
+      assert({type: 'paragraph', children: ['one']});
+    },
+    /^AssertionError: node should be an object: `'one'` in `{ type: 'paragraph', children: \[ 'one' \] }`$/,
+    'should throw if given a non-node child in children'
+  );
+
+  t.doesNotThrow(
+    function () {
+      assert({type: 'paragraph', children: [{type: 'text', value: 'alpha'}]});
+    },
+    'should not throw on vald children'
+  );
+
+  t.throws(
+    function () {
+      assert({type: 'paragraph', children: [{
+        type: 'bar',
+        children: ['one']
+      }]});
+    },
+    /^AssertionError: node should be an object: `'one'` in `{ type: 'bar', children: \[ 'one' \] }`$/,
+    'should throw on invalid descendants'
+  );
+
+  t.end();
+});

test/comment.js

@@ -0,0 +1,34 @@
+/**
+ * @author Titus Wormer
+ * @copyright 2016 Titus Wormer
+ * @license MIT
+ * @module hast-util-assert
+ * @fileoverview Test suite for `hast-util-assert`.
+ */
+
+'use strict';
+
+/* eslint-env node */
+
+/* Dependencies. */
+var test = require('tape');
+var assert = require('..');
+
+test('assert(comment)', function (t) {
+  t.throws(
+    function () {
+      assert({type: 'comment'});
+    },
+    /^AssertionError: text should have `value`: `{ type: 'comment' }`$/,
+    'should throw if a `comment` doesn’t have a value'
+  );
+
+  t.doesNotThrow(
+    function () {
+      assert({type: 'comment', value: 'Alpha'});
+    },
+    'should allow `value`'
+  );
+
+  t.end();
+});