Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Repair typings #1166

Merged
merged 1 commit into from Feb 16, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions index.js
Expand Up @@ -46,7 +46,7 @@ class HtmlWebpackPlugin {
inject: true,
compile: true,
favicon: false,
minify: undefined,
minify: 'auto',
cache: true,
showErrors: true,
chunks: 'all',
Expand Down Expand Up @@ -112,7 +112,7 @@ class HtmlWebpackPlugin {
const isProductionLikeMode = compiler.options.mode === 'production' || !compiler.options.mode;

const minify = this.options.minify;
if (minify === true || (minify === undefined && isProductionLikeMode)) {
if (minify === true || (minify === 'auto' && isProductionLikeMode)) {
/** @type { import('html-minifier').Options } */
this.options.minify = {
// https://github.com/kangax/html-minifier#options-quick-reference
Expand Down Expand Up @@ -435,7 +435,7 @@ class HtmlWebpackPlugin {
const htmlAfterInjection = this.options.inject
? this.injectAssetsIntoHtml(html, assets, assetTags)
: html;
const htmlAfterMinification = this.options.minify
const htmlAfterMinification = typeof this.options.minify === 'object'
? require('html-minifier').minify(htmlAfterInjection, this.options.minify)
: htmlAfterInjection;
return Promise.resolve(htmlAfterMinification);
Expand Down
2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -48,7 +48,7 @@
"semistandard": "12.0.1",
"standard-version": "^4.4.0",
"style-loader": "^0.23.0",
"typescript": "^2.9.2",
"typescript": "^3.3.3",
"webpack": "^4.20.2",
"webpack-recompilation-simulator": "^3.0.0"
},
Expand Down
67 changes: 26 additions & 41 deletions typings.d.ts
Expand Up @@ -2,13 +2,6 @@ import { Plugin } from "webpack";
import { AsyncSeriesWaterfallHook } from "tapable";
import { Options as HtmlMinifierOptions } from "html-minifier";

// https://github.com/Microsoft/TypeScript/issues/15012#issuecomment-365453623
type Required<T> = T extends object
? { [P in keyof T]-?: NonNullable<T[P]> }
: T;
// https://stackoverflow.com/questions/48215950/exclude-property-from-type
type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;

export = HtmlWebpackPlugin;

declare class HtmlWebpackPlugin extends Plugin {
Expand All @@ -18,58 +11,60 @@ declare class HtmlWebpackPlugin extends Plugin {
declare namespace HtmlWebpackPlugin {
type MinifyOptions = HtmlMinifierOptions;

interface Options extends Partial<ProcessedOptions> {}

/**
* The plugin options
* The plugin options after adding default values
*/
interface Options {
interface ProcessedOptions {
/**
* Emit the file only if it was changed.
* Default: `true`.
*/
cache?: boolean;
cache: boolean;
/**
* List all entries which should be injected
*/
chunks?: "all" | string[];
chunks: "all" | string[];
/**
* Allows to control how chunks should be sorted before they are included to the html.
* Default: `'auto'`.
*/
chunksSortMode?:
chunksSortMode:
| "auto"
| "manual"
| (((entryNameA: string, entryNameB: string) => number));
/**
* List all entries which should not be injeccted
*/
excludeChunks?: string[];
excludeChunks: string[];
/**
* Path to the favicon icon
*/
favicon?: false | string;
favicon: false | string;
/**
* The file to write the HTML to.
* Defaults to `index.html`.
* Supports subdirectories eg: `assets/admin.html`
*/
filename?: string;
filename: string;
/**
* If `true` then append a unique `webpack` compilation hash to all included scripts and CSS files.
* This is useful for cache busting
*/
hash?: boolean;
hash: boolean;
/**
* Inject all assets into the given `template` or `templateContent`.
*/
inject?:
inject:
| false // Don't inject scripts
| true // Inject scripts into body
| "body" // Inject scripts into body
| "head"; // Inject scripts into head
/**
* Inject meta tags
*/
meta?:
meta:
| false // Disable injection
| {
[name: string]:
Expand All @@ -78,30 +73,33 @@ declare namespace HtmlWebpackPlugin {
| { [attributeName: string]: string | boolean }; // custom properties e.g. { name:"viewport" content:"width=500, initial-scale=1" }
};
/**
* HTML Minification options
* HTML Minification options accepts the following valeus:
* - Set to `false` to disable minifcation
* - Set to `'auto'` to enable minifcation only for production mode
* - Set to custom minification according to
* @https://github.com/kangax/html-minifier#options-quick-reference
*/
minify?: boolean | MinifyOptions;
minify: 'auto' | boolean | MinifyOptions;
/**
* Render errors into the HTML page
*/
showErrors?: boolean;
showErrors: boolean;
/**
* The `webpack` require path to the template.
* @see https://github.com/jantimon/html-webpack-plugin/blob/master/docs/template-option.md
*/
template?: string;
template: string;
/**
* Allow to use a html string instead of reading from a file
*/
templateContent?:
templateContent:
| false // Use the template option instead to load a file
| string
| Promise<string>;
/**
* Allows to overwrite the parameters used in the template
*/
templateParameters?:
templateParameters:
| false // Pass an empty object to the template function
| ((
compilation: any,
Expand All @@ -110,7 +108,7 @@ declare namespace HtmlWebpackPlugin {
headTags: HtmlTagObject[];
bodyTags: HtmlTagObject[];
},
options: Options
options: ProcessedOptions
) => { [option: string]: any })
| ((
compilation: any,
Expand All @@ -119,37 +117,24 @@ declare namespace HtmlWebpackPlugin {
headTags: HtmlTagObject[];
bodyTags: HtmlTagObject[];
},
options: Options
options: ProcessedOptions
) => Promise<{ [option: string]: any }>)
| { [option: string]: any };
/**
* The title to use for the generated HTML document
*/
title?: string;
title: string;
/**
* Enforce self closing tags e.g. <link />
*/
xhtml?: boolean;
xhtml: boolean;
/**
* In addition to the options actually used by this plugin, you can use this hash to pass arbitrary data through
* to your template.
*/
[option: string]: any;
}

/**
* Options interface that matches the expectations of the index.js API:
* - All fields are required
* - The minify property matches what html-minifier expects (eg either a MinifyOptions or undefined).
* html-minifier does not accept a boolean value. As TypeScript does not allow a property to be redefined
* in an extended interface we need to omit it and then define it properly
*
* The Required and Omit types are defined at the top of the file
*/
interface ProcessedOptions extends Required<Omit<Options, "minify">> {
minify: MinifyOptions | undefined;
}

/**
* The values which are available during template execution
*
Expand Down