Skip to content

Commit

Permalink
Merge pull request #1008 from onflow/supun/docgen-npm
Browse files Browse the repository at this point in the history
  • Loading branch information
turbolent committed Jun 15, 2021
2 parents 6ee555d + 87a317b commit 81729d2
Show file tree
Hide file tree
Showing 14 changed files with 5,422 additions and 25 deletions.
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -74,5 +74,6 @@ check-tidy: generate
release:
@(VERSIONED_FILES="version.go \
npm-packages/cadence-parser/package.json \
npm-packages/cadence-language-server/package.json" \
npm-packages/cadence-language-server/package.json \
npm-packages/cadence-docgen/package.json" \
./bump-version.sh $(bump))
1 change: 1 addition & 0 deletions npm-packages/cadence-docgen/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
dist
30 changes: 30 additions & 0 deletions npm-packages/cadence-docgen/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Cadence Documentation Generator

The [Cadence](https://github.com/onflow/cadence) docgen tool compiled to WebAssembly and bundled as an NPM package,
so it can be used in tools written in JavaScript.

## Usage

```js
import {CadenceDocgen} from "@onflow/cadence-docgen"

const docgen = await CadenceDocgen.create("cadence-docgen.wasm")

const docs = docgen.generate(`
/// This is a simple function with a doc-comment.
pub fun hello() {
}
`)
```

## Development

- Building the docgen WASM binary:

```sh
cd ../../tools/docgen/wasm/

GOARCH=wasm GOOS=js go build -o ../../../npm-packages/cadence-docgen/dist/cadence-docgen.wasm
```

<!-- Cannot build from current location due to: https://github.com/golang/go/issues/43733 -->
8 changes: 8 additions & 0 deletions npm-packages/cadence-docgen/jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
module.exports = {
testEnvironment: 'node',
"transform": {
"^.+\\.[tj]s$": "ts-jest"
},
setupFilesAfterEnv: [ './tests/setup.js' ],
testPathIgnorePatterns: ["/node_modules/", "/dist/"]
};
Loading

0 comments on commit 81729d2

Please sign in to comment.