chore(generate-loader,plugin): add typescript support

dhruvdutt · dhruvdutt · commit 184fe2f8943e · 2018-07-14T19:36:18.000+05:30
diff --git a/packages/generate-loader/.gitignore b/packages/generate-loader/.gitignore
@@ -0,0 +1 @@
+*.js
diff --git a/packages/generate-loader/.npmignore b/packages/generate-loader/.npmignore
@@ -1,3 +1,6 @@
 examples
 test
+types
 templates/test
+*.ts
+tsconfig.json
diff --git a/packages/generate-loader/index.js b/packages/generate-loader/index.js
diff --git a/packages/generate-loader/index.ts b/packages/generate-loader/index.ts
@@ -0,0 +1,18 @@
+import LoaderGenerator from "@webpack-cli/generators/loader-generator";
+import * as yeoman from "yeoman-environment";
+
+import { IYeoman } from "./types/Yeoman";
+
+/**
+ * Runs a yeoman generator to create a new webpack loader project
+ * @returns {void}
+ */
+
+export default function loaderCreator(): void {
+	const env = yeoman.createEnv();
+	const generatorName: string = "webpack-loader-generator";
+
+	env.registerStub(LoaderGenerator, generatorName);
+
+	env.run(generatorName);
+}
diff --git a/packages/generate-loader/package-lock.json b/packages/generate-loader/package-lock.json
diff --git a/packages/generate-loader/package.json b/packages/generate-loader/package.json
@@ -16,5 +16,12 @@
   "dependencies": {
     "@webpack-cli/generators": "^0.0.8",
     "yeoman-environment": "^2.1.1"
+  },
+  "devDependencies": {
+    "@types/node": "^10.3.6",
+    "typescript": "^2.9.2"
+  },
+  "scripts": {
+    "build": "tsc"
   }
 }
diff --git a/packages/generate-loader/tsconfig.json b/packages/generate-loader/tsconfig.json
@@ -0,0 +1,3 @@
+{
+  "extends": "../../tsconfig.json"
+}
diff --git a/packages/generate-loader/types/Yeoman.ts b/packages/generate-loader/types/Yeoman.ts
@@ -0,0 +1,12 @@
+interface IRunEnv extends Object {
+	on?: (event: string, callbackFn: Function) => void;
+}
+
+export interface IYeoman extends Object {
+	registerStub?(generator: IGenerator, namespace: string): void;
+	run?(target: string, options?: object, done?: Function): IRunEnv;
+}
+
+export interface IGenerator extends Object {
+	composeWith?: (path: string) => void;
+}
diff --git a/packages/generate-plugin/.gitignore b/packages/generate-plugin/.gitignore
@@ -0,0 +1 @@
+*.js
diff --git a/packages/generate-plugin/.npmignore b/packages/generate-plugin/.npmignore
@@ -1,3 +1,6 @@
 examples
 test
+types
 templates/test
+*.ts
+tsconfig.json
diff --git a/packages/generate-plugin/index.js b/packages/generate-plugin/index.js
diff --git a/packages/generate-plugin/index.ts b/packages/generate-plugin/index.ts
@@ -0,0 +1,18 @@
+import PluginGenerator from "@webpack-cli/generators/plugin-generator";
+import * as yeoman from "yeoman-environment";
+
+import { IYeoman } from "./types/Yeoman";
+
+/**
+ * Runs a yeoman generator to create a new webpack plugin project
+ * @returns {void}
+ */
+
+export default function pluginCreator(): void {
+	const env = yeoman.createEnv();
+	const generatorName: string = "webpack-plugin-generator";
+
+	env.registerStub(PluginGenerator, generatorName);
+
+	env.run(generatorName);
+}
diff --git a/packages/generate-plugin/package-lock.json b/packages/generate-plugin/package-lock.json
diff --git a/packages/generate-plugin/package.json b/packages/generate-plugin/package.json
@@ -16,5 +16,12 @@
   "dependencies": {
     "@webpack-cli/generators": "^0.0.8",
     "yeoman-environment": "^2.1.1"
+  },
+  "devDependencies": {
+    "@types/node": "^10.3.6",
+    "typescript": "^2.9.2"
+  },
+  "scripts": {
+    "build": "tsc"
   }
 }
diff --git a/packages/generate-plugin/tsconfig.json b/packages/generate-plugin/tsconfig.json
@@ -0,0 +1,3 @@
+{
+  "extends": "../../tsconfig.json"
+}
diff --git a/packages/generate-plugin/types/Yeoman.ts b/packages/generate-plugin/types/Yeoman.ts
@@ -0,0 +1,12 @@
+interface IRunEnv extends Object {
+	on?: (event: string, callbackFn: Function) => void;
+}
+
+export interface IYeoman extends Object {
+	registerStub?(generator: IGenerator, namespace: string): void;
+	run?(target: string, options?: object, done?: Function): IRunEnv;
+}
+
+export interface IGenerator extends Object {
+	composeWith?: (path: string) => void;
+}
diff --git a/packages/generators/addon-generator.ts b/packages/generators/addon-generator.ts
@@ -3,7 +3,7 @@ import * as path from "path";
 import Generator = require("yeoman-generator");
 
 import * as copyUtils from "@webpack-cli/utils/copy-utils";
-import { IScaffoldBaseObject } from "@webpack-cli/webpack-scaffold";
+import { IInquirerScaffoldObject } from "@webpack-cli/webpack-scaffold";
 
 /**
  * Creates a Yeoman Generator that generates a project conforming
@@ -27,19 +27,19 @@ import { IScaffoldBaseObject } from "@webpack-cli/webpack-scaffold";
  * @returns {Generator} A class extending Generator
  */
 export default function addonGenerator(
-	prompts: IScaffoldBaseObject[],
+	prompts: IInquirerScaffoldObject[],
 	templateDir: string,
 	copyFiles: string[],
 	copyTemplateFiles: string[],
 	templateFn: Function,
 ) {
 	return class AddOnGenerator extends Generator {
-		public props: IScaffoldBaseObject;
+		public props: IInquirerScaffoldObject;
 		private copy: (value: string, index: number, array: string[]) => void;
 		private copyTpl: (value: string, index: number, array: string[]) => void;
 
 		public prompting() {
-			return this.prompt(prompts).then((props: IScaffoldBaseObject) => {
+			return this.prompt(prompts).then((props: IInquirerScaffoldObject) => {
 				this.props = props;
 			});
 		}
diff --git a/packages/generators/loader-generator.ts b/packages/generators/loader-generator.ts
@@ -10,7 +10,7 @@ import addonGenerator from "./addon-generator";
  * @param {string} name A loader name to be formatted
  * @returns {string} The formatted string
  */
-export function makeLoaderName(name: string): string {
+function makeLoaderName(name: string): string {
 	name = _.kebabCase(name);
 	if (!/loader$/.test(name)) {
 		name += "-loader";
@@ -51,7 +51,7 @@ const LoaderGenerator = addonGenerator(
 		"examples/simple/src/static-esm-module.js.tpl",
 	],
 	["src/_index.js.tpl"],
-	(gen: IYeoman): object => ({ name: gen.props.name }),
+	(gen): object => ({ name: gen.props.name }),
 );
 
 export default LoaderGenerator;
diff --git a/packages/generators/plugin-generator.ts b/packages/generators/plugin-generator.ts
@@ -32,7 +32,7 @@ const PluginGenerator = addonGenerator(
 		"examples/simple/src/static-esm-module.js.tpl",
 	],
 	["src/_index.js.tpl", "examples/simple/_webpack.config.js.tpl"],
-	(gen: IYeoman): object => ({ name: _.upperFirst(_.camelCase(gen.props.name)) }),
+	(gen): object => ({ name: _.upperFirst(_.camelCase(gen.props.name)) }),
 );
 
 export default PluginGenerator;
diff --git a/packages/init/init.ts b/packages/init/init.ts
@@ -57,7 +57,7 @@ export default function runTransform(webpackProperties: IWebpackProperties, acti
 		return pEachSeries(transformations, (f: string): boolean | INode => {
 			return astTransform(j, ast, config.webpackOptions[f], transformAction, f);
 		})
-			.then((_?: any) => {
+			.then((value: string[]): void | PromiseLike <void> => {
 				let configurationName: string = "webpack.config.js";
 				if (config.configName) {
 					configurationName = "webpack." + config.configName + ".js";
diff --git a/packages/utils/copy-utils.ts b/packages/utils/copy-utils.ts
@@ -17,7 +17,7 @@ interface IGenerator {
  * @returns {Function} A curried function that takes a file path and copies it
  */
 export const generatorCopy = (
-	generator: any,
+	generator,
 	templateDir: string,
 ): (filePath: string) => void => (filePath: string): void => {
 	const sourceParts: string[] = templateDir.split(path.delimiter);
@@ -43,7 +43,7 @@ export const generatorCopy = (
  * @returns {Function} A curried function that takes a file path and copies it
  */
 export const generatorCopyTpl = (
-	generator: any,
+	generator,
 	templateDir: string,
 	templateData: object,
 ): (filePath: string) => void => (filePath: string): void => {
diff --git a/packages/utils/modify-config-helper.ts b/packages/utils/modify-config-helper.ts
@@ -74,7 +74,7 @@ export default function modifyHelperUtil(
 		}
 	}
 
-	const env: IYeoman = yeoman.createEnv("webpack", null);
+	const env = yeoman.createEnv("webpack", null);
 	const generatorName: string = `webpack-${action}-generator`;
 
 	if (!generator) {
diff --git a/packages/utils/scaffold.ts b/packages/utils/scaffold.ts
@@ -66,7 +66,7 @@ export default function runTransform(transformConfig: ITransformConfig, action:
 			}
 			return astTransform(j, ast, f, config.webpackOptions[f], transformAction);
 		})
-			.then((_: any) => {
+			.then((value: string[]): void | PromiseLike <void> => {
 				let configurationName: string;
 				if (!config.configName) {
 					configurationName = "webpack.config.js";
diff --git a/packages/webpack-scaffold/index.ts b/packages/webpack-scaffold/index.ts
@@ -1,6 +1,6 @@
 import * as jscodeshift from "jscodeshift";
 
-export interface IScaffoldBaseObject {
+export interface IInquirerScaffoldObject {
 	type?: string;
 	name: string;
 	message: string;
@@ -12,11 +12,11 @@ export interface IScaffoldBaseObject {
 	filter?: (name: string) => string;
 }
 
-export interface IInquirerList extends IScaffoldBaseObject {
+export interface IInquirerList extends IInquirerScaffoldObject {
 	choices?: string[];
 }
 
-export interface IInquirerInput extends IScaffoldBaseObject {
+export interface IInquirerInput extends IInquirerScaffoldObject {
 	validate?: (input: string) => string | boolean;
 }
 
@@ -110,7 +110,7 @@ export function InputValidate(name: string, message: string, cb?: (input: string
 	};
 }
 
-export function Confirm(name: string, message: string): IScaffoldBaseObject {
+export function Confirm(name: string, message: string): IInquirerScaffoldObject {
 	return {
 		message,
 		name,

Original file line number	Diff line number	Diff line change
`@@ -16,5 +16,12 @@`
`16`	`16`	`"dependencies": {`
`17`	`17`	`"@webpack-cli/generators": "^0.0.8",`
`18`	`18`	`"yeoman-environment": "^2.1.1"`
	`19`	`+ },`
	`20`	`+ "devDependencies": {`
	`21`	`+ "@types/node": "^10.3.6",`
	`22`	`+ "typescript": "^2.9.2"`
	`23`	`+ },`
	`24`	`+ "scripts": {`
	`25`	`+ "build": "tsc"`
`19`	`26`	`}`
`20`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "extends": "../../tsconfig.json"`
	`3`	`+}`