Merge pull request #104 from lee-elenbaas/master

Jeff May · Jeff May · commit 3c0c606d2be7 · 2014-06-23T15:04:54.000-04:00
Templates for html2ts module and var
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -277,6 +277,8 @@ module.exports = function (grunt) {
     grunt.loadNpmTasks('grunt-contrib-nodeunit');
     grunt.loadNpmTasks('grunt-contrib-watch');
 
+    grunt.loadNpmTasks('grunt-debug-task');
+
     // Build
     grunt.registerTask('prep', ['clean', 'jshint:support']);
     grunt.registerTask('build', ['prep', 'ts-internal', 'tslint:source']);
diff --git a/README.md b/README.md
@@ -161,6 +161,25 @@ It is possible to specify this string to the template on a view: http://emberjs.
 
 Specifically: http://stackoverflow.com/a/9867375/390330
 
+#### Control generated TypeScript module and variable names
+
+In the task options htmlModuleTemplate and htmlVarTemplate can specify an Underscore templates to be used in order to generate the module and variable names for the generated TypeScript.
+
+Those Underscore template recieve the following parameters:
+
+ * filename - The html file name without the extension ("test" if the file was named test.html)
+ * ext - The html extension without the dot ("html" if the file was named test.html)
+
+The default templates are:
+
+ * "<%= filename %>" - for the module name. (This maintain existing behavior of older versions, and allow controlling the module name by simply renaming the file.)
+ * "<%= ext %>" - for the variable name. (This maintain existing behavior of older versions, again allowing to control variable name by renaming the file.)
+
+Usage example is setting the module template to "MyModule.Templates" and the variable template to "<%= filename %>" this will result for the test.html file above with the generated TypeScript
+```typescript
+module MyModule.Templates { export var test = '<div Some content </div>' }
+```
+
 ### Live file watching and building
 
 Grunt-ts can watch a directory and recompile TypeScript files when any TypeScript file changes, gets added, gets removed. Internallythe `chokidar` module is used to makes sure the project is always build ready :) 
diff --git a/package.json b/package.json
@@ -1,71 +1,72 @@
 {
-    "author": "basarat",
-    "name": "grunt-ts",
-    "description": "Compile and manage your TypeScript project",
-    "version": "1.11.2",
-    "homepage": "https://github.com/grunt-ts/grunt-ts",
-    "repository": {
-        "type": "git",
-        "url": "git@github.com:grunt-ts/grunt-ts.git"
+  "author": "basarat",
+  "name": "grunt-ts",
+  "description": "Compile and manage your TypeScript project",
+  "version": "1.11.2",
+  "homepage": "https://github.com/grunt-ts/grunt-ts",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:grunt-ts/grunt-ts.git"
+  },
+  "bugs": {
+    "url": "https://github.com/grunt-ts/grunt-ts/issues"
+  },
+  "licenses": [
+    {
+      "type": "MIT",
+      "url": "https://github.com/grunt-ts/grunt-ts/blob/master/LICENSE"
+    }
+  ],
+  "main": "grunt.js",
+  "maintainers": [
+    {
+      "name": "basarat",
+      "email": "basaratali@gmail.com"
     },
-    "bugs": {
-        "url": "https://github.com/grunt-ts/grunt-ts/issues"
+    {
+      "name": "jeffmay",
+      "email": "viralidealogue@gmail.com"
     },
-    "licenses": [
-        {
-            "type": "MIT",
-            "url": "https://github.com/grunt-ts/grunt-ts/blob/master/LICENSE"
-        }
-    ],
-    "main": "grunt.js",
-    "maintainers": [
-        {
-            "name": "basarat",
-            "email": "basaratali@gmail.com"
-        },
-        {
-            "name": "jeffmay",
-            "email": "viralidealogue@gmail.com"
-        },
-        {
-            "name": "bartvds",
-            "email": "bartvanderschoor@gmail.com"
-        }
-    ],
-    "engines": {
-        "node": ">= 0.8.0"
-    },
-    "scripts": {
-        "test": "grunt test"
-    },
-    "dependencies": {
-        "typescript": "1.0.0",
-        "chokidar": "0.8.2",
-        "underscore": "1.5.1",
-        "underscore.string": "2.3.3",
-        "es6-promise": "~0.1.1",
-        "rimraf": "2.2.6",
-        "ncp": "0.5.1"
-    },
-    "peerDependencies": {
-        "grunt": "~0.4.0"
-    },
-    "devDependencies": {
-        "grunt": "~0.4.0",
-        "grunt-tslint": "~0.4.0",
-        "grunt-contrib-watch": "~0.6.1",
-        "grunt-contrib-clean": "~0.4.0",
-        "grunt-contrib-jshint": "~0.8.0",
-        "grunt-contrib-nodeunit": "~0.2.2",
-        "tslint-path-formatter": "~0.1.1",
-        "source-map-support": "~0.2.5",
-        "jshint-path-reporter": "~0.1.3",
-        "grunt-continue": "0.0.1"
-    },
-    "optionalDependencies": {},
-    "keywords": [
-        "gruntplugin",
-        "typescript",
-        "compiler"
-    ]
+    {
+      "name": "bartvds",
+      "email": "bartvanderschoor@gmail.com"
+    }
+  ],
+  "engines": {
+    "node": ">= 0.8.0"
+  },
+  "scripts": {
+    "test": "grunt test"
+  },
+  "dependencies": {
+    "typescript": "1.0.0",
+    "chokidar": "0.8.2",
+    "underscore": "1.5.1",
+    "underscore.string": "2.3.3",
+    "es6-promise": "~0.1.1",
+    "rimraf": "2.2.6",
+    "ncp": "0.5.1"
+  },
+  "peerDependencies": {
+    "grunt": "~0.4.0"
+  },
+  "devDependencies": {
+    "grunt": "~0.4.0",
+    "grunt-continue": "0.0.1",
+    "grunt-contrib-clean": "~0.4.0",
+    "grunt-contrib-jshint": "~0.8.0",
+    "grunt-contrib-nodeunit": "~0.2.2",
+    "grunt-contrib-watch": "~0.6.1",
+    "grunt-debug-task": "^0.1.4",
+    "grunt-tslint": "~0.4.0",
+    "jshint-path-reporter": "~0.1.3",
+    "source-map-support": "~0.2.5",
+    "tslint-path-formatter": "~0.1.1"
+  },
+  "optionalDependencies": {},
+  "keywords": [
+    "gruntplugin",
+    "typescript",
+    "compiler"
+  ]
 }
diff --git a/sample/Gruntfile.js b/sample/Gruntfile.js
@@ -15,6 +15,9 @@ module.exports = function (grunt) {
                 sourceRoot: '',                // where to locate TypeScript files. [(default) '' == source ts location]
                 mapRoot: '',                   // where to locate .map.js files. [(default) '' == generated js location.]
                 declaration: false,            // generate a declaration .d.ts file for every output js file. [true | false (default)]
+                htmlModuleTemplate: 'My.Module.<%= filename %>',    // Template for module name for generated ts from html files [(default) '<%= filename %>']
+                htmlVarTemplate: '<%= ext %>'                       // Template for variable name used in generated ts from html files [(default) '<%= ext %>]
+                                                                    // Both html templates accept the ext and filename parameters.
             },
             // a particular target
             dev: {
diff --git a/tasks/modules/html2ts.js b/tasks/modules/html2ts.js
diff --git a/tasks/modules/html2ts.ts b/tasks/modules/html2ts.ts
@@ -28,16 +28,25 @@ function stripBOM(str) {
 
 var htmlTemplate = _.template('module <%= modulename %> { export var <%= varname %> =  \'<%= content %>\' } ');
 
+export interface IHtml2TSOptions {
+    moduleFunction: Function;
+    varFunction: Function
+}
+
 // Compile an HTML file to a TS file
 // Return the filename. This filename will be required by reference.ts
-export function compileHTML(filename: string): string {
+export function compileHTML(filename: string, options: IHtml2TSOptions): string {
     var htmlContent = escapeContent(fs.readFileSync(filename).toString());
     htmlContent = stripBOM(htmlContent);
     // TODO: place a minification pipeline here if you want.
 
-    var ext = path.extname(filename);
-    var extFreename = path.basename(filename, ext);
-    var fileContent = htmlTemplate({ modulename: extFreename, varname: ext.replace('.', ''), content: htmlContent });
+    var ext = path.extname(filename).replace('.', '');
+    var extFreename = path.basename(filename, '.' + ext);
+
+    var moduleName = options.moduleFunction({ ext: ext, filename: extFreename });
+    var varName = options.varFunction({ ext: ext, filename: extFreename }).replace('.', '_');
+
+    var fileContent = htmlTemplate({ modulename: moduleName, varname: varName, content: htmlContent });
 
     // Write the content to a file
     var outputfile = filename + '.ts';
diff --git a/tasks/modules/interfaces.d.ts b/tasks/modules/interfaces.d.ts
@@ -49,4 +49,7 @@ interface ITaskOptions {
     verbose: boolean;
     compile: boolean;
     fast: string; // never | always | watch (default)
+
+    htmlModuleTemplate: string;
+    htmlVarTemplate: string;
 }
diff --git a/tasks/ts.js b/tasks/ts.js
diff --git a/tasks/ts.ts b/tasks/ts.ts
@@ -105,9 +105,18 @@ function pluginFn(grunt: IGrunt) {
             target: 'es5', // es3 , es5
             verbose: false,
             fast: 'watch',
+            htmlModuleTemplate: '<%= filename %>',
+            htmlVarTemplate: '<%= ext %>',
             failOnTypeErrors: true
         });
 
+        // get unprocessed templates from configuration
+        var rawTaskOptions = <ITaskOptions>(grunt.config.getRaw(currenttask.name + '.options') || {});
+        var rawTargetOptions = <ITaskOptions>(grunt.config.getRaw(currenttask.name + '.' + currenttask.target + '.options') || {});
+
+        options.htmlModuleTemplate = rawTargetOptions.htmlModuleTemplate || rawTaskOptions.htmlModuleTemplate;
+        options.htmlVarTemplate = rawTargetOptions.htmlVarTemplate || rawTaskOptions.htmlVarTemplate;
+
         // fix the properly cased options to their appropriate values
         options.allowBool = 'allowbool' in options ? options['allowbool'] : options.allowBool;
         options.allowImportModule = 'allowimportmodule' in options ? options['allowimportmodule'] : options.allowImportModule;
@@ -119,6 +128,16 @@ function pluginFn(grunt: IGrunt) {
             options.fast = 'watch';
         }
 
+        if (!options.htmlModuleTemplate) {
+            console.warn(('htmlModuleTemplate must be provided, reverting to default template: "<%= filename %>"').magenta);
+            options.htmlModuleTemplate = '<%= filename %>';
+        }
+
+        if (!options.htmlVarTemplate) {
+            console.warn(('htmlVarTemplate must be provided, reverting to default template: "<%= ext %>"').magenta);
+            options.htmlVarTemplate = '<%= ext %>';
+        }
+
         // Remove comments based on the removeComments flag first then based on the comments flag, otherwise true
         if (options.removeComments === null) {
             options.removeComments = !options.comments;
@@ -198,7 +217,7 @@ function pluginFn(grunt: IGrunt) {
             function runCompilation(files: string[], target: ITargetOptions, options: ITaskOptions): Promise<boolean> {
                 // Don't run it yet
                 grunt.log.writeln('Compiling...'.yellow);
-                
+
                 // The files to compile
                 var filesToCompile = files;
 
@@ -293,8 +312,13 @@ function pluginFn(grunt: IGrunt) {
                 //    compile html files must be before reference file creation                
                 var generatedFiles = [];
                 if (currenttask.data.html) {
+					var html2tsOptions = {
+						moduleFunction: _.template(options.htmlModuleTemplate),
+						varFunction: _.template(options.htmlVarTemplate)
+					};
+
                     var htmlFiles = grunt.file.expand(currenttask.data.html);
-                    generatedFiles = _.map(htmlFiles, (filename) => html2tsModule.compileHTML(filename));
+                    generatedFiles = _.map(htmlFiles, (filename) => html2tsModule.compileHTML(filename, html2tsOptions));
                 }
 
                 ///// Template cache

Original file line number	Diff line number	Diff line change
`@@ -49,4 +49,7 @@ interface ITaskOptions {`
`49`	`49`	`verbose: boolean;`
`50`	`50`	`compile: boolean;`
`51`	`51`	`fast: string; // never \| always \| watch (default)`
	`52`	`+`
	`53`	`+ htmlModuleTemplate: string;`
	`54`	`+ htmlVarTemplate: string;`
`52`	`55`	`}`