Skip to content

Commit efd4a8e

Browse files
authored
Add Tests for Doc Examples (#184)
* add doc test examples script * fix all doc examples
1 parent c290c3b commit efd4a8e

28 files changed

+1032
-248
lines changed
+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Test Doc Examples
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
check:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v3
15+
- name: Use Node.js 18
16+
uses: actions/setup-node@v3
17+
with:
18+
node-version: 18
19+
- run: npm install
20+
- run: npm run build
21+
- run: npm run test-doc-examples

.gitignore

+4-1
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,7 @@ lib/bs
2525
.merlin
2626
.bsb.lock
2727
/node_modules/
28-
.DS_Store
28+
.DS_Store
29+
30+
31+
.examples-tests/

package-lock.json

+31
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+5-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
"clean": "rescript clean",
66
"build": "rescript",
77
"watch": "rescript build -w",
8-
"test": "node test/TestSuite.mjs && node test/TempTests.mjs"
8+
"test": "node test/TestSuite.mjs && node test/TempTests.mjs",
9+
"test-doc-examples": "node scripts/DocTests.mjs"
910
},
1011
"keywords": [
1112
"rescript"
@@ -26,7 +27,8 @@
2627
"rescript": ">=11.0.0 || ^11.1.0-rc.2"
2728
},
2829
"devDependencies": {
29-
"rescript": "11.1.0-rc.2",
30-
"@babel/code-frame": "7.18.6"
30+
"@babel/code-frame": "7.18.6",
31+
"@rescript/tools": "^0.5.0",
32+
"rescript": "11.1.0-rc.2"
3133
}
3234
}

rescript.json

+5
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,18 @@
1010
"dir": "test",
1111
"subdirs": ["intl"],
1212
"type": "dev"
13+
},
14+
{
15+
"dir": "scripts",
16+
"type": "dev"
1317
}
1418
],
1519
"suffix": ".mjs",
1620
"package-specs": {
1721
"module": "es6",
1822
"in-source": true
1923
},
24+
"bs-dev-dependencies": ["@rescript/tools"],
2025
"warnings": {
2126
"error": "+101"
2227
}

0 commit comments

Comments
 (0)