https://github.com/opendevstack/generator-node-express-typescript
CAUTION! This repo is DEPRECATED. A yeoman generator for node, express, typescript based projects
https://github.com/opendevstack/generator-node-express-typescript
nodejs typescript
Last synced: 2 months ago
JSON representation
CAUTION! This repo is DEPRECATED. A yeoman generator for node, express, typescript based projects
- Host: GitHub
- URL: https://github.com/opendevstack/generator-node-express-typescript
- Owner: opendevstack
- License: mit
- Created: 2018-07-11T14:58:22.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-02-16T04:42:13.000Z (over 3 years ago)
- Last Synced: 2025-03-25T09:15:43.364Z (3 months ago)
- Topics: nodejs, typescript
- Language: JavaScript
- Homepage:
- Size: 88.9 KB
- Stars: 2
- Watchers: 32
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README-1x.md
- License: LICENSE
Awesome Lists containing this project
README
# TypeScript NodeJS Generator
[](https://travis-ci.org/ospatil/generator-node-typescript)
[](http://badge.fury.io/js/generator-node-typescript)
I'm a [Yeoman](http://yeoman.io) generator that allows you to create NodeJS modules using TypeScript. I let you quickly setup a project with latest available tools and best practices.
Tools and libraries I use -
- _tsc_ - for compiling TypeScript.
- _typings_ - for management of TypeScript definitions.
- _tsconfig.json_ - for providing compiler options.
- _tslint_ - for linting TypeScript source files.
- [_gulp_](http://gulpjs.com/) - as a build system. You can carry out above tasks through gulp.
- [_Jasmine 2_](http://jasmine.github.io/2.3/introduction.html) - for writing tests.
>You want to know if you can change any of these? Of course, why not? It is your module after all. I simply get down to business of generating, no questions asked. Once done, I get out of the way and you can do as you please!
## Usage
Install `generator-node-typescript`, `gulp-cli` and `typings` globally.
```
npm install -g generator-node-typescript@1x gulp-cli typings
```
Create a new directory and `cd` into it.
```
mkdir my-new-project && cd $_
```
Run `yo node-typescript`.
```
yo node-typescript
```
Run `gulp help` for information on available tasks.
```
gulp help
```
Here is the list of tasks available out of the box -
```sh
_build INTERNAL TASK - Compiles all TypeScript source files
build Compiles all TypeScript source files and updates module references
clean Cleans the generated js files from lib directory
gen-def Generate a single .d.ts bundle containing external module declarations exported from TypeScript module files
help Display this help text.
test Runs the Jasmine test specs [build]
tslint Lints all TypeScript source files
update-tsconfig Update files section in tsconfig.json using filesGlob entries
watch Watches ts source files and runs build on change
```
## What's new in the latest release?
- Use of latest version of TypeScript(`^1.8`).
- Switch to _typings_ as manager for TypeScript definitions. The TSD team has deprecated _tsd_ in favour of _typings_. You can find more information about _typings_ on [Github](https://github.com/typings/typings).
- Integration of _dts-generator_ tool to generate a single _.d.ts_ bundle containing external module declarations exported from TypeScript source files in the module. The package.json now declares _typings_ field that points to the single _.d.ts_ bundle. You can find more information about _typings_ field on [TypeScript Wiki](https://github.com/Microsoft/TypeScript/wiki/Typings-for-npm-packages).
- Less global dependencies. `typescript` and `tslint` are now installed as local dev dependencies allowing you to freely use different versions of these for different modules.
- Addition of _gulp watch_ task that watches ts source files and runs build on change.
## Additional notes
- I provide nice integration with [VS Code editor](https://code.visualstudio.com/). I configure the `gulp build` task as the default VS Code build task.
## License
MIT