Better tooling and tsd integration

Author: Patil, Omkar

README.md

@@ -4,26 +4,24 @@
 
 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.
-  - 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.
+  - _tsc_ - for compiling TypeScript.
+  - _tsd_ - for TypeScript definition files management.
+  - _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 as if I were not there at all and you can do as you please!
 
 ## Usage
 
-Install `generator-node-typescript` globally.
+Install `typescript tsd tslint generator-node-typescript` globally.
 
 ```
-npm install -g generator-node-typescript
+npm install -g typescript tsd tslint generator-node-typescript
 ```
 
->I don't need `typescript-tools` and `tsd` but these are great tools to have for working with TypeScript in editors like sublime and atom and I heartily recommend them.
->Though I install `typescript` and `tslint` locally to avoid global dependencies, installing them globally wouldn't be a bad idea at all.
-
-Make a new directory and `cd` into it.
+Create a new directory and `cd` into it.
 
 ```
 mkdir my-new-project && cd $_
@@ -36,10 +34,55 @@ 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_tsrefs      Generates the app.d.ts references file dynamically for all application *.ts files
+  help            Display this help text.
+  test            Runs the Jasmine test specs [build]
+  tsconfig_files  Update files section in tsconfig.json
+  tslint          Lints all TypeScript source files
+```
 
-## Quick notes
+## Additional notes
 - I provide nice integration with [VSCode editor](https://code.visualstudio.com/). I configure the `gulp build` task as the default VSCode build task.
-- The `gulp build` task also updates _tsconfig/files_ section using _tsconfig/filesGlob_ before build so you don't have to do it manually.
+- The `gulp build` task also updates _tsconfig/files_ section using _tsconfig/filesGlob_ and generates _typings/app.d.ts_ references file dynamically
+for all the application *.ts files before build so you don't have to do it manually.
+
+## Development tips
+- The _tsd_ tool dynamically updates _typings/tsd.d.ts_ file for all type definitions you install through it. Also, the gulp *gen_tsrefs* task dynamically
+updates _typings/app.d.ts_ references file for all application *.ts. Therefore you just need to add references to these two files in any _.ts_ file and you
+are good to go with *tsc* compiler.
+- To keep on using the typical CommonJS exports and imports use the `export` and `inport` systax mentioned in the example below.
+
+  ```ts
+  class Greeter {
+    greeting: string;
+    constructor(message: string) {
+      this.greeting = message;
+    }
+    greet() {
+      return 'Bonjour, ' + this.greeting + '!';
+    }
+  }
+  //The following line is important, export like this allows you to use the old-style CommonJS export/import.
+  export = Greeter;
+
+  ```
+  This is how the above class can be used in some other file.
+
+  ```ts
+  /// <reference path="../typings/tsd.d.ts" />
+  /// <reference path="../typings/app.d.ts" />
+
+  import Greeter = require('./greeter');
+
+  const greeter = new Greeter('friend');
+  greeter.greet();
+
+  ```
 
 ## License
 

generators/app/index.js

@@ -1,9 +1,9 @@
 'use strict';
 var yeoman = require('yeoman-generator');
-var chalk  = require('chalk');
-var yosay  = require('yosay');
-var path   = require('path');
-var _      = require('lodash');
+var chalk = require('chalk');
+var yosay = require('yosay');
+var path = require('path');
+var _ = require('lodash');
 
 module.exports = yeoman.generators.Base.extend({
   initializing: function () {
@@ -12,15 +12,15 @@ module.exports = yeoman.generators.Base.extend({
     // Have Yeoman greet the user.
     this.log(yosay(
       'Welcome to the amazing ' + chalk.red('Node TypeScript') + ' generator!'
-    ));
+      ));
 
     this.log(
       chalk.cyan('I simply get down to business of generating, no questions asked!')
       + '\n'
-      + chalk.yellow('Libraries you ask? I use gulp, jasmine, tslint and I compile TypeScript to CommonJS using tsconfig.json.')
+      + chalk.yellow('Libraries you ask? I use gulp, jasmine, tslint and I compile TypeScript to CommonJS modules using tsconfig.json.')
       + '\n'
       + chalk.gray('Can you change these? Of course, it\'s your library. I get out of the way after scaffolding.')
-    );
+      );
 
     done();
   },
@@ -30,43 +30,52 @@ module.exports = yeoman.generators.Base.extend({
       this.directory('src', 'src');
       this.directory('test', 'test');
       this.directory('_vscode', '.vscode');
+      this.directory('typings', 'typings');
     },
 
     app: function () {
       this.fs.copyTpl(
         this.templatePath('_package.json'),
         this.destinationPath('package.json'),
-        {appname: _.kebabCase(path.basename(process.cwd()))}
-      );
+        { appname: _.kebabCase(path.basename(process.cwd())) }
+        );
     },
 
     projectfiles: function () {
       this.fs.copy(
         this.templatePath('_gulpfile.js'),
         this.destinationPath('gulpfile.js')
-      );
+        );
       this.fs.copy(
         this.templatePath('_tsconfig.json'),
         this.destinationPath('tsconfig.json')
-      );
+        );
       this.fs.copy(
         this.templatePath('_tslint.json'),
         this.destinationPath('tslint.json')
-      );
+        );
       this.fs.copy(
         this.templatePath('editorconfig'),
         this.destinationPath('.editorconfig')
-      );
+        );
       this.fs.copy(
         this.templatePath('gitignore'),
         this.destinationPath('.gitignore')
-      );
+        );
+      this.fs.copy(
+        this.templatePath('jshintrc'),
+        this.destinationPath('.jshintrc')
+        );
     }
   },
 
-  install: function () {
-    this.npmInstall(null, {
-      skipInstall: this.options['skip-install']
-    });
+  install: {
+    npmInstall: function () {
+      var generator = this;
+      generator.npmInstall(null, { skipInstall: this.options['skip-install'] }, function () {
+        generator.spawnCommandSync('tsd', ['init']); //tsd init
+        generator.spawnCommandSync('tsd', ['install', 'node', '--save']) //tsd install --save node
+      });
+  }
   }
 });

generators/app/templates/_gulpfile.js

@@ -1,38 +1,62 @@
-var gulp    = require('gulp');
-var tslint  = require('gulp-tslint');
-var exec    = require('child_process').exec;
+var gulp = require('gulp');
+var tslint = require('gulp-tslint');
+var exec = require('child_process').exec;
 var jasmine = require('gulp-jasmine');
-var gulp    = require('gulp-help')(gulp);
+var gulp = require('gulp-help')(gulp);
 var tsconfig = require('gulp-tsconfig-files');
-var dotbin  = require('dotbin');
+var path = require('path');
+var inject = require('gulp-inject');
+var gulpSequence = require('gulp-sequence');
+var del = require('del');
 
-var tsFilesGlob = (function(c) {
+var typeDefsPath = (function (tsd) {
+  return tsd.path || 'typings';
+})(require('./tsd.json'));
+
+var tsFilesGlob = (function (c) {
   return c.filesGlob || c.files || '**/*.ts';
 })(require('./tsconfig.json'));
 
-gulp.task('tslint', 'Lints all TypeScript source files', function(){
+gulp.task('tsconfig_files', 'Update files section in tsconfig.json', function () {
+  gulp.src(tsFilesGlob).pipe(tsconfig());
+});
+
+gulp.task('gen_tsrefs', 'Generates the app.d.ts references file dynamically for all application *.ts files', function () {
+  var target = gulp.src(path.join('.', typeDefsPath, 'app.d.ts'));
+  var sources = gulp.src([path.join('.', 'src', '**', '*.ts')], { read: false });
+  return target.pipe(inject(sources, {
+    starttag: '//{',
+    endtag: '//}',
+    transform: function (filepath) {
+      return '/// <reference path="..' + filepath + '" />';
+    }
+  })).pipe(gulp.dest(path.join('.', typeDefsPath)));
+});
+
+gulp.task('clean', 'Cleans the generated js files from lib directory', function () {
+  return del([
+    'lib/**/*'
+  ]);
+});
+
+gulp.task('tslint', 'Lints all TypeScript source files', function () {
   return gulp.src(tsFilesGlob)
-  .pipe(tslint())
-  .pipe(tslint.report('verbose'));
+    .pipe(tslint())
+    .pipe(tslint.report('verbose'));
 });
 
-gulp.task('build', 'Compiles all TypeScript source files', ['tsconfig_files'], function (cb) {
+gulp.task('_build', 'INTERNAL TASK - Compiles all TypeScript source files', function (cb) {
   exec('tsc', function (err, stdout, stderr) {
     console.log(stdout);
     console.log(stderr);
     cb(err);
   });
 });
 
-gulp.task('test', 'Runs the Jasmine test specs', ['build'], function () {
-    return gulp.src('test/*.js')
-        .pipe(jasmine());
-});
+//run tslint task, then run _tsconfig_files and _gen_tsrefs in parallel, then run _build
+gulp.task('build', 'Compiles all TypeScript source files and updates module references', gulpSequence('tslint', ['tsconfig_files', 'gen_tsrefs'], '_build'));
 
-gulp.task('tsconfig_files', 'Update files section in tsconfig.json', function () {
-  var src = require('./tsconfig.json').filesGlob;
-  if (typeof src !== 'undefined') {
-     gulp.src(src).pipe(tsconfig());
-  }
+gulp.task('test', 'Runs the Jasmine test specs', ['build'], function () {
+  return gulp.src('test/*.js')
+    .pipe(jasmine());
 });
-

generators/app/templates/_package.json

@@ -16,17 +16,17 @@
   },
   "dependencies": {},
   "devDependencies": {
+    "del": "2.0.2",
     "gulp": "^3.9.0",
-    "gulp-tslint": "^3.1",
     "gulp-help": "^1.6.0",
-    "tslint": "2.*",
+    "gulp-inject": "3.0.0",
     "gulp-jasmine": "^2.0.1",
+    "gulp-sequence": "0.4.1",
     "gulp-tsconfig-files": "0.0.2",
-    "typescript": "^1.5",
-    "dotbin": "^1.0.1",
+    "gulp-tslint": "^3.1",
     "jasmine": "^2.3.1"
   },
   "engines": {
-    "node": ">=0.10.0"
+    "node": ">=0.12.0"
   }
 }

generators/app/templates/_tsconfig.json

@@ -1,17 +1,17 @@
 {
-    "compilerOptions": {
-        "module": "commonjs",
-        "noImplicitAny": true,
-        "removeComments": true,
-        "preserveConstEnums": true,
-        "sourceMap": false,
-        "declaration": true,
-        "outDir": "./lib"
-    },
-    "filesGlob": [
-        "src/**/*.ts"
-    ],
-    "files": [
-      "src/greeter.ts"
-    ]
+  "compilerOptions": {
+    "declaration": true,
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "noImplicitAny": true,
+    "outDir": "./lib",
+    "preserveConstEnums": true,
+    "removeComments": true
+  },
+  "filesGlob": [
+    "src/**/*.ts"
+  ],
+  "files": [
+    "src/greeter.ts"
+  ]
 }