Starter/typescript-starter
1
0
Fork 0
mirror of synced 2025-11-08 12:57:47 +00:00
Code Issues Releases Wiki Activity

refactor(package): rename from es7-typescript-starter to typescript-starter

Browse Source
This commit is contained in:
Jason Dreyzehner
2017-02-13 17:59:41 -05:00
parent 3aa9cf79df
commit 3c6f7b7419
7 changed files with 39 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
examples/browser/package.json
View File

@@ -1,5 +1,5 @@
{
"name": "es7-typescript-starter-example-browser",
"name": "typescript-starter-example-browser",
"version": "1.0.0",
"license": "MIT",
"scripts": {

2
examples/node-typescript/package.json
View File

@@ -1,5 +1,5 @@
{
"name": "es7-typescript-starter-example-node-typescript",
"name": "typescript-starter-example-node-typescript",
"version": "1.0.0",
"license": "MIT",
"scripts": {

12
examples/readme.md
View File

@@ -1,13 +1,13 @@
# Usage Examples
This directory (`/examples`) can be deleted when forking this project. It contains some simple examples of how forks of `es7-typescript-starter` can be used by other projects. (Usually you'll want to provide these instructions in your root `readme.md`.)
This directory (`/examples`) can be deleted when forking this project. It contains some simple examples of how forks of `typescript-starter` can be used by other projects. (Usually you'll want to provide these instructions in your root `readme.md`.)
## Node (Vanilla)
This shows the simplest use case – a quick, hacked-together Node.js project with no type safety, and no pre-processing. This is the way most of the Node.js ecosystem currently expects to import a node modules.
```bash
# build es7-typescript-starter first
# build typescript-starter first
yarn build
cd examples/node-vanilla
@@ -18,10 +18,10 @@ node test.js
## Node (Typescript)
This is for larger and more established Node.js projects which use Typescript for type safety. You'll notice that the type declarations and inline documentation from `es7-typescript-starter` are accessible to [Typescript-compatible editors](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support) like [vscode](https://code.visualstudio.com/).
This is for larger and more established Node.js projects which use Typescript for type safety. You'll notice that the type declarations and inline documentation from `typescript-starter` are accessible to [Typescript-compatible editors](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support) like [vscode](https://code.visualstudio.com/).
```bash
# build es7-typescript-starter first
# build typescript-starter first
yarn build
cd examples/node-typescript
@@ -36,12 +36,12 @@ yarn start
## Browser (tree-shaking with Rollup)
This project imports the `power` and `asyncABC` functions from the ES6 output of `es7-typescript-starter`, without importing the `double` function. This allows for the `double` method to be completely excluded from output via [Rollup's tree-shaking](http://rollupjs.org/), making the final javascript bundle potentially much smaller, even before using a minifier like [Uglify](https://github.com/mishoo/UglifyJS2).
This project imports the `power` and `asyncABC` functions from the ES6 output of `typescript-starter`, without importing the `double` function. This allows for the `double` method to be completely excluded from output via [Rollup's tree-shaking](http://rollupjs.org/), making the final javascript bundle potentially much smaller, even before using a minifier like [Uglify](https://github.com/mishoo/UglifyJS2).
To demonstrate, this example doesn't minify or remove comments. You can see where some javascript has been excluded from the bundle.
```bash
# build es7-typescript-starter first
# build typescript-starter first
yarn build
cd examples/browser