This repository has been archived by the owner on Nov 22, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit a841de5
Showing
18 changed files
with
5,534 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
node_modules | ||
build | ||
lib | ||
src/**.js | ||
|
||
coverage | ||
.nyc_output | ||
*.log | ||
tmp |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
config | ||
examples | ||
tsconfig.json | ||
tslint.json | ||
.travis.yml | ||
.github | ||
|
||
coverage | ||
.nyc_output | ||
*.log | ||
proto | ||
.vscode | ||
tmp |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
sudo: false | ||
language: node_js | ||
node_js: | ||
- 6 | ||
after_success: | ||
- yarn send-coverage |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
{ | ||
// Use IntelliSense to learn about possible Node.js debug attributes. | ||
// Hover to view descriptions of existing attributes. | ||
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 | ||
"version": "0.2.0", | ||
"configurations": [ | ||
{ | ||
"type": "node", | ||
"request": "attach", | ||
"name": "Attach to Process", | ||
"address": "localhost", | ||
"port": 5858, | ||
"outFiles": [ | ||
"lib" | ||
] | ||
}, | ||
{ | ||
"type": "node2", | ||
"request": "launch", | ||
"name": "Launch index.spec.js", | ||
"program": "${workspaceRoot}/lib/index.spec.js", | ||
"cwd": "${workspaceRoot}", | ||
"sourceMaps": true, | ||
"runtimeArgs": [ | ||
"${workspaceRoot}/node_modules/ava/profile.js" | ||
] | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,131 @@ | ||
# Change Log | ||
|
||
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. | ||
|
||
<a name="0.5.14"></a> | ||
## [0.5.14](https://github.com/hawkly/hawkly-grpc-javascript/compare/v0.5.13...v0.5.14) (2017-03-13) | ||
|
||
|
||
|
||
<a name="0.5.13"></a> | ||
## [0.5.13](https://github.com/hawkly/hawkly-grpc-javascript/compare/v0.5.12...v0.5.13) (2017-03-13) | ||
|
||
|
||
|
||
<a name="0.5.12"></a> | ||
## [0.5.12](https://github.com/hawkly/hawkly-grpc-javascript/compare/v0.5.11...v0.5.12) (2017-03-13) | ||
|
||
|
||
|
||
<a name="0.5.11"></a> | ||
## [0.5.11](https://github.com/hawkly/hawkly-grpc-javascript/compare/v0.5.10...v0.5.11) (2017-03-13) | ||
|
||
|
||
|
||
<a name="0.5.10"></a> | ||
## [0.5.10](https://github.com/hawkly/hawkly-grpc-javascript/compare/v0.5.9...v0.5.10) (2017-03-12) | ||
|
||
|
||
|
||
<a name="0.5.9"></a> | ||
## [0.5.9](https://github.com/hawkly/hawkly-grpc-javascript/compare/v0.5.8...v0.5.9) (2017-03-12) | ||
|
||
|
||
|
||
<a name="0.5.8"></a> | ||
## [0.5.8](https://github.com/hawkly/hawkly-grpc-javascript/compare/v0.5.7...v0.5.8) (2017-03-12) | ||
|
||
|
||
|
||
<a name="0.5.7"></a> | ||
## [0.5.7](https://github.com/hawkly/hawkly-grpc-javascript/compare/v0.5.6...v0.5.7) (2017-03-12) | ||
|
||
|
||
|
||
<a name="0.5.6"></a> | ||
## [0.5.6](https://github.com/hawkly/hawkly-grpc-javascript/compare/v0.5.5...v0.5.6) (2017-03-11) | ||
|
||
|
||
|
||
<a name="0.5.5"></a> | ||
## [0.5.5](https://github.com/hawkly/hawkly-grpc-javascript/compare/v0.5.4...v0.5.5) (2017-03-10) | ||
|
||
|
||
|
||
<a name="0.5.4"></a> | ||
## [0.5.4](https://github.com/hawkly/hawkly-grpc-javascript/compare/v0.5.3...v0.5.4) (2017-03-10) | ||
|
||
|
||
|
||
<a name="0.5.3"></a> | ||
## [0.5.3](https://github.com/hawkly/hawkly-grpc-javascript/compare/v0.5.2...v0.5.3) (2017-03-10) | ||
|
||
|
||
|
||
<a name="0.5.2"></a> | ||
## [0.5.2](https://github.com/hawkly/hawkly-grpc-javascript/compare/v0.5.1...v0.5.2) (2017-03-10) | ||
|
||
|
||
|
||
<a name="0.5.1"></a> | ||
## 0.5.1 (2017-03-10) | ||
|
||
|
||
|
||
<a name="0.5.12"></a> | ||
## [0.5.12](https://github.com/hawkly/hawkly-tracer-javascript/compare/v0.5.11...v0.5.12) (2017-03-02) | ||
|
||
|
||
|
||
<a name="0.5.11"></a> | ||
## [0.5.11](https://github.com/hawkly/hawkly-tracer-javascript/compare/v0.5.10...v0.5.11) (2017-03-02) | ||
|
||
|
||
|
||
<a name="0.5.10"></a> | ||
## [0.5.10](https://github.com/hawkly/hawkly-tracer-javascript/compare/v0.5.9...v0.5.10) (2017-03-02) | ||
|
||
|
||
|
||
<a name="0.5.9"></a> | ||
## [0.5.9](https://github.com/hawkly/hawkly-tracer-javascript/compare/v0.5.8...v0.5.9) (2017-03-02) | ||
|
||
|
||
|
||
<a name="0.5.8"></a> | ||
## [0.5.8](https://github.com/hawkly/hawkly-tracer-javascript/compare/v0.5.7...v0.5.8) (2017-03-02) | ||
|
||
|
||
|
||
<a name="0.5.7"></a> | ||
## [0.5.7](https://github.com/hawkly/hawkly-tracer-javascript/compare/v0.5.6...v0.5.7) (2017-03-02) | ||
|
||
|
||
|
||
<a name="0.5.6"></a> | ||
## [0.5.6](https://github.com/hawkly/hawkly-tracer-javascript/compare/v0.5.5...v0.5.6) (2017-03-01) | ||
|
||
|
||
|
||
<a name="0.5.5"></a> | ||
## [0.5.5](https://github.com/hawkly/hawkly-tracer-javascript/compare/v0.5.4...v0.5.5) (2017-03-01) | ||
|
||
|
||
|
||
<a name="0.5.4"></a> | ||
## [0.5.4](https://github.com/hawkly/hawkly-tracer-javascript/compare/v0.5.3...v0.5.4) (2017-03-01) | ||
|
||
|
||
|
||
<a name="0.5.3"></a> | ||
## [0.5.3](https://github.com/hawkly/hawkly-tracer-javascript/compare/v0.5.2...v0.5.3) (2017-03-01) | ||
|
||
|
||
|
||
<a name="0.5.2"></a> | ||
## [0.5.2](https://github.com/hawkly/hawkly-tracer-javascript/compare/v0.5.1...v0.5.2) (2017-03-01) | ||
|
||
|
||
|
||
<a name="0.5.1"></a> | ||
## 0.5.1 (2017-03-01) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
|
||
## Development zen | ||
|
||
This starter includes a watch task which makes development faster and more interactive. It's particularly helpful for [TDD](https://en.wikipedia.org/wiki/Test-driven_development)/[BDD](https://en.wikipedia.org/wiki/Behavior-driven_development) workflows. | ||
|
||
To start working, [install Yarn](https://yarnpkg.com/en/docs/getting-started) and run: | ||
|
||
``` | ||
yarn watch | ||
``` | ||
|
||
## View test coverage | ||
|
||
To generate and view test coverage, run: | ||
```bash | ||
yarn cov | ||
``` | ||
|
||
This will create an HTML report of test coverage – source-mapped back to Typescript – and open it in your default browser. | ||
|
||
<p align="center"> | ||
<img height="600" alt="source-mapped typescript test coverage example" src="https://cloud.githubusercontent.com/assets/904007/22909301/5164c83a-f221-11e6-9d7c-72c924fde450.png"> | ||
</p> | ||
|
||
## Generate your API docs | ||
|
||
The src folder is analyzed and documentation is automatically generated using [typedoc](https://github.com/TypeStrong/typedoc). | ||
|
||
```bash | ||
yarn docs | ||
``` | ||
This command generates API documentation for your library in HTML format. | ||
|
||
Since types are tracked by Typescript, there's no need to indicate types in JSDoc format. For more information, see the [typedoc documentation](http://typedoc.org/guides/doccomments/). | ||
|
||
<p align="center"> | ||
<img height="500" alt="typedoc documentation example" src="https://cloud.githubusercontent.com/assets/904007/22909419/085b9e38-f222-11e6-996e-c7a86390478c.png"> | ||
</p> | ||
|
||
For more advanced documentation generation, you can provide your own [typedoc theme](http://typedoc.org/guides/themes/), or [build your own documentation](https://blog.cloudflare.com/generating-documentation-for-typescript-projects/) using the JSON typedoc export: | ||
|
||
```bash | ||
yarn docs:json | ||
``` | ||
|
||
## Generate/update changelog & release | ||
|
||
This project is tooled for [Conventional Changelog](https://github.com/conventional-changelog/conventional-changelog) to make managing releases easier. See the [standard-version](https://github.com/conventional-changelog/standard-version) documentation for more information on the workflow, or [`CHANGELOG.md`](CHANGELOG.md) for an example. | ||
|
||
```bash | ||
# bump package.json version, update CHANGELOG.md, git tag the release | ||
yarn release | ||
# Release without bumping package.json version | ||
yarn release -- --first-release | ||
# PGP sign the release | ||
yarn release -- --sign | ||
``` | ||
|
||
## All package scripts | ||
|
||
You can run the `info` script for information on each available package script. | ||
|
||
``` | ||
yarn run info | ||
info: | ||
Display information about the scripts | ||
build: | ||
(Trash and re)build the library | ||
lint: | ||
Lint all typescript source files | ||
unit: | ||
Run unit tests | ||
test: | ||
Lint and test the library | ||
watch: | ||
Watch source files, rebuild library on changes, rerun relevant tests | ||
watch:build: | ||
Watch source files, rebuild library on changes | ||
watch:unit: | ||
Watch the build, rerun relevant tests on changes | ||
cov: | ||
Run tests, generate the HTML coverage report, and open it in a browser | ||
html-coverage: | ||
Output HTML test coverage report | ||
send-coverage: | ||
Output lcov test coverage report and send it to codecov | ||
docs: | ||
Generate API documentation and open it in a browser | ||
docs:json: | ||
Generate API documentation in typedoc JSON format | ||
release: | ||
Bump package.json version, update CHANGELOG.md, tag a release | ||
``` | ||
|
||
|
||
Based on https://github.com/bitjson/typescript-starter |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2017 Owen Kelly | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
Oops, something went wrong.