fix(cli): remove copyright header from generated app (#991)

virkt25 · web-flow · commit c987b28b07a2 · 2018-02-13T20:13:39.000-05:00
* fix(cli): remove copyright header from generated app use `.template` extension for templates. Rename during project generation. Removes copyright headers from templates. Fixes #944 * fixup! apply feedback - use RegExp for matching instead of extname
diff --git a/packages/cli/generators/app/templates/index.js b/packages/cli/generators/app/templates/index.js
diff --git a/packages/cli/generators/app/templates/index.js.template b/packages/cli/generators/app/templates/index.js.template
@@ -0,0 +1,6 @@
+const application = (module.exports = require('./dist'));
+
+if (require.main === module) {
+  // Run the application
+  application.main();
+}
diff --git a/packages/cli/generators/app/templates/src/application.ts.template b/packages/cli/generators/app/templates/src/application.ts.template
@@ -1,8 +1,3 @@
-// Copyright IBM Corp. 2017,2018. All Rights Reserved.
-// Node module: @loopback/cli
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-
 import {ApplicationConfig} from '@loopback/core';
 import {RestApplication, RestServer} from '@loopback/rest';
 import {PingController} from './controllers/ping.controller';
diff --git a/packages/cli/generators/app/templates/src/controllers/ping.controller.ts.template b/packages/cli/generators/app/templates/src/controllers/ping.controller.ts.template
@@ -1,8 +1,3 @@
-// Copyright IBM Corp. 2017,2018. All Rights Reserved.
-// Node module: @loopback/cli
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-
 import {ServerRequest} from '@loopback/rest';
 import {get} from '@loopback/openapi-v2';
 import {inject} from '@loopback/context';
diff --git a/packages/cli/generators/app/templates/src/index.ts.template b/packages/cli/generators/app/templates/src/index.ts.template
@@ -1,8 +1,3 @@
-// Copyright IBM Corp. 2017,2018. All Rights Reserved.
-// Node module: @loopback/cli
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-
 import {<%= project.applicationName %>} from './application';
 import {ApplicationConfig} from '@loopback/core';
 
diff --git a/packages/cli/generators/app/templates/src/sequence.ts.template b/packages/cli/generators/app/templates/src/sequence.ts.template
@@ -1,8 +1,3 @@
-// Copyright IBM Corp. 2017,2018. All Rights Reserved.
-// Node module: @loopback/cli
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-
 import {Context, inject} from '@loopback/context';
 import {
   FindRoute,
diff --git a/packages/cli/generators/app/templates/test/ping.controller.test.ts.template b/packages/cli/generators/app/templates/test/ping.controller.test.ts.template
@@ -1,8 +1,3 @@
-// Copyright IBM Corp. 2017,2018. All Rights Reserved.
-// Node module: @loopback/cli
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-
 import {createClientForHandler, supertest} from '@loopback/testlab';
 import {RestServer} from '@loopback/rest';
 import {<%= project.applicationName %>} from '../';
diff --git a/packages/cli/generators/controller/index.js b/packages/cli/generators/controller/index.js
@@ -186,10 +186,10 @@ module.exports = class ControllerGenerator extends ArtifactGenerator {
       debug(`Artifact filename set to: ${this.artifactInfo.filename}`);
     }
     // renames the file
-    let template = 'controller-template.ts';
+    let template = 'controller-template.ts.template';
     switch (this.artifactInfo.controllerType) {
       case ControllerGenerator.REST:
-        template = 'controller-rest-template.ts';
+        template = 'controller-rest-template.ts.template';
         break;
       default:
         break;
diff --git a/packages/cli/generators/controller/templates/src/controllers/controller-rest-template.ts.template b/packages/cli/generators/controller/templates/src/controllers/controller-rest-template.ts.template
@@ -1,8 +1,3 @@
-// Copyright IBM Corp. 2018. All Rights Reserved.
-// Node module: @loopback/cli
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-
 import {Filter, Where} from '@loopback/repository';
 import {post, param, get, put, patch, del} from '@loopback/openapi-v2';
 import {inject} from '@loopback/context';
diff --git a/packages/cli/generators/controller/templates/src/controllers/controller-template.ts b/packages/cli/generators/controller/templates/src/controllers/controller-template.ts
diff --git a/packages/cli/generators/controller/templates/src/controllers/controller-template.ts.template b/packages/cli/generators/controller/templates/src/controllers/controller-template.ts.template
@@ -0,0 +1,8 @@
+// Uncomment these imports to begin using these cool features!
+
+// import {inject} from @loopback/context;
+
+
+export class <%= name %>Controller {
+  constructor() {}
+}
diff --git a/packages/cli/generators/extension/templates/index.d.ts b/packages/cli/generators/extension/templates/index.d.ts
diff --git a/packages/cli/generators/extension/templates/index.d.ts.template b/packages/cli/generators/extension/templates/index.d.ts.template
@@ -0,0 +1 @@
+export * from './dist';
diff --git a/packages/cli/generators/extension/templates/index.js b/packages/cli/generators/extension/templates/index.js
diff --git a/packages/cli/generators/extension/templates/index.js.template b/packages/cli/generators/extension/templates/index.js.template
@@ -0,0 +1 @@
+module.exports = require('./dist');
diff --git a/packages/cli/generators/extension/templates/src/component.ts b/packages/cli/generators/extension/templates/src/component.ts
diff --git a/packages/cli/generators/extension/templates/src/component.ts.template b/packages/cli/generators/extension/templates/src/component.ts.template
@@ -0,0 +1,9 @@
+import {Component, ProviderMap} from '@loopback/core';
+
+export class <%= project.componentName %> implements Component {
+  constructor() {}
+
+  providers?: ProviderMap = {
+  };
+
+}
diff --git a/packages/cli/generators/extension/templates/src/index.ts b/packages/cli/generators/extension/templates/src/index.ts
diff --git a/packages/cli/generators/extension/templates/src/index.ts.template b/packages/cli/generators/extension/templates/src/index.ts.template
@@ -0,0 +1 @@
+export * from './component';
diff --git a/packages/cli/generators/project/templates/index.ts b/packages/cli/generators/project/templates/index.ts
diff --git a/packages/cli/generators/project/templates/index.ts.template b/packages/cli/generators/project/templates/index.ts.template
@@ -0,0 +1 @@
+export * from './src';
diff --git a/packages/cli/lib/project-generator.js b/packages/cli/lib/project-generator.js
@@ -4,6 +4,7 @@
 // License text available at https://opensource.org/licenses/MIT
 
 'use strict';
+const rename = require('gulp-rename');
 const BaseGenerator = require('./base-generator');
 const utils = require('./utils');
 
@@ -55,6 +56,26 @@ module.exports = class ProjectGenerator extends BaseGenerator {
       const isValid = utils.validate(this.args[0]);
       if (typeof isValid === 'string') throw new Error(isValid);
     }
+
+    this.setupRenameTransformer();
+  }
+
+  /**
+   * Registers a Transform Stream with Yeoman. Removes `.template` extension
+   * from files that have it during project generation.
+   */
+  setupRenameTransformer() {
+    this.registerTransformStream(
+      rename(function(file) {
+        // extname already contains a leading '.'
+        const fileName = `${file.basename}${file.extname}`;
+        const result = fileName.match(/(.+)(.ts|.js)\.template$/);
+        if (result) {
+          file.extname = result[2];
+          file.basename = result[1];
+        }
+      })
+    );
   }
 
   setOptions() {
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -42,6 +42,7 @@
     "chalk": "^2.3.0",
     "change-case": "^3.0.1",
     "debug": "^3.1.0",
+    "gulp-rename": "^1.2.2",
     "gunzip-maybe": "^1.4.1",
     "lodash": "^4.17.4",
     "minimist": "^1.2.0",
