Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
src
test
CHANGELOG.md
LICENSE
README.md
package.json
tsconfig.json

README.md

@power-doctest/asciidoctor

A Asciidoctor parser for power-doctest.

Install

Install with npm:

npm install @power-doctest/asciidoctor

Usage

Doctest Control Annotation

@power-doctest/asciidoctor support Doctest Control Annotation as attributes.

Enable Doctest

Enable doctest for the source code.

[doctest="enabled"]
[source,javascript]
----
const str = "string";
console.log(str); // => "string"
----

Disable Doctest

Disable doctest for the source code.

[doctest="disabled"]
[source,javascript]
----
const str = "string";
console.log(str); // => "string"
----

Expected error

If the expected error is not match the result, throw error.

[doctest-error="SyntaxError"]
[source,javascript]
----
+++++INVALID SYNTAX++++
----

Doctest options

Pass options to @power-doctest/tester The inline options is preferred constructor options.

<!-- doctest:options:{ "runMode": "any" } -->
```js
if (1 === 1) {
    console.log(1); // => 1
} else{
    console.log(2); // => 2
}
```

Metadata

Attach metadata to doctest error of @power-doctest/tester. It is useful for implementing original behavior.

[doctest-meta={ "ECMAScript": 2017 }]
[source,javascript]
----
const str = "string";
console.log(str); // => "string"
----

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu

You can’t perform that action at this time.