Skip to content

Commit a59bf14

Browse files
wooormwooorm
committed
Initial commit
0 parents  commit a59bf14

File tree

14 files changed

+456
-0
lines changed

14 files changed

+456
-0
lines changed

‎.editorconfig

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 4
6+
end_of_line = lf
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
11+
[*.{json,remarkrc,eslintrc,sh}]
12+
indent_size = 2
13+
14+
[*.md]
15+
trim_trailing_whitespace = false

‎.eslintignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
coverage/
2+
example.js
3+
hast-util-heading.js
4+
hast-util-heading.min.js

‎.eslintrc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"extends": "eslint:recommended",
3+
"rules": {
4+
"quotes": [2, "single"]
5+
}
6+
}

‎.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.DS_Store
2+
*.log
3+
coverage/
4+
node_modules/
5+
hast-util-heading.js
6+
hast-util-heading.min.js

‎.jscs.json

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{
2+
"excludeFiles": [
3+
"coverage/",
4+
"node_modules/",
5+
"hast-util-heading.js",
6+
"hast-util-heading.min.js"
7+
],
8+
"preset": "crockford",
9+
"requireMultipleVarDecl": false,
10+
"disallowDanglingUnderscores": false,
11+
"requireQuotedKeysInObjects": true,
12+
"disallowKeywords": [
13+
"with"
14+
],
15+
"maximumLineLength": {
16+
"value": 79,
17+
"allExcept": [
18+
"regex",
19+
"urlComments"
20+
]
21+
},
22+
"jsDoc": {
23+
"checkAnnotations": "jsdoc3",
24+
"checkParamExistence": true,
25+
"checkParamNames": true,
26+
"checkRedundantAccess": true,
27+
"checkRedundantParams": true,
28+
"checkRedundantReturns": true,
29+
"checkReturnTypes": true,
30+
"checkTypes": "strictNativeCase",
31+
"enforceExistence": true,
32+
"requireHyphenBeforeDescription": true,
33+
"requireNewlineAfterDescription": true,
34+
"requireParamDescription": true,
35+
"requireParamTypes": true,
36+
"requireReturnDescription": true,
37+
"requireReturnTypes": true
38+
}
39+
}

‎.remarkrc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"output": true,
3+
"plugins": [
4+
"lint",
5+
"github",
6+
"comment-config",
7+
"usage",
8+
"validate-links"
9+
],
10+
"settings": {
11+
"bullet": "*"
12+
}
13+
}

‎.travis.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
language: node_js
2+
node_js:
3+
- '0.10'
4+
- '0.11'
5+
- '0.12'
6+
- '4.0'
7+
- '5.0'
8+
sudo: false
9+
after_script: npm install codecov.io && cat ./coverage/lcov.info | codecov
10+
deploy:
11+
- provider: npm
12+
email: [email protected]
13+
api_key:
14+
secure: GuyQb5lT+KW98E+28U2AHLFciSqMJWjdJ+kIlXXPh468yQQHACteIojMPsQpnUVsAg+CRXheRAw5gmgKFVmTdlVrAb4a9T39AzGhBKz4XfuJgrS8Zuo9nMs7nYyWt2LJG/OxX908jOWz0SFSSER1QJhZUpdYEvpfR8oJ1VJ5cZ3QQa37tFBIou4blx7BVFwiplaAuKJP8gkW7EvKx8T936rLQxc+S6ai8sG81n5u5/Kwf757fhJ6InkKkcdQzUXUSqdgWQgzJpF10oOb96TmfPtG1Lf9o5yccptFwAthRmSd/STWVQ7k3qvebSqqceqgjEfG211Pv9YwfOcHSj2dbOGCaFX0BvRKaYSmW6wUrzEegfuDHPRli8w9mTTFhiXQwG5Qbko0jyOgP2wFLjWoSiY/IzaXfKYpnHxpORVy+x+v6ZS1pJdGBz/GVxZB4pISRrN3IXzonmNfwgUf0UBhXJw0zkugey9IKtUllJ8hiMZigkv5YMwJCHxwBegFK9kGhzhUhRCZg+tjC6SjEI8SOhKUyfAZ+3GOPypqydjdnDiIna0z/55ZrM3UFsqmaXebU/hg7wLRMonui40uoeJA/d8ZR+D24q1fgFxMlBHc09N/St6K03m+i4eMERAJdAb0L0moq6GbBsR6Kj5MVIi5Gp2I3l/OX65k/jmuyc/C3Uc=
15+
on:
16+
tags: true
17+
node: '5.0'
18+
- provider: releases
19+
api_key:
20+
secure: WaxZjnRzm0ukt+H8EBi6XAqlIkPTwCh0GXW1ZwnupsNetKriEDNQUgaX8nrRpSLHC6c64SpEwRYqzFs7pyTLmwY7l2gPunxU+Eyzaq91FHgN/RXhErPUpVgApGdepLi7xY6YUu0xQ7jfGBj2CAK9effUsTftZ/ro7KV7EV3Fp4U4ARoAjVNgmTgeFecIUzQQxC2NtmfUhqb7U+x9n+lRGJc+/SVMjMEZcRf32H9HAzXCFnrstYulCyIHNT8PEctj+anarq5df16+Wo1b5AIm1gVDyxK6cwg71es/h8ymj5g8AcSD/WZFBn8bAYfinx5nGvkI/kTEoM8DocWW6eFKnE0q2oCzUsJn9pDMeaL1Bk+6lNaqNYxykcHfgK1ejpY0n3olQmrOSLhluwdS22hbp5D3S0kdG7pMAQUCzeHKn+U7hRB7iEwTkvdPYq9lASJSJx+IyAQ3hbxNqKFQ9RVNcCY36kLuaN8JbWYsNxowk3vaWmoAGKaozPYBGtoCL/ShAJw1mM/M+mjBB6eIY7b8B4sRBwQMxBfGpgyEAT0sRTQVaaQIzQD3fjBjdeWHhSSrH0XAXcvDfV5p8j5V6bZ7dmPRqXB2SxxsNrfBgSf3Tk1Z/Fwn1eUrnLdrtnIoMXFW8zQq+vCK4uHmheqCw47nyzXcpaA8VRZrggQJ323yjm0=
21+
file:
22+
- "hast-util-heading.js"
23+
- "hast-util-heading.min.js"
24+
on:
25+
tags: true

‎LICENSE

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
(The MIT License)
2+
3+
Copyright (c) 2016 Titus Wormer <[email protected]>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining
6+
a copy of this software and associated documentation files (the
7+
'Software'), to deal in the Software without restriction, including
8+
without limitation the rights to use, copy, modify, merge, publish,
9+
distribute, sublicense, and/or sell copies of the Software, and to
10+
permit persons to whom the Software is furnished to do so, subject to
11+
the following conditions:
12+
13+
The above copyright notice and this permission notice shall be
14+
included in all copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
17+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎example.js

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
// Dependencies:
2+
var heading = require('./index.js');
3+
4+
// Given a non-heading value:
5+
var result = heading({
6+
'type': 'element',
7+
'tagName': 'a',
8+
'properties': {
9+
'href': '#alpha',
10+
'title': 'Bravo'
11+
},
12+
'children': [{
13+
'type': 'text',
14+
'value': 'Charlie'
15+
}]
16+
});
17+
18+
// Yields:
19+
console.log('js', String(result));
20+
21+
// Given a heading element:
22+
result = heading({
23+
'type': 'element',
24+
'tagName': 'h1',
25+
'children': [{
26+
'type': 'text',
27+
'value': 'Delta'
28+
}]
29+
});
30+
31+
// Yields:
32+
console.log('js', String(result));

‎history.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<!--remark setext-->
2+
3+
<!--lint disable no-multiple-toplevel-headings-->
4+
5+
0.0.0 / 2016-04-17
6+
==================

‎index.js

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
/**
2+
* @author Titus Wormer
3+
* @copyright 2016 Titus Wormer
4+
* @license MIT
5+
* @module rehype:lint:util:heading
6+
*/
7+
8+
'use strict';
9+
10+
/* eslint-env commonjs */
11+
12+
/*
13+
* Dependencies.
14+
*/
15+
16+
var is = require('hast-util-is-element');
17+
18+
/*
19+
* Tag-names.
20+
*/
21+
22+
var names = [
23+
'h1',
24+
'h2',
25+
'h3',
26+
'h4',
27+
'h5',
28+
'h6',
29+
'hgroup'
30+
];
31+
32+
/**
33+
* Check if a node is a heading element
34+
*
35+
* @param {*} node - Thing to check.
36+
* @return {boolean} - Whether a node is heading.
37+
*/
38+
function heading(node) {
39+
return is(node, names);
40+
}
41+
42+
/*
43+
* Expose.
44+
*/
45+
46+
module.exports = heading;

‎package.json

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
{
2+
"name": "hast-util-heading",
3+
"version": "0.0.0",
4+
"description": "Check if a node is a heading element",
5+
"license": "MIT",
6+
"keywords": [
7+
"hast",
8+
"html",
9+
"category",
10+
"heading",
11+
"util",
12+
"utility"
13+
],
14+
"dependencies": {
15+
"hast-util-is-element": "^1.0.0"
16+
},
17+
"files": [
18+
"index.js"
19+
],
20+
"repository": {
21+
"type": "git",
22+
"url": "https://github.com/wooorm/hast-util-heading.git"
23+
},
24+
"bugs": "https://github.com/wooorm/hast-util-heading/issues",
25+
"author": "Titus Wormer <[email protected]> (http://wooorm.com)",
26+
"contributors": [
27+
"Titus Wormer <[email protected]> (http://wooorm.com)"
28+
],
29+
"devDependencies": {
30+
"browserify": "^13.0.0",
31+
"eslint": "^2.0.0",
32+
"esmangle": "^1.0.1",
33+
"istanbul": "^0.4.0",
34+
"jscs": "^3.0.0",
35+
"jscs-jsdoc": "^2.0.0",
36+
"remark": "^4.0.0",
37+
"remark-comment-config": "^3.0.0",
38+
"remark-github": "^4.0.1",
39+
"remark-lint": "^3.0.0",
40+
"remark-usage": "^3.0.0",
41+
"remark-validate-links": "^3.0.0",
42+
"tape": "^4.4.0"
43+
},
44+
"scripts": {
45+
"build-md": "remark . --quiet --frail",
46+
"build-bundle": "browserify index.js --bare -s hastUtilHeading > hast-util-heading.js",
47+
"build-mangle": "esmangle hast-util-heading.js > hast-util-heading.min.js",
48+
"build": "npm run build-md && npm run build-bundle && npm run build-mangle",
49+
"lint-api": "eslint .",
50+
"lint-style": "jscs --reporter inline .",
51+
"lint": "npm run lint-api && npm run lint-style",
52+
"test-api": "node test.js",
53+
"test-coverage": "istanbul cover test.js",
54+
"test": "npm run build && npm run lint && npm run test-coverage"
55+
}
56+
}

‎readme.md

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# hast-util-heading [![Build Status][build-badge]][build-page] [![Coverage Status][coverage-badge]][coverage-page]
2+
3+
Check if a [node][] is a [**heading**][spec] [element][].
4+
5+
## Installation
6+
7+
[npm][]:
8+
9+
```bash
10+
npm install hast-util-heading
11+
```
12+
13+
**hast-util-heading** is also available as an AMD, CommonJS, and
14+
globals module, [uncompressed and compressed][releases].
15+
16+
## Usage
17+
18+
Dependencies:
19+
20+
```javascript
21+
var heading = require('hast-util-heading');
22+
```
23+
24+
Given a non-heading value:
25+
26+
```javascript
27+
var result = heading({
28+
'type': 'element',
29+
'tagName': 'a',
30+
'properties': {
31+
'href': '#alpha',
32+
'title': 'Bravo'
33+
},
34+
'children': [{
35+
'type': 'text',
36+
'value': 'Charlie'
37+
}]
38+
});
39+
```
40+
41+
Yields:
42+
43+
```js
44+
false
45+
```
46+
47+
Given a heading element:
48+
49+
```javascript
50+
result = heading({
51+
'type': 'element',
52+
'tagName': 'h1',
53+
'children': [{
54+
'type': 'text',
55+
'value': 'Delta'
56+
}]
57+
});
58+
```
59+
60+
Yields:
61+
62+
```js
63+
true
64+
```
65+
66+
## API
67+
68+
### `heading(node)`
69+
70+
Check if the given value is a [**heading**][spec] [element][].
71+
72+
**Parameters**: `node` (`*`) — Value to check.
73+
74+
**Returns**: `boolean`, whether `node` passes the test.
75+
76+
## License
77+
78+
[MIT][license] © [Titus Wormer][author]
79+
80+
<!-- Definition -->
81+
82+
[build-badge]: https://img.shields.io/travis/wooorm/hast-util-heading.svg
83+
84+
[build-page]: https://travis-ci.org/wooorm/hast-util-heading
85+
86+
[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/hast-util-heading.svg
87+
88+
[coverage-page]: https://codecov.io/github/wooorm/hast-util-heading?branch=master
89+
90+
[npm]: https://docs.npmjs.com/cli/install
91+
92+
[releases]: https://github.com/wooorm/hast-util-heading/releases
93+
94+
[license]: LICENSE
95+
96+
[author]: http://wooorm.com
97+
98+
[node]: https://github.com/wooorm/hast#node
99+
100+
[element]: https://github.com/wooorm/hast#element
101+
102+
[spec]: https://html.spec.whatwg.org/#heading-content

0 commit comments

Comments
 (0)