Skip to content

Commit 107cead

Browse files
committed
WIP: Enable doctests
1 parent 17cf09f commit 107cead

File tree

5 files changed

+27
-1
lines changed

5 files changed

+27
-1
lines changed

.config

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ repo-owner = fluture-js
33
repo-name = fluture-node
44
source-files = index.mjs
55
opening-delimiter = ```js
6+
module-type = esm

.eslintrc.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
"overrides": [
55
{
66
"files": ["README.md"],
7+
"parserOptions": {
8+
"sourceType": "module"
9+
},
710
"globals": {
811
"EventEmitter": "readonly",
912
"Future": "readonly",

index.mjs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ import Future from 'fluture';
1515
//. itself from the event emitter.
1616
//.
1717
//. ```js
18+
//. > import {EventEmitter} from 'events';
1819
//. > const emitter = new EventEmitter ();
1920
//. > setTimeout (() => emitter.emit ('answer', 42), 100);
2021
//. > once ('answer') (emitter);
@@ -46,6 +47,7 @@ export const once = event => emitter => Future ((rej, res) => {
4647
//. itself from the Stream.
4748
//.
4849
//. ```js
50+
//. > import {Readable} from 'stream';
4951
//. > const stream = new Readable ({read: () => {}});
5052
//. > setTimeout (() => {
5153
//. . stream.push ('hello');

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
"devDependencies": {
3333
"c8": "^3.4.0",
3434
"codecov": "^3.2.0",
35+
"doctest": "github:Avaq/doctest#avaq/esm",
3536
"fluture": "^11.0.1",
3637
"oletus": "^1.1.5",
3738
"rollup": "^1.1.2",

scripts/doctest

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,21 @@
11
#!/usr/bin/env bash
2-
echo 'Doctests cannot run on mjs files. Skipping :('
2+
set -eufo pipefail
3+
4+
# shellcheck source=functions
5+
source "${BASH_SOURCE%/*}/../node_modules/sanctuary-scripts/functions"
6+
7+
set +f ; shopt -s nullglob
8+
files=($(get source-files))
9+
set -f ; shopt -u nullglob
10+
11+
module="$(get module-type)"
12+
prefix="$(get comment-prefix)"
13+
opening="$(get opening-delimiter)"
14+
closing="$(get closing-delimiter)"
15+
16+
node_modules/.bin/doctest \
17+
--module "$module" \
18+
--prefix "$prefix" \
19+
--opening-delimiter "$opening" \
20+
--closing-delimiter "$closing" \
21+
-- "${files[@]}"

0 commit comments

Comments
 (0)