Merge pull request #141 from jamescdavis/work-out-of-the-box

Work out of the box

Author: dfreeman

blueprints/ember-cli-typescript/files/types/ember-data.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Catch-all for ember-data.
+ */
+declare module 'ember-data' {
+  interface ModelRegistry {
+    [key: string]: any;
+  }
+}

blueprints/ember-cli-typescript/index.js

@@ -98,14 +98,45 @@ module.exports = {
       this._installPrecompilationHooks();
     }
 
-    return this.addPackagesToProject([
+    let packages = [
       { name: 'typescript', target: 'latest' },
       { name: '@types/ember', target: 'latest' },
-      { name: '@types/ember-data', target: 'latest' },
       { name: '@types/rsvp', target: 'latest' },
       { name: '@types/ember-test-helpers', target: 'latest' },
       { name: '@types/ember-testing-helpers', target: 'latest' },
-    ]);
+    ];
+
+    if (this._has('ember-data')) {
+      packages.push(
+        { name: '@types/ember-data', target: 'latest' }
+      );
+    }
+
+    if (this._has('ember-cli-qunit')) {
+      packages = packages.concat([
+        { name: '@types/ember-qunit', target: 'latest' },
+        { name: '@types/qunit', target: 'latest' },
+      ]);
+    }
+
+    if (this._has('ember-cli-mocha')) {
+      packages = packages.concat([
+        { name: '@types/ember-mocha', target: 'latest' },
+        { name: '@types/mocha', target: 'latest' },
+      ]);
+    }
+
+    return this.addPackagesToProject(packages);
+  },
+
+  files() {
+    let files = this._super.files.apply(this, arguments);
+
+    if (!this._has('ember-data')) {
+      files = files.filter(file => file !== 'types/ember-data.d.ts');
+    }
+
+    return files;
   },
 
   _installPrecompilationHooks() {
@@ -130,4 +161,10 @@ module.exports = {
 
     scripts[type] = script;
   },
+
+  _has(pkg) {
+    if (this.project) {
+      return pkg in this.project.dependencies();
+    }
+  },
 };

node-tests/blueprints/ember-cli-typescript-test.js

@@ -1,17 +1,43 @@
 'use strict';
 
-const fs = require('fs');
+const fs = require('fs-extra');
 const path = require('path');
 const helpers = require('ember-cli-blueprint-test-helpers/helpers');
 const chaiHelpers = require('ember-cli-blueprint-test-helpers/chai');
+const Blueprint = require('ember-cli/lib/models/blueprint');
 
 const ects = require('../../blueprints/ember-cli-typescript');
 
 const expect = chaiHelpers.expect;
 const file = chaiHelpers.file;
 
 describe('Acceptance: ember-cli-typescript generator', function() {
-  helpers.setupTestHooks(this);
+  helpers.setupTestHooks(this, { disabledTasks: ['addon-install', 'bower-install'] });
+
+  const originalTaskForFn = Blueprint.prototype.taskFor;
+
+  beforeEach(function() {
+    Blueprint.prototype.taskFor = function(taskName) {
+      if (taskName === 'npm-install') {
+        // Mock npm-install that only modifies package.json
+        return {
+          run: function(options) {
+            let pkgJson = fs.readJsonSync('package.json')
+            options.packages.forEach(function(pkg) {
+              let pkgName = pkg.match(/^(.*)@[^@]*$/);
+              pkgJson['devDependencies'][pkgName[1]] = '*';
+            });
+            fs.writeJsonSync('package.json', pkgJson);
+          }
+        }
+      }
+      return originalTaskForFn.call(this, taskName);
+    };
+  });
+
+  afterEach(function() {
+    Blueprint.prototype.taskFor = originalTaskForFn;
+  });
 
   it('basic app', function() {
     const args = ['ember-cli-typescript'];
@@ -26,6 +52,11 @@ describe('Acceptance: ember-cli-typescript generator', function() {
         const pkgJson = JSON.parse(pkg.content);
         expect(pkgJson.scripts.prepublishOnly).to.be.undefined;
         expect(pkgJson.scripts.postpublish).to.be.undefined;
+        expect(pkgJson.devDependencies).to.include.all.keys('ember-data');
+        expect(pkgJson.devDependencies).to.include.all.keys('@types/ember-data');
+        expect(pkgJson.devDependencies).to.include.all.keys('ember-cli-qunit');
+        expect(pkgJson.devDependencies).to.include.all.keys('@types/ember-qunit', '@types/qunit');
+        expect(pkgJson.devDependencies).to.not.have.any.keys('@types/ember-mocha', '@types/mocha');
 
         const tsconfig = file('tsconfig.json');
         expect(tsconfig).to.exist;
@@ -48,6 +79,9 @@ describe('Acceptance: ember-cli-typescript generator', function() {
 
         const environmentTypes = file('types/my-app/config/environment.d.ts');
         expect(environmentTypes).to.exist;
+
+        const emberDataCatchallTypes = file('types/ember-data.d.ts');
+        expect(emberDataCatchallTypes).to.exist;
       });
   });
 
@@ -64,6 +98,11 @@ describe('Acceptance: ember-cli-typescript generator', function() {
         const pkgJson = JSON.parse(pkg.content);
         expect(pkgJson.scripts.prepublishOnly).to.equal('ember ts:precompile');
         expect(pkgJson.scripts.postpublish).to.equal('ember ts:clean');
+        expect(pkgJson.devDependencies).to.not.have.any.keys('ember-data');
+        expect(pkgJson.devDependencies).to.not.have.any.keys('@types/ember-data');
+        expect(pkgJson.devDependencies).to.include.all.keys('ember-cli-qunit');
+        expect(pkgJson.devDependencies).to.include.all.keys('@types/ember-qunit', '@types/qunit');
+        expect(pkgJson.devDependencies).to.not.have.any.keys('@types/ember-mocha', '@types/mocha');
 
         const tsconfig = file('tsconfig.json');
         expect(tsconfig).to.exist;
@@ -82,6 +121,9 @@ describe('Acceptance: ember-cli-typescript generator', function() {
         const projectTypes = file('types/dummy/index.d.ts');
         expect(projectTypes).to.exist;
         expect(projectTypes).not.to.include(ects.APP_DECLARATIONS);
+
+        const emberDataCatchallTypes = file('types/ember-data.d.ts');
+        expect(emberDataCatchallTypes).not.to.exist;
       });
   });
 
@@ -119,6 +161,9 @@ describe('Acceptance: ember-cli-typescript generator', function() {
         const projectTypes = file('types/my-app/index.d.ts');
         expect(projectTypes).to.exist;
         expect(projectTypes).to.include(ects.APP_DECLARATIONS);
+
+        const emberDataCatchallTypes = file('types/ember-data.d.ts');
+        expect(emberDataCatchallTypes).to.exist;
       });
   });
 
@@ -179,4 +224,44 @@ describe('Acceptance: ember-cli-typescript generator', function() {
         expect(json.include).to.deep.equal(['app', 'addon', 'tests', 'types']);
       });
   });
+
+  it('app with Mocha', function() {
+    const args = ['ember-cli-typescript'];
+
+    return helpers
+      .emberNew()
+      .then(() => helpers.modifyPackages([
+        { name: 'ember-cli-mocha', dev: true },
+        { name: 'ember-cli-qunit', delete: true },
+      ]))
+      .then(() => helpers.emberGenerate(args))
+      .then(() => {
+        const pkg = file('package.json');
+        expect(pkg).to.exist;
+
+        const pkgJson = JSON.parse(pkg.content);
+        expect(pkgJson.devDependencies).to.include.all.keys('@types/ember-mocha', '@types/mocha');
+        expect(pkgJson.devDependencies).to.not.have.any.keys('@types/ember-qunit', '@types/qunit');
+      });
+  });
+
+  it('addon with Mocha', function() {
+    const args = ['ember-cli-typescript'];
+
+    return helpers
+      .emberNew({ target: 'addon' })
+      .then(() => helpers.modifyPackages([
+        { name: 'ember-cli-mocha', dev: true },
+        { name: 'ember-cli-qunit', delete: true },
+      ]))
+      .then(() => helpers.emberGenerate(args))
+      .then(() => {
+        const pkg = file('package.json');
+        expect(pkg).to.exist;
+
+        const pkgJson = JSON.parse(pkg.content);
+        expect(pkgJson.devDependencies).to.include.all.keys('@types/ember-mocha', '@types/mocha');
+        expect(pkgJson.devDependencies).to.not.have.any.keys('@types/ember-qunit', '@types/qunit');
+      });
+  });
 });