docs(readme): added types #660
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -52,10 +52,8 @@ module.exports = { | |
|
|
||
| ## Options | ||
|
|
||
| - **[`patterns`](#patterns)** | ||
| - **[`options`](#options-1)** | ||
|
|
||
| The plugin's signature: | ||
|
|
||
|
|
@@ -79,26 +77,29 @@ module.exports = { | |
| }; | ||
| ``` | ||
|
|
||
| ### `Patterns` | ||
|
|
||
| - [`from`](#from) | ||
| - [`to`](#to) | ||
| - [`context`](#context) | ||
| - [`globOptions`](#globoptions) | ||
| - [`filter`](#filter) | ||
| - [`toType`](#totype) | ||
| - [`force`](#force) | ||
| - [`priority`](#priority) | ||
| - [`transform`](#transform) | ||
| - [`transformAll`](#transformAll) | ||
| - [`noErrorOnMissing`](#noerroronmissing) | ||
| - [`info`](#info) | ||
|
|
||
| #### `from` | ||
|
|
||
| Type: | ||
|
|
||
| ```ts | ||
| type from = string; | ||
| ``` | ||
|
|
||
| Default: `undefined` | ||
|
|
||
| Glob or path from where we copy files. | ||
|
|
@@ -179,10 +180,17 @@ More [`examples`](#examples) | |
|
|
||
| #### `to` | ||
|
|
||
| Type: | ||
|
|
||
| ```ts | ||
| type to = | ||
| | string | ||
| | ((pathData: { context: string; absoluteFilename?: string }) => string); | ||
| ``` | ||
|
|
||
| Default: `compiler.options.output` | ||
|
|
||
| ##### `string` | ||
|
|
||
| Output path. | ||
|
|
||
|
|
@@ -215,7 +223,7 @@ module.exports = { | |
| }; | ||
| ``` | ||
|
|
||
| ##### `function` | ||
|
|
||
| Allows to modify the writing path. | ||
|
|
||
|
|
@@ -263,7 +271,12 @@ module.exports = { | |
|
|
||
| #### `context` | ||
|
|
||
| Type: | ||
|
|
||
| ```ts | ||
| type context = string; | ||
| ``` | ||
|
|
||
| Default: `options.context|compiler.options.context` | ||
|
|
||
| A path that determines how to interpret the `from` path. | ||
|
|
@@ -306,7 +319,12 @@ More [`examples`](#examples) | |
|
|
||
| #### `globOptions` | ||
|
|
||
| Type: | ||
|
|
||
| ```ts | ||
| type globOptions = object; | ||
| ``` | ||
|
|
||
| Default: `undefined` | ||
|
|
||
| Allows to configure the glob pattern matching library used by the plugin. [See the list of supported options][glob-options] | ||
|
|
@@ -335,7 +353,12 @@ module.exports = { | |
|
|
||
| #### `filter` | ||
|
|
||
| Type: | ||
|
|
||
| ```ts | ||
| type filter = (filepath: string) => any; | ||
harish-sethuraman marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ``` | ||
|
|
||
| Default: `undefined` | ||
|
|
||
| > ℹ️ To ignore files by path please use the [`globOptions.ignore`](#globoptions) option. | ||
|
|
@@ -370,19 +393,24 @@ module.exports = { | |
|
|
||
| #### `toType` | ||
|
|
||
| Type: | ||
|
|
||
| ```ts | ||
| type toType = string; | ||
harish-sethuraman marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ``` | ||
|
|
||
| Default: `undefined` | ||
|
|
||
| Determinate what is `to` option - directory, file or template. | ||
| Sometimes it is hard to say what is `to`, example `path/to/dir-with.ext`. | ||
| If you want to copy files in directory you need use `dir` option. | ||
| We try to automatically determine the `type` so you most likely do not need this option. | ||
|
|
||
| | Name | Type | Default | Description | | ||
| | :---------------------------: | :------: | :---------: | :--------------------------------------------------------------------------------------------------- | | ||
| | **[`'dir'`](#dir)** | `string` | `undefined` | If `to` has no extension or ends on `'/'` | | ||
| | **[`'file'`](#file)** | `string` | `undefined` | If `to` is not a directory and is not a template | | ||
| | **[`'template'`](#template)** | `string` | `undefined` | If `to` contains [a template pattern](https://webpack.js.org/configuration/output/#template-strings) | | ||
|
|
||
| ##### `'dir'` | ||
|
|
||
|
|
@@ -446,7 +474,12 @@ module.exports = { | |
|
|
||
| #### `force` | ||
|
|
||
| Type: | ||
|
|
||
| ```ts | ||
| type force = boolean; | ||
| ``` | ||
|
|
||
| Default: `false` | ||
|
|
||
| Overwrites files already in `compilation.assets` (usually added by other plugins/loaders). | ||
|
|
@@ -471,7 +504,12 @@ module.exports = { | |
|
|
||
| #### `priority` | ||
|
|
||
| Type: | ||
|
|
||
| ```ts | ||
| type priority = number; | ||
| ``` | ||
|
|
||
| Default: `0` | ||
|
|
||
| Allows to specify the priority of copying files with the same destination name. | ||
|
|
@@ -506,12 +544,17 @@ module.exports = { | |
|
|
||
| #### `transform` | ||
|
|
||
| Type: | ||
|
|
||
| ```ts | ||
| type transform = object | ((input: string, absoluteFilename: string) => string); | ||
harish-sethuraman marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ``` | ||
|
|
||
| Default: `undefined` | ||
|
|
||
| Allows to modify the file contents. | ||
|
|
||
| ##### `function` | ||
|
|
||
| **webpack.config.js** | ||
|
|
||
|
|
@@ -535,16 +578,21 @@ module.exports = { | |
| }; | ||
| ``` | ||
|
|
||
| ##### `object` | ||
|
|
||
| | Name | Default | Description | | ||
| | :-------------------------------: | :---------: | :--------------------------------------------------------------------------------------------------------------- | | ||
| | **[`transformer`](#transformer)** | `undefined` | Allows to modify the file contents. | | ||
| | **[`cache`](#cache)** | `false` | Enable `transform` caching. You can use `transform: { cache: { key: 'my-cache-key' } }` to invalidate the cache. | | ||
|
|
||
| ###### `transformer` | ||
|
|
||
| Type: | ||
|
|
||
| ```ts | ||
| type transformer = (input: string, absoluteFilename: string) => string; | ||
| ``` | ||
|
|
||
| Default: `undefined` | ||
|
|
||
| **webpack.config.js** | ||
|
|
@@ -595,15 +643,20 @@ module.exports = { | |
|
|
||
| ###### `cache` | ||
|
|
||
| Type: | ||
|
|
||
| ```ts | ||
| type cache = boolean | object; | ||
harish-sethuraman marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ``` | ||
|
|
||
| Default: `false` | ||
|
|
||
| **webpack.config.js** | ||
|
|
||
| Enable/disable and configure caching. | ||
| Default path to cache directory: `node_modules/.cache/copy-webpack-plugin`. | ||
|
|
||
| ###### `boolean` | ||
|
|
||
| Enables/Disable `transform` caching. | ||
|
|
||
|
|
@@ -630,7 +683,7 @@ module.exports = { | |
| }; | ||
| ``` | ||
|
|
||
| ##### `object` | ||
|
|
||
| Enables `transform` caching and setup cache directory and invalidation keys. | ||
|
|
||
|
|
@@ -738,7 +791,18 @@ module.exports = { | |
|
|
||
| #### `transformAll` | ||
|
|
||
| Type: | ||
|
|
||
| ```ts | ||
| type transformAll = ( | ||
| data: { | ||
| data: Buffer; | ||
| sourceFilename: string; | ||
| absoluteFilename: string; | ||
| }[] | ||
| ) => any; | ||
|
There was a problem hiding this comment.
🤔 Am I looking at the wrong type then 😕 There was a problem hiding this comment. We should add There was a problem hiding this comment.
I thought this returned any |
||
| ``` | ||
|
|
||
| Default: `undefined` | ||
|
|
||
| Allows you to modify the contents of multiple files and save the result to one file. | ||
|
|
@@ -777,7 +841,12 @@ module.exports = { | |
|
|
||
| ### `noErrorOnMissing` | ||
|
|
||
| Type: | ||
|
|
||
| ```ts | ||
| type noErrorOnMissing = boolean; | ||
| ``` | ||
|
|
||
| Default: `false` | ||
|
|
||
| Doesn't generate an error on missing file(s). | ||
|
|
@@ -799,7 +868,12 @@ module.exports = { | |
|
|
||
| #### `info` | ||
|
|
||
| Type: | ||
|
|
||
| ```ts | ||
| type info = object | (() => object); | ||
harish-sethuraman marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ``` | ||
|
|
||
| Default: `undefined` | ||
|
|
||
| Allows to add assets info. | ||
|
|
@@ -844,12 +918,18 @@ module.exports = { | |
|
|
||
| ### Options | ||
|
|
||
| - [`concurrency`](#concurrency) | ||
|
|
||
| #### `concurrency` | ||
|
|
||
| type: | ||
|
|
||
| ```ts | ||
| type concurrency = number; | ||
| ``` | ||
|
|
||
| default: `100` | ||
|
|
||
| limits the number of simultaneous requests to fs | ||
|
|
||
| **webpack.config.js** | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's use types from
globby, just use the same nameThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
import("globby").Options?