Skip to content

Commit ba2dcc4

Browse files
DavidWellsDavidWells
committed
add tests
1 parent cb70e29 commit ba2dcc4

13 files changed

Lines changed: 440 additions & 17 deletions

‎cli.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/usr/bin/env node
22
const mri = require('mri')
3-
const { runCli } = require('./lib/cli')
3+
const { runCli } = require('./src/cli')
44
const argv = process.argv.slice(2)
55
const cliArgs = mri(argv)
66

‎docs/1_Getting-Started.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ If you have a `markdown.config.js` file where `markdown-magic` is invoked, it wi
5050

5151
<!-- ⛔️ MD-MAGIC-EXAMPLE:START CODE src=../examples/0_zero-config.js -->
5252
```js
53-
const { markdownMagic } = require('../lib')
53+
const { markdownMagic } = require('../src')
5454

5555
/* By default all .md files in cwd will be processed */
5656
markdownMagic().then((results) => {

‎examples/0_zero-config.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
const { markdownMagic } = require('../lib')
1+
const { markdownMagic } = require('../src')
22

33
/* By default all .md files in cwd will be processed */
44
markdownMagic().then((results) => {

‎examples/1_simple.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
const { markdownMagic } = require('../lib')
1+
const { markdownMagic } = require('../src')
22

33
const files = [
44
// 'test/fixtures/md/transform-remote.md',

‎examples/2_with-options.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
const { markdownMagic } = require('../lib')
1+
const { markdownMagic } = require('../src')
22

33
const files = [
44
'test/fixtures/md/transform-remote.md',

‎examples/generate-readme.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
const path = require('path')
22
const { readFileSync } = require('fs')
33
const { parseComments } = require('doxxx')
4-
const { markdownMagic } = require('../lib')
5-
const { deepLog } = require('../lib/utils/logs')
4+
const { markdownMagic } = require('../src')
5+
const { deepLog } = require('../src/utils/logs')
66

77
const config = {
88
matchWord: 'MD-MAGIC-EXAMPLE', // default matchWord is AUTO-GENERATED-CONTENT

‎test/errors.test.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
const path = require('path')
22
const { test } = require('uvu')
33
const assert = require('uvu/assert')
4-
const { markdownMagic } = require('../lib')
5-
const { deepLog } = require('../lib/utils/logs')
4+
const { markdownMagic } = require('../src')
5+
const { deepLog } = require('../src/utils/logs')
66

77
const {
88
MARKDOWN_FIXTURE_DIR,

‎test/fixtures/md/broken-whitespace-file.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Hi
2+
3+
This is an example of a file with wacky indentation.
4+
5+
Word count:
6+
7+
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s.
8+
9+
<!-- doc-gen x-->
10+
x
11+
<!-- end-doc-gen -->
12+
13+
Very nice
14+
15+
<!--- doc-gen(TOC) foo={{ rad: 'orange' }} ------>
16+
- [Testing](#testing)
17+
<!-- end-doc-gen -->
18+
19+
<!-- doc-gen {{functionNamex}} foo={{ rad: 'orange' }} ------>
20+
nice
21+
<!-- end-doc-gen -->
22+
23+
# Testing
24+
25+
1. text
26+
27+
<!-- doc-gen {{functionName}} foo={{ rad: 'yellow' }} -->
28+
xyz <!-- end-doc-gen -->
29+
30+
2. lol
31+
32+
33+
<!-- doc-gen lol -->
34+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer vitae mauris arcu, eu pretium nisi.
35+
Praesent fringilla ornare ullamcorper. Pellentesque diam orci, sodales in blandit ut, placerat quis felis.
36+
Vestibulum at sem massa, in tempus nisi.
37+
Vivamus ut fermentum odio. Etiam porttitor faucibus volutpat.
38+
Vivamus vitae mi ligula, non hendrerit urna. Suspendisse potenti. Quisque eget massa a massa semper mollis. <!-- end-doc-gen -->
39+
40+
41+
<!-- ⛔️ doc-gen (CODE:src=../local-code-file.js&lines=2-4) -->
42+
```js
43+
const html = {
44+
tags: [
45+
'<!--',
46+
``` <!-- ⛔️ end-doc-gen -->
47+
48+
<!-- ⛔️ doc-gen CODE src="../local-code-file.js" lines={[3, 7]} -->
49+
```js
50+
tags: [
51+
'<!--',
52+
'-->'
53+
],
54+
pattern: [
55+
```
56+
<!-- ⛔️ end-doc-gen -->
57+
58+
<!-- ⛔️ doc-gen CODE src="../local-code-id.js" id="3_5" -->
59+
```js
60+
const me = await linearClient.viewer;
61+
const myIssues = await me.assignedIssues();
62+
const myFirstIssue = myIssues.nodes[0];
63+
const myFirstIssueComments = await myFirstIssue.comments();
64+
const myFirstIssueFirstComment = myFirstIssueComments.nodes[0];
65+
const myFirstIssueFirstCommentUser = await myFirstIssueFirstComment.user;
66+
```
67+
<!-- ⛔️ end-doc-gen -->
68+
69+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer vitae mauris arcu, eu pretium nisi. Praesent fringilla ornare ullamcorper. Pellentesque diam orci, sodales in blandit ut, placerat quis felis. Vestibulum at sem massa, in tempus nisi. Vivamus ut fermentum odio. Etiam porttitor faucibus volutpat. Vivamus vitae mi ligula, non hendrerit urna. Suspendisse potenti. Quisque eget massa a massa semper mollis.
70+
71+
<!-- doc-gen functionName foo={{ rad: 'bar' }} -->xyz<!--end-doc-gen-->

0 commit comments

Comments
 (0)