Skip to content

Commit a528905

Browse files
committed
Refactor to move core to lib/
1 parent 9841caa commit a528905

File tree

4 files changed

+59
-54
lines changed

4 files changed

+59
-54
lines changed

index.js

+2-50
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,5 @@
11
/**
2-
* @typedef {import('mdast-util-from-markdown').Extension} FromMarkdownExtension
3-
* @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
4-
*
5-
* @typedef {import('mdast-util-gfm-table').Options} Options
2+
* @typedef {import('./lib/index.js').Options} Options
63
*/
74

8-
import {
9-
gfmAutolinkLiteralFromMarkdown,
10-
gfmAutolinkLiteralToMarkdown
11-
} from 'mdast-util-gfm-autolink-literal'
12-
import {
13-
gfmFootnoteFromMarkdown,
14-
gfmFootnoteToMarkdown
15-
} from 'mdast-util-gfm-footnote'
16-
import {
17-
gfmStrikethroughFromMarkdown,
18-
gfmStrikethroughToMarkdown
19-
} from 'mdast-util-gfm-strikethrough'
20-
import {gfmTableFromMarkdown, gfmTableToMarkdown} from 'mdast-util-gfm-table'
21-
import {
22-
gfmTaskListItemFromMarkdown,
23-
gfmTaskListItemToMarkdown
24-
} from 'mdast-util-gfm-task-list-item'
25-
26-
/**
27-
* @returns {Array.<FromMarkdownExtension>}
28-
*/
29-
export function gfmFromMarkdown() {
30-
return [
31-
gfmAutolinkLiteralFromMarkdown,
32-
gfmFootnoteFromMarkdown(),
33-
gfmStrikethroughFromMarkdown,
34-
gfmTableFromMarkdown,
35-
gfmTaskListItemFromMarkdown
36-
]
37-
}
38-
39-
/**
40-
* @param {Options} [options]
41-
* @returns {ToMarkdownExtension}
42-
*/
43-
export function gfmToMarkdown(options) {
44-
return {
45-
extensions: [
46-
gfmAutolinkLiteralToMarkdown,
47-
gfmFootnoteToMarkdown(),
48-
gfmStrikethroughToMarkdown,
49-
gfmTableToMarkdown(options),
50-
gfmTaskListItemToMarkdown
51-
]
52-
}
53-
}
5+
export {gfmFromMarkdown, gfmToMarkdown} from './lib/index.js'

lib/index.js

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
/**
2+
* @typedef {import('mdast-util-from-markdown').Extension} FromMarkdownExtension
3+
* @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
4+
*
5+
* @typedef {import('mdast-util-gfm-table').Options} Options
6+
*/
7+
8+
import {
9+
gfmAutolinkLiteralFromMarkdown,
10+
gfmAutolinkLiteralToMarkdown
11+
} from 'mdast-util-gfm-autolink-literal'
12+
import {
13+
gfmFootnoteFromMarkdown,
14+
gfmFootnoteToMarkdown
15+
} from 'mdast-util-gfm-footnote'
16+
import {
17+
gfmStrikethroughFromMarkdown,
18+
gfmStrikethroughToMarkdown
19+
} from 'mdast-util-gfm-strikethrough'
20+
import {gfmTableFromMarkdown, gfmTableToMarkdown} from 'mdast-util-gfm-table'
21+
import {
22+
gfmTaskListItemFromMarkdown,
23+
gfmTaskListItemToMarkdown
24+
} from 'mdast-util-gfm-task-list-item'
25+
26+
/**
27+
* @returns {Array<FromMarkdownExtension>}
28+
*/
29+
export function gfmFromMarkdown() {
30+
return [
31+
gfmAutolinkLiteralFromMarkdown,
32+
gfmFootnoteFromMarkdown(),
33+
gfmStrikethroughFromMarkdown,
34+
gfmTableFromMarkdown,
35+
gfmTaskListItemFromMarkdown
36+
]
37+
}
38+
39+
/**
40+
* @param {Options} [options]
41+
* @returns {ToMarkdownExtension}
42+
*/
43+
export function gfmToMarkdown(options) {
44+
return {
45+
extensions: [
46+
gfmAutolinkLiteralToMarkdown,
47+
gfmFootnoteToMarkdown(),
48+
gfmStrikethroughToMarkdown,
49+
gfmTableToMarkdown(options),
50+
gfmTaskListItemToMarkdown
51+
]
52+
}
53+
}

package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
"autolink",
1818
"tagfilter",
1919
"github",
20-
"gfm",
2120
"gfm"
2221
],
2322
"repository": "syntax-tree/mdast-util-gfm",
@@ -35,6 +34,7 @@
3534
"main": "index.js",
3635
"types": "index.d.ts",
3736
"files": [
37+
"lib/",
3838
"index.d.ts",
3939
"index.js"
4040
],
@@ -65,11 +65,11 @@
6565
"xo": "^0.48.0"
6666
},
6767
"scripts": {
68-
"build": "rimraf \"*.d.ts\" && tsc && type-coverage",
68+
"build": "rimraf \"lib/**/*.d.ts\" \"*.d.ts\" && tsc && type-coverage",
6969
"format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
7070
"crawl": "node script/crawl-tests",
7171
"test-api": "node --conditions development test/index.js",
72-
"test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node --conditions development test/index.js",
72+
"test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov npm run test-api",
7373
"test": "npm run build && npm run format && npm run test-coverage"
7474
},
7575
"prettier": {

tsconfig.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"include": ["*.js"],
2+
"include": ["lib/**/*.js", "*.js"],
33
"compilerOptions": {
44
"target": "ES2020",
55
"lib": ["ES2020"],

0 commit comments

Comments
 (0)