refactor: use type for types (#3832)

webpack · Jun 4, 2023 · beea1d1 · beea1d1
1 parent 0931ab6
commit beea1d1
Show file tree

Hide file tree

Showing 20 changed files with 73 additions and 66 deletions.
diff --git a/packages/configtest/src/index.ts b/packages/configtest/src/index.ts
@@ -1,4 +1,4 @@
-import { IWebpackCLI } from "webpack-cli";
+import { type IWebpackCLI } from "webpack-cli";
 
 const WEBPACK_PACKAGE = process.env.WEBPACK_PACKAGE || "webpack";
 

diff --git a/packages/generators/src/addon-generator.ts b/packages/generators/src/addon-generator.ts
@@ -2,7 +2,7 @@ import fs from "fs";
 import path from "path";
 import Generator from "yeoman-generator";
 
-import { CustomGenerator } from "./types";
+import { CustomGenerator } from "./custom-generator";
 import type { CustomGeneratorOptions, BaseCustomGeneratorOptions } from "./types";
 import { getInstaller, getTemplate } from "./utils/helpers";
 

diff --git a/packages/generators/src/custom-generator.ts b/packages/generators/src/custom-generator.ts
@@ -0,0 +1,33 @@
+import Generator from "yeoman-generator";
+import { type IWebpackCLI } from "webpack-cli";
+import path from "path";
+import { BaseCustomGeneratorOptions, CustomGeneratorOptions } from "./types";
+
+export class CustomGenerator<
+  T extends BaseCustomGeneratorOptions = BaseCustomGeneratorOptions,
+  Z extends CustomGeneratorOptions<T> = CustomGeneratorOptions<T>,
+> extends Generator<Z> {
+  public cli: IWebpackCLI;
+  public template: string;
+  public dependencies: string[];
+  public force: boolean;
+  public answers: Record<string, unknown>;
+  public generationPath: string;
+  public supportedTemplates: string[];
+  public packageManager: string | undefined;
+
+  public constructor(args: string | string[], opts: Z) {
+    super(args, opts);
+
+    this.cli = opts.cli;
+    this.dependencies = [];
+    this.answers = {};
+    this.supportedTemplates = [];
+
+    const { options } = opts;
+
+    this.template = options.template;
+    this.force = typeof options.force !== "undefined" ? options.force : false;
+    this.generationPath = path.resolve(process.cwd(), options.generationPath);
+  }
+}
diff --git a/packages/generators/src/handlers/default.ts b/packages/generators/src/handlers/default.ts
@@ -1,6 +1,6 @@
 import path from "path";
-import { CustomGenerator } from "../types";
-import * as QuestionAPI from "../utils/scaffold-utils";
+import type { CustomGenerator } from "../custom-generator";
+import type * as QuestionAPI from "../utils/scaffold-utils";
 
 const templatePath = path.resolve(__dirname, "../../init-template/default");
 const resolveFile = (file: string): string => {

diff --git a/packages/generators/src/handlers/react.ts b/packages/generators/src/handlers/react.ts
@@ -1,7 +1,7 @@
 import path from "path";
-import { CustomGenerator } from "../types";
 import { questions as defaultQuestions } from "./default";
-import * as QuestionAPI from "../utils/scaffold-utils";
+import type { CustomGenerator } from "../custom-generator";
+import type * as QuestionAPI from "../utils/scaffold-utils";
 
 const templatePath = path.resolve(__dirname, "../../init-template/react");
 const resolveFile = (file: string): string => {

diff --git a/packages/generators/src/index.ts b/packages/generators/src/index.ts
@@ -4,7 +4,7 @@ import pluginGenerator from "./plugin-generator";
 import addonGenerator from "./addon-generator";
 import initGenerator from "./init-generator";
 import type { InitOptions, LoaderOptions, PluginOptions } from "./types";
-import { IWebpackCLI } from "webpack-cli";
+import type { IWebpackCLI } from "webpack-cli";
 
 class GeneratorsCommand {
   async apply(cli: IWebpackCLI): Promise<void> {

diff --git a/packages/generators/src/init-generator.ts b/packages/generators/src/init-generator.ts
@@ -1,10 +1,12 @@
 import { readFileSync, writeFileSync } from "fs";
 
-import { CustomGenerator, InitGeneratorOptions, CustomGeneratorOptions } from "./types";
+import { CustomGenerator } from "./custom-generator";
 import { getInstaller, getTemplate } from "./utils/helpers";
 import * as Question from "./utils/scaffold-utils";
 import handlers from "./handlers";
 
+import { type InitGeneratorOptions, type CustomGeneratorOptions } from "./types";
+
 export default class InitGenerator<
   T extends InitGeneratorOptions = InitGeneratorOptions,
   Z extends CustomGeneratorOptions<T> = CustomGeneratorOptions<T>,

diff --git a/packages/generators/src/loader-generator.ts b/packages/generators/src/loader-generator.ts
@@ -1,8 +1,9 @@
 import path from "path";
 import addonGenerator from "./addon-generator";
 import { toKebabCase } from "./utils/helpers";
+
 import type { LoaderGeneratorOptions } from "./types";
-import Generator from "yeoman-generator";
+import type Generator from "yeoman-generator";
 
 /**
  * Formats a string into webpack loader format

diff --git a/packages/generators/src/plugin-generator.ts b/packages/generators/src/plugin-generator.ts
@@ -2,7 +2,7 @@ import path from "path";
 import addonGenerator from "./addon-generator";
 import { toKebabCase, toUpperCamelCase } from "./utils/helpers";
 import type { PluginGeneratorOptions } from "./types";
-import Generator from "yeoman-generator";
+import type Generator from "yeoman-generator";
 
 export const PluginGenerator = addonGenerator<PluginGeneratorOptions>(
   [

diff --git a/packages/generators/src/types/index.ts b/packages/generators/src/types/index.ts
@@ -1,6 +1,5 @@
-import Generator from "yeoman-generator";
-import path from "path";
-import { IWebpackCLI } from "webpack-cli";
+import type Generator from "yeoman-generator";
+import { type IWebpackCLI } from "webpack-cli";
 
 export type InitOptions = { template: string; force?: boolean };
 export type LoaderOptions = { template: string };
@@ -20,32 +19,3 @@ export type CustomGeneratorOptions<T extends BaseCustomGeneratorOptions> =
     cli: IWebpackCLI;
     options: T;
   };
-
-export class CustomGenerator<
-  T extends BaseCustomGeneratorOptions = BaseCustomGeneratorOptions,
-  Z extends CustomGeneratorOptions<T> = CustomGeneratorOptions<T>,
-> extends Generator<Z> {
-  public cli: IWebpackCLI;
-  public template: string;
-  public dependencies: string[];
-  public force: boolean;
-  public answers: Record<string, unknown>;
-  public generationPath: string;
-  public supportedTemplates: string[];
-  public packageManager: string | undefined;
-
-  public constructor(args: string | string[], opts: Z) {
-    super(args, opts);
-
-    this.cli = opts.cli;
-    this.dependencies = [];
-    this.answers = {};
-    this.supportedTemplates = [];
-
-    const { options } = opts;
-
-    this.template = options.template;
-    this.force = typeof options.force !== "undefined" ? options.force : false;
-    this.generationPath = path.resolve(process.cwd(), options.generationPath);
-  }
-}
diff --git a/packages/generators/src/utils/helpers.ts b/packages/generators/src/utils/helpers.ts
@@ -1,4 +1,4 @@
-import { CustomGenerator } from "../types";
+import type { CustomGenerator } from "../custom-generator";
 import { List } from "./scaffold-utils";
 
 const regex = /[A-Z]{2,}(?=[A-Z][a-z]+[0-9]*|\b)|[A-Z]?[a-z]+[0-9]*|[A-Z]|[0-9]+/g;

diff --git a/packages/generators/src/utils/scaffold-utils.ts b/packages/generators/src/utils/scaffold-utils.ts
@@ -1,4 +1,4 @@
-import Generator from "yeoman-generator";
+import type Generator from "yeoman-generator";
 
 type CustomGeneratorStringPrompt = { [x: string]: string } | Promise<{ [x: string]: string }>;
 type CustomGeneratorBoolPrompt = { [x: string]: boolean } | Promise<{ [x: string]: boolean }>;

diff --git a/packages/info/src/index.ts b/packages/info/src/index.ts
@@ -1,4 +1,4 @@
-import { IWebpackCLI } from "webpack-cli";
+import { type IWebpackCLI } from "webpack-cli";
 
 class InfoCommand {
   async apply(cli: IWebpackCLI): Promise<void> {

diff --git a/packages/serve/src/index.ts b/packages/serve/src/index.ts
@@ -1,5 +1,5 @@
-import type { Compiler, cli } from "webpack";
-import { IWebpackCLI, WebpackDevServerOptions } from "webpack-cli";
+import { type Compiler, type cli } from "webpack";
+import { type IWebpackCLI, type WebpackDevServerOptions } from "webpack-cli";
 
 const WEBPACK_PACKAGE = process.env.WEBPACK_PACKAGE || "webpack";
 const WEBPACK_DEV_SERVER_PACKAGE = process.env.WEBPACK_DEV_SERVER_PACKAGE || "webpack-dev-server";

diff --git a/packages/webpack-cli/src/bootstrap.ts b/packages/webpack-cli/src/bootstrap.ts
@@ -1,4 +1,4 @@
-import { IWebpackCLI } from "./types";
+import { type IWebpackCLI } from "./types";
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const WebpackCLI = require("./webpack-cli");

diff --git a/packages/webpack-cli/src/index.ts b/packages/webpack-cli/src/index.ts
@@ -1,5 +1,5 @@
-import { IWebpackCLI } from "./types";
-export * from "./types";
+import { type IWebpackCLI } from "./types";
+export type * from "./types";
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const CLI: IWebpackCLI = require("./webpack-cli");

diff --git a/packages/webpack-cli/src/plugins/cli-plugin.ts b/packages/webpack-cli/src/plugins/cli-plugin.ts
@@ -1,5 +1,5 @@
-import { Compiler } from "webpack";
-import { CLIPluginOptions } from "../types";
+import { type Compiler } from "webpack";
+import { type CLIPluginOptions } from "../types";
 
 export class CLIPlugin {
   logger!: ReturnType<Compiler["getInfrastructureLogger"]>;

diff --git a/packages/webpack-cli/src/types.ts b/packages/webpack-cli/src/types.ts
@@ -1,4 +1,4 @@
-import webpack, {
+import type {
   EntryOptions,
   Stats,
   Configuration,
@@ -12,16 +12,17 @@ import webpack, {
   AssetEmittedInfo,
   FileCacheOptions,
 } from "webpack";
+import type webpack from "webpack";
 
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore extraneous import is intended
 // eslint-disable-next-line node/no-extraneous-import
-import { ClientConfiguration, Configuration as DevServerConfig } from "webpack-dev-server";
+import type { ClientConfiguration, Configuration as DevServerConfig } from "webpack-dev-server";
 
-import { Colorette } from "colorette";
-import { Command, CommandOptions, Option, ParseOptions } from "commander";
-import { prepare } from "rechoir";
-import { stringifyStream } from "@discoveryjs/json-ext";
+import { type Colorette } from "colorette";
+import { type Command, type CommandOptions, type Option, type ParseOptions } from "commander";
+import { type prepare } from "rechoir";
+import { type stringifyStream } from "@discoveryjs/json-ext";
 
 /**
  * Webpack CLI

diff --git a/packages/webpack-cli/src/utils/dynamic-import-loader.ts b/packages/webpack-cli/src/utils/dynamic-import-loader.ts
@@ -1,4 +1,4 @@
-import { DynamicImport } from "../types";
+import { type DynamicImport } from "../types";
 
 function dynamicImportLoader<T>(): DynamicImport<T> | null {
   let importESM;

diff --git a/packages/webpack-cli/src/webpack-cli.ts b/packages/webpack-cli/src/webpack-cli.ts
@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
-import {
+import type {
   IWebpackCLI,
   WebpackCLICommandOption,
   WebpackCLIBuiltInOption,
@@ -43,13 +43,13 @@ import {
   Problem,
 } from "./types";
 
-import webpackMerge from "webpack-merge";
-import webpack from "webpack";
-import { Compiler, MultiCompiler, WebpackError, StatsOptions } from "webpack";
-import { stringifyStream } from "@discoveryjs/json-ext";
-import { Help, ParseOptions } from "commander";
+import type webpackMerge from "webpack-merge";
+import type webpack from "webpack";
+import { type Compiler, type MultiCompiler, type WebpackError, type StatsOptions } from "webpack";
+import { type stringifyStream } from "@discoveryjs/json-ext";
+import { type Help, type ParseOptions } from "commander";
 
-import { CLIPlugin as CLIPluginClass } from "./plugins/cli-plugin";
+import { type CLIPlugin as CLIPluginClass } from "./plugins/cli-plugin";
 
 const fs = require("fs");
 const path = require("path");