Skip to content
This repository was archived by the owner on Mar 28, 2023. It is now read-only.

Improving types, readme & tests #85

Open
corollari wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Improving types, readme & tests #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
cc43ea9
Generate markdown readme on CI
corollari Sep 2, 2020
cf60a6a
Add type declaration generation
corollari Sep 2, 2020
3d02097
Update package-lock
corollari Sep 2, 2020
9008ac0
Fix example code on readme
corollari Sep 3, 2020
33e946a
Update mocha
corollari Sep 3, 2020
d0141f0
Update tests
corollari Sep 3, 2020
7936f15
Add type generation to CI
corollari Sep 3, 2020
97ca109
Bump node version (ESM imports don't work on 12.11)
corollari Sep 10, 2020
f2da1ab
Fix import statement
corollari Sep 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion .github/workflows/node.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:

strategy:
matrix:
node-version: [12.11.x]
node-version: [12.18.x]

steps:
- uses: actions/checkout@v2
Expand All @@ -28,9 +28,16 @@ jobs:
- run: npm ci
- run: npm run lint
- run: npm run build --if-present
- run: npm run generate:types
- run: npm test
env:
CI: true
- name: Install asciidoctor
run: sudo apt-get install asciidoctor
- name: Install pandoc
run: wget https://github.com/jgm/pandoc/releases/download/2.10.1/pandoc-2.10.1-1-amd64.deb && sudo dpkg -i pandoc-2.10.1-1-amd64.deb
- name: Convert readme to markdown
run: asciidoctor README.adoc -b docbook -o - | pandoc -f docbook -t gfm > README.md
Copy link
Copy Markdown
Contributor

@Shadowfiend Shadowfiend Sep 22, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I experimented with this a bit the other day---I think the move here is:

asciidoctor README.adoc -o - | pandoc -f html -t markdown_strict - -o README.md

Going through HTML seems to produce better Markdown output (e.g., it includes the Table of Contents and title) than using Docbook as the intermediary.

Copy link
Copy Markdown
Contributor Author

@corollari corollari Sep 23, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see, that's probably better than my command since I didn't directly compare the results achieved when using different intermediary formats.

- if: contains(github.ref, 'releases/ropsten')
name: Bump and publish npm package
env:
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,5 @@ build/
**.swp
**.swo
.DS_Store
README.md
types
13 changes: 3 additions & 10 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,9 @@ const tbtc = await TBTC.withConfig({
web3: web3,
bitcoinNetwork: "testnet",
electrum: {
"testnet": {
"server": "electrumx-server.test.tbtc.network",
"port": 50002,
"protocol": "ssl"
},
"testnetWS": {
"server": "electrumx-server.test.tbtc.network",
"port": 50003,
"protocol": "ws"
}
server: "electrumx-server.test.tbtc.network",
port: 8443,
protocol: "wss"
Copy link
Copy Markdown
Contributor

@Shadowfiend Shadowfiend Sep 22, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

},
})
```
Expand Down
Loading