217 lines
14 KiB
Markdown
217 lines
14 KiB
Markdown
<img height="0" width="0" alt="Typescript Starter Dark" src="https://cloud.githubusercontent.com/assets/904007/23006840/4e2b0c6c-f3d2-11e6-8f32-11384ee0cc4b.png"><img alt="typescript-starter" src="https://cloud.githubusercontent.com/assets/904007/23006836/4c67a3b8-f3d2-11e6-8784-12f0a34284d1.png">
|
||
|
||
[](https://travis-ci.org/bitjson/typescript-starter)
|
||
[](https://codecov.io/gh/bitjson/typescript-starter)
|
||
[](https://www.npmjs.com/package/typescript-starter)
|
||
[](https://github.com/conventional-changelog/standard-version)
|
||
[](https://david-dm.org/bitjson/typescript-starter)
|
||
[](https://david-dm.org/bitjson/typescript-starter?type=dev)
|
||
|
||
# typescript-starter
|
||
|
||
A [typescript](https://www.typescriptlang.org/) starter for building javascript libraries and projects:
|
||
|
||
* Write **standard, future javascript** – with stable es7 features – today ([stage 3](https://github.com/tc39/proposals) or [finished](https://github.com/tc39/proposals/blob/master/finished-proposals.md) features)
|
||
* [Optionally use typescript](https://basarat.gitbooks.io/typescript/content/docs/why-typescript.html) to improve tooling, linting, and documentation generation
|
||
* Export as a [javascript module](http://jsmodules.io/), making your work **fully tree-shakable** for consumers using [es6 imports](https://github.com/rollup/rollup/wiki/pkg.module) (like [Rollup](http://rollupjs.org/) or [Webpack 2](https://webpack.js.org/))
|
||
* Export type declarations to improve your downstream development experience
|
||
* Backwards compatibility for Node.js-style (CommonJS) imports
|
||
* Both [strict](config/tsconfig.strict.json) and [flexible](config/tsconfig.flexible.json) typescript configurations available
|
||
|
||
So we can have nice things:
|
||
* Generate API documentation (HTML or JSON) [without a mess of JSDoc tags](https://blog.cloudflare.com/generating-documentation-for-typescript-projects/) to maintain
|
||
* Collocated, atomic, concurrent unit tests with [AVA](https://github.com/avajs/ava)
|
||
* Source-mapped code coverage reports with [nyc](https://github.com/istanbuljs/nyc)
|
||
* Configurable code coverage testing (for continuous integration)
|
||
|
||
## Get started
|
||
|
||
Before you start, consider using an [editor with good typescript support](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support).
|
||
|
||
[VS Code](https://code.visualstudio.com/) (below) is a popular option. Editors with typescript support can provide helpful autocomplete, inline documentation, and code refactoring features.
|
||
|
||
<p align="center">
|
||
<img alt="Typescript Editor Support – vscode" width="600" src="https://cloud.githubusercontent.com/assets/904007/23042221/ccebd534-f465-11e6-838d-e2449899282c.png">
|
||
</p>
|
||
|
||
To see how this starter can be used as a dependency in other projects, check out the [`examples`](./examples) folder. The example above is from [`examples/node-typescript`](./examples/node-typescript).
|
||
|
||
## 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
|
||
```
|
||
|
||
which will build and watch the entire project for changes (to both the library source files and test source files). As you develop, you can add tests for new functionality – which will initially fail – before developing the new functionality. Each time you save, any changes will be rebuilt and retested.
|
||
|
||
<p align="center">
|
||
<img alt="Typescript and AVA watch task" src="https://cloud.githubusercontent.com/assets/904007/23443884/c625d562-fdff-11e6-8f26-77bf75add240.png">
|
||
</p>
|
||
|
||
Since only changed files are rebuilt and retested, this workflow remains fast even for large projects.
|
||
|
||
## Enable stronger type checking (recommended)
|
||
|
||
To make getting started easier, the default `tsconfig.json` is using the `config/tsconfig.flexible` configuration. This will allow you to get started without many warnings from Typescript.
|
||
|
||
To enable additional Typescript type checking features (a good idea for mission-critical or large projects), change the `extends` value in `tsconfig.json` to `./config/tsconfig.strict`.
|
||
|
||
## 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 and opens it in a browser.
|
||
|
||
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/).
|
||
|
||
To generate and publish your documentation to [GitHub Pages](https://pages.github.com/) use the following command:
|
||
|
||
```bash
|
||
yarn docs:publish
|
||
```
|
||
|
||
Once published, your documentation should be available at the proper GitHub Pages URL for your repo. See [this repo's GitHub Pages](https://bitjson.github.io/typescript-starter/) for an example.
|
||
|
||
<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 & tag 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 changelog
|
||
```
|
||
|
||
## One-step publish preparation script
|
||
|
||
Bringing together many of the steps above, this repo includes a one-step release command.
|
||
|
||
```bash
|
||
# Standard release
|
||
yarn release
|
||
# Release without bumping package.json version
|
||
yarn changelog -- --first-release
|
||
# PGP sign the release
|
||
yarn changelog -- --sign
|
||
```
|
||
|
||
This command runs:
|
||
- `yarn reset`: cleans the repo by removing all untracked files and resetting `--hard` to the latest commit. (**Note: this could be destructive.**)
|
||
- `yarn test`: build and fully test the project
|
||
- `yarn docs:publish`: generate and publish the latest version of the documentation to GitHub Pages
|
||
- `yarn changelog`: bump package.json version, update CHANGELOG.md, and git tag the release
|
||
|
||
When the script finishes, it will log the final command needed to push the release commit to the repo and publish the package on the `npm` registry:
|
||
|
||
```
|
||
git push --follow-tags origin master; npm publish
|
||
```
|
||
Look over the release if you'd like, then execute the command to publish everything.
|
||
|
||
## All package scripts
|
||
|
||
You can run the `info` script for information on each script intended to be individually run.
|
||
|
||
```
|
||
yarn run info
|
||
|
||
info:
|
||
Display information about the scripts
|
||
build:
|
||
(Trash and re)build the library
|
||
lint:
|
||
Lint all typescript source files
|
||
unit:
|
||
Build the library and run unit tests
|
||
test:
|
||
Lint, build, and test the library
|
||
watch:
|
||
Watch source files, rebuild library on changes, rerun relevant tests
|
||
cov:
|
||
Run tests, generate the HTML coverage report, and open it in a browser
|
||
docs:
|
||
Generate HTML API documentation and open it in a browser
|
||
docs:publish:
|
||
Generate HTML API documentation and push it to GitHub Pages
|
||
docs:json:
|
||
Generate API documentation in typedoc JSON format
|
||
release:
|
||
Bump package.json version, update CHANGELOG.md, tag a release
|
||
reset:
|
||
Delete all untracked files and reset the repo to the last commit
|
||
publish:
|
||
Reset, build, test, publish docs, and prepare release (a one-step publish process)
|
||
```
|
||
## Notes
|
||
|
||
### Multiple builds (`main`, `module`, and `browser`)
|
||
|
||
The `src` of `typescript-starter` is compiled into three separate builds: `main`, `module`, and `browser`. The `main` build is [configured to use the CommonJS module system](https://github.com/bitjson/typescript-starter/blob/master/tsconfig.json#L8), while the `module` build [uses the new ES6 module system](https://github.com/bitjson/typescript-starter/blob/master/config/tsconfig.module.json). The browser build contains two bundles, an ES6 module (the preferred export) and a CommonJS bundle (primarily used for testing).
|
||
|
||
Because Node.js does not yet support the ES6 module system, Node.js projects which depend on typescript-starter will follow the `main` field in [`package.json`](https://github.com/bitjson/typescript-starter/blob/master/package.json). Tools which support the new system (like [Rollup](https://github.com/rollup/rollup)) will follow the `module` field, giving them the ability to statically analyze typescript-starter. When building for the browser, newer tools follow the `browser` field, which will resolve to the browser build's ES6 module.
|
||
|
||
### Testing
|
||
|
||
By convention, tests in `typescript-starter` are co-located with the files they test. The project is configured to allow tests to be written in Typescript and your library to be imported as if it were being used by another project. (E.g. `import { double, power } from 'typescript-starter'`.) This makes tests both intuitive to write and easy to read as another form of documentation.
|
||
|
||
Note, tests are compiled and performed on the final builds in the standard Node.js runtime (rather than an alternative like [ts-node](https://github.com/TypeStrong/ts-node)) to ensure tests pass in that environment. If you are using [ts-node in production](https://github.com/TypeStrong/ts-node/issues/104), you can modify this project to skip test compilation.
|
||
|
||
### Browser libraries
|
||
|
||
While both the browser and the Node.js versions of the library are tested, this starter currently does **not** run the browser tests in a real browser ([AVA](https://github.com/avajs/ava) is currently Node-only). While the current testing system will be sufficient for most use cases, some projects will (also) need to implement a browser-based testing system like [karma-ava](https://github.com/avajs/karma-ava). (Pull requests welcome!)
|
||
|
||
Note: test coverage is only checked against the Node.js implementation. This is much simpler, and works well for libraries where the node and browser implementations have different dependencies and only minor adapter code. With only a few lines of differences (e.g. `src/adapters/crypto.browser.ts`), including those few lines in test coverage analysis usually isn't necessary.
|
||
|
||
### Building browser dependencies
|
||
|
||
This starter demonstrates importing and using a CommonJS module ([`hash.js`](https://github.com/indutny/hash.js)) for it's `hash256` method when built for the browser. See the `build:browser-deps` [package script](./package.json) and [rollup.config.js](./config/exports/rollup.config.js) for more details. Of course, your project likely does not need this dependency, so it can be removed. If your library doesn't need to bundle external dependencies for the browser, several other devDependencies can also be removed (`browserify`, `rollup-plugin-alias`, `rollup-plugin-commonjs`, `rollup-plugin-node-resolve`, etc).
|
||
|
||
### Dependency on `tslib`
|
||
|
||
By default, this project requires [tslib](https://github.com/Microsoft/tslib) as a dependency. This is the recommended way to use Typescript's es6 & es7 transpiling for sizable projects, but you can remove this dependency by removing the `importHelpers` compiler option in `tsconfig.json`. Depending on your usage, this may increase the size of your library significantly, as the Typescript compiler will inject it's helper functions directly into every file which uses them. (See also: [`noEmitHelpers` →](https://www.typescriptlang.org/docs/handbook/compiler-options.html))
|
||
|
||
### Targeting older environments
|
||
|
||
By default, this library targets environments with native (or already-polyfilled) support for es6 features. If your library needs to target Internet Explorer, outdated Android browsers, or versions of Node older than v4, you may need to change the `target` in `tsconfig.json` to `es5` (rather than `es6`) and bring in a Promise polyfill (such as [es6-promise](https://github.com/stefanpenner/es6-promise)).
|
||
|
||
It's a good idea to maintain 100% unit test coverage, and always test in the environments you target.
|
||
|
||
## typescript-starter in the wild
|
||
|
||
You can find more advanced configurations, usage examples, and inspiration from projects using `typescript-starter`.
|
||
|
||
- [BitAuth](https://github.com/bitauth/) – A universal identity and authentication protocol, based on bitcoin
|
||
- [s6: Super Simple Secrets * Simple Secure Storage](https://gitlab.com/td7x/s6/) – An NPM library and tool to sprawl secrets with S3, ease, and encryption
|
||
|
||
Using `typescript-starter` for your project? Please send a pull request to add it to the list!
|