Skip to content

Commit e98723b

Browse files
wooormwooorm
committed
Use ESM
1 parent 817d6db commit e98723b

File tree

6 files changed

+77
-94
lines changed

6 files changed

+77
-94
lines changed

‎.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
.DS_Store
22
*.log
3-
.nyc_output/
43
coverage/
54
node_modules/
6-
mdast-comment-marker.js
7-
mdast-comment-marker.min.js
85
yarn.lock

‎.prettierignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,2 @@
11
coverage/
2-
mdast-comment-marker.js
3-
mdast-comment-marker.min.js
4-
*.json
52
*.md

‎index.js

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,11 @@
1-
'use strict'
2-
3-
module.exports = marker
4-
51
var commentExpression = /\s*([a-zA-Z\d-]+)(\s+([\s\S]*))?\s*/
62

73
var markerExpression = new RegExp(
84
'(\\s*<!--' + commentExpression.source + '-->\\s*)'
95
)
106

117
// Parse a comment marker.
12-
function marker(node) {
8+
export function commentMarker(node) {
139
var match
1410
var offset
1511
var parameters
@@ -27,8 +23,8 @@ function marker(node) {
2723
return {
2824
name: match[offset],
2925
attributes: match[offset + 2] || '',
30-
parameters: parameters,
31-
node: node
26+
parameters,
27+
node
3228
}
3329
}
3430
}
@@ -58,7 +54,7 @@ function parseParameters(value) {
5854
value = true
5955
} else if (value === 'false') {
6056
value = false
61-
} else if (!isNaN(value)) {
57+
} else if (!Number.isNaN(Number(value))) {
6258
value = Number(value)
6359
}
6460

‎package.json

Lines changed: 10 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -23,33 +23,25 @@
2323
"Titus Wormer <[email protected]> (https://wooorm.com)",
2424
"Masayuki Izumi <[email protected]> (http://izumin.info)"
2525
],
26+
"sideEffects": false,
27+
"type": "module",
28+
"main": "index.js",
2629
"files": [
2730
"index.js"
2831
],
2932
"devDependencies": {
30-
"browserify": "^17.0.0",
31-
"nyc": "^15.0.0",
33+
"c8": "^7.0.0",
3234
"prettier": "^2.0.0",
3335
"remark-cli": "^9.0.0",
3436
"remark-preset-wooorm": "^8.0.0",
3537
"tape": "^5.0.0",
36-
"tinyify": "^3.0.0",
3738
"xo": "^0.38.0"
3839
},
3940
"scripts": {
4041
"format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
41-
"build-bundle": "browserify . -s mdastCommentMarker -o mdast-comment-marker.js",
42-
"build-mangle": "browserify . -s mdastCommentMarker -o mdast-comment-marker.min.js -p tinyify",
43-
"build": "npm run build-bundle && npm run build-mangle",
44-
"test-api": "node test",
45-
"test-coverage": "nyc --reporter lcov tape test.js",
46-
"test": "npm run format && npm run build && npm run test-coverage"
47-
},
48-
"nyc": {
49-
"check-coverage": true,
50-
"lines": 100,
51-
"functions": 100,
52-
"branches": 100
42+
"test-api": "node test.js",
43+
"test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node test.js",
44+
"test": "npm run format && npm run test-coverage"
5345
},
5446
"prettier": {
5547
"tabWidth": 2,
@@ -61,13 +53,10 @@
6153
},
6254
"xo": {
6355
"prettier": true,
64-
"esnext": false,
6556
"rules": {
66-
"unicorn/prefer-number-properties": "off"
67-
},
68-
"ignore": [
69-
"mdast-comment-marker.js"
70-
]
57+
"no-var": "off",
58+
"prefer-arrow-callback": "off"
59+
}
7160
},
7261
"remarkConfig": {
7362
"plugins": [

‎readme.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212

1313
## Install
1414

15+
This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c):
16+
Node 12+ is needed to use it and it must be `import`ed instead of `require`d.
17+
1518
[npm][]:
1619

1720
```sh
@@ -21,25 +24,25 @@ npm install mdast-comment-marker
2124
## Use
2225

2326
```js
24-
var marker = require('mdast-comment-marker');
27+
import {commentMarker} from 'mdast-comment-marker'
2528

26-
console.log(marker({
29+
console.log(commentMarker({
2730
type: 'html',
2831
value: '<!--foo-->'
2932
}));
3033

31-
console.log(marker({
34+
console.log(commentMarker({
3235
type: 'html',
3336
value: '<!--foo bar baz=12.4 qux="test test" quux=\'false\'-->'
3437
}));
3538

36-
console.log(marker({
39+
console.log(commentMarker({
3740
type: 'html',
3841
value: '<!doctype html>'
3942
}));
4043

41-
// Also supports MDX comment nodes.
42-
console.log(marker({
44+
// Also supports MDX@1 comment nodes.
45+
console.log(commentMarker({
4346
type: 'comment',
4447
value: 'bar'
4548
}));
@@ -67,7 +70,10 @@ null
6770

6871
## API
6972

70-
### `marker(node)`
73+
This package exports the following identifiers: `commentMarker`.
74+
There is no default export.
75+
76+
### `commentMarker(node)`
7177

7278
Parse a comment marker.
7379

0 commit comments

Comments
 (0)