Skip to content

Commit d8da8d3

Browse files
committed
Refactor code-style
1 parent e51addc commit d8da8d3

9 files changed

+96
-236
lines changed

.editorconfig

+1-7
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,8 @@ root = true
22

33
[*]
44
indent_style = space
5-
indent_size = 4
5+
indent_size = 2
66
end_of_line = lf
77
charset = utf-8
88
trim_trailing_whitespace = true
99
insert_final_newline = true
10-
11-
[*.{json,remarkrc,eslintrc,sh}]
12-
indent_size = 2
13-
14-
[*.md]
15-
trim_trailing_whitespace = false

.eslintignore

-4
This file was deleted.

.eslintrc

-6
This file was deleted.

.jscs.json

-39
This file was deleted.

example.js

+8-16
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,21 @@ var embedded = require('./index.js');
33

44
// Given a non-embedded value:
55
var result = embedded({
6-
'type': 'element',
7-
'tagName': 'a',
8-
'properties': {
9-
'href': '#alpha',
10-
'title': 'Bravo'
11-
},
12-
'children': [{
13-
'type': 'text',
14-
'value': 'Charlie'
15-
}]
6+
type: 'element',
7+
tagName: 'a',
8+
properties: {href: '#alpha', title: 'Bravo'},
9+
children: [{type: 'text', value: 'Charlie'}]
1610
});
1711

1812
// Yields:
1913
console.log('js', String(result));
2014

2115
// Given a embedded element:
2216
result = embedded({
23-
'type': 'element',
24-
'tagName': 'audio',
25-
'properties': {
26-
'src': 'delta.ogg'
27-
},
28-
'children': []
17+
type: 'element',
18+
tagName: 'audio',
19+
properties: {src: 'delta.ogg'},
20+
children: []
2921
});
3022

3123
// Yields:

index.js

+16-39
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,26 @@
1-
/**
2-
* @author Titus Wormer
3-
* @copyright 2016 Titus Wormer
4-
* @license MIT
5-
* @module rehype:lint:util:embedded
6-
*/
7-
81
'use strict';
92

10-
/* eslint-env commonjs */
11-
12-
/*
13-
* Dependencies.
14-
*/
15-
3+
/* Dependencies. */
164
var is = require('hast-util-is-element');
175

18-
/*
19-
* Tag-names.
20-
*/
6+
/* Expose. */
7+
module.exports = embedded;
218

9+
/* Tag-names. */
2210
var names = [
23-
'audio',
24-
'canvas',
25-
'embed',
26-
'iframe',
27-
'img',
28-
'math',
29-
'object',
30-
'picture',
31-
'svg',
32-
'video'
11+
'audio',
12+
'canvas',
13+
'embed',
14+
'iframe',
15+
'img',
16+
'math',
17+
'object',
18+
'picture',
19+
'svg',
20+
'video'
3321
];
3422

35-
/**
36-
* Check if a node is a embedded element
37-
*
38-
* @param {*} node - Thing to check.
39-
* @return {boolean} - Whether a node is embedded.
40-
*/
23+
/* Check if a node is a embedded element. */
4124
function embedded(node) {
42-
return is(node, names);
25+
return is(node, names);
4326
}
44-
45-
/*
46-
* Expose.
47-
*/
48-
49-
module.exports = embedded;

package.json

+9-7
Original file line numberDiff line numberDiff line change
@@ -28,29 +28,31 @@
2828
],
2929
"devDependencies": {
3030
"browserify": "^13.0.0",
31-
"eslint": "^2.0.0",
3231
"esmangle": "^1.0.1",
3332
"istanbul": "^0.4.0",
34-
"jscs": "^3.0.0",
35-
"jscs-jsdoc": "^2.0.0",
3633
"remark": "^4.0.0",
3734
"remark-comment-config": "^3.0.0",
3835
"remark-github": "^4.0.1",
3936
"remark-lint": "^3.0.0",
4037
"remark-usage": "^3.0.0",
4138
"remark-validate-links": "^3.0.0",
42-
"tape": "^4.4.0"
39+
"tape": "^4.4.0",
40+
"xo": "^0.17.0"
4341
},
4442
"scripts": {
4543
"build-md": "remark . --quiet --frail",
4644
"build-bundle": "browserify index.js --bare -s hastUtilEmbedded > hast-util-embedded.js",
4745
"build-mangle": "esmangle hast-util-embedded.js > hast-util-embedded.min.js",
4846
"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",
47+
"lint": "xo",
5248
"test-api": "node test.js",
5349
"test-coverage": "istanbul cover test.js",
5450
"test": "npm run build && npm run lint && npm run test-coverage"
51+
},
52+
"xo": {
53+
"space": true,
54+
"ignore": [
55+
"hast-util-embedded.js"
56+
]
5557
}
5658
}

readme.md

+13-41
Original file line numberDiff line numberDiff line change
@@ -15,52 +15,24 @@ globals module, [uncompressed and compressed][releases].
1515

1616
## Usage
1717

18-
Dependencies:
19-
2018
```javascript
21-
var embedded = require('hast-util-embedded');
22-
```
19+
var embedded = require('./index.js');
2320

24-
Given a non-embedded value:
25-
26-
```javascript
21+
// Given a non-embedded value:
2722
var result = embedded({
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:
23+
type: 'element',
24+
tagName: 'a',
25+
properties: {href: '#alpha', title: 'Bravo'},
26+
children: [{type: 'text', value: 'Charlie'}]
27+
}); //=> false
4228

43-
```js
44-
false
45-
```
46-
47-
Given a embedded element:
48-
49-
```javascript
29+
// Given a embedded element:
5030
result = embedded({
51-
'type': 'element',
52-
'tagName': 'audio',
53-
'properties': {
54-
'src': 'delta.ogg'
55-
},
56-
'children': []
57-
});
58-
```
59-
60-
Yields:
61-
62-
```js
63-
true
31+
type: 'element',
32+
tagName: 'audio',
33+
properties: {src: 'delta.ogg'},
34+
children: []
35+
}); //=> true
6436
```
6537

6638
## API

0 commit comments

Comments
 (0)