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.

Sign up for GitHub

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

docs(readme): added types #660

Merged
merged 7 commits into from
Jan 20, 2022
Merged

docs(readme): added types #660

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2059c80
docs(readme): added types
Jan 17, 2022
e4d02ac
docs(readme): removed yarn.lock
Jan 17, 2022
337e73a
docs(readme): wrap functions inside ()
Jan 17, 2022
bc5da1a
docs(readme): change to lower case
Jan 17, 2022
110ffe1
docs(readme): expand objects
Jan 18, 2022
e74a3d9
docs(readme): fix types in index.js
Jan 19, 2022
6bd3ae4
docs(readme): add transformall type
Jan 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
213 changes: 161 additions & 52 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,8 @@ module.exports = {

## Options

| Name | Type | Description |
| :-------------------------: | :-----------------------: | :--------------------------------------- |
| **[`patterns`](#patterns)** | `{Array<String\|Object>}` | Specify file related patterns for plugin |
| **[`options`](#options-1)** | `{Object}` | Specify options for plugin |
- **[`patterns`](#patterns)**
- **[`options`](#options-1)**

The plugin's signature:

Expand All @@ -79,26 +77,29 @@ module.exports = {
};
```

### Patterns

| Name | Type | Default | Description |
| :-------------------------------------: | :------------------: | :---------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`from`](#from) | `{String}` | `undefined` | Glob or path from where we copy files. |
| [`to`](#to) | `{String\|Function}` | `compiler.options.output` | Output path. |
| [`context`](#context) | `{String}` | `options.context \|\| compiler.options.context` | A path that determines how to interpret the `from` path. |
| [`globOptions`](#globoptions) | `{Object}` | `undefined` | [Options][glob-options] passed to the glob pattern matching library including `ignore` option. |
| [`filter`](#filter) | `{Function}` | `undefined` | Allows to filter copied assets. |
| [`toType`](#totype) | `{String}` | `undefined` | Determinate what is `to` option - directory, file or template. |
| [`force`](#force) | `{Boolean}` | `false` | Overwrites files already in `compilation.assets` (usually added by other plugins/loaders). |
| [`priority`](#priority) | `{Number}` | `0` | Allows you to specify the copy priority. |
| [`transform`](#transform) | `{Object}` | `undefined` | Allows to modify the file contents. Enable `transform` caching. You can use `{ transform: {cache: { key: 'my-cache-key' }} }` to invalidate the cache. |
| [`transformAll`](#transformAll) | `{Function}` | `undefined` | Allows you to modify the contents of multiple files and save the result to one file. |
| [`noErrorOnMissing`](#noerroronmissing) | `{Boolean}` | `false` | Doesn't generate an error on missing file(s). |
| [`info`](#info) | `{Object\|Function}` | `undefined` | Allows to add assets info. |
### `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: `String`
Type:

```ts
type from = string;
```

Default: `undefined`

Glob or path from where we copy files.
Expand Down Expand Up @@ -179,10 +180,17 @@ More [`examples`](#examples)

#### `to`

Type: `String|Function`
Type:

```ts
type to =
| string
| ((pathData: { context: string; absoluteFilename?: string }) => string);
```

Default: `compiler.options.output`

##### String
##### `string`

Output path.

Expand Down Expand Up @@ -215,7 +223,7 @@ module.exports = {
};
```

##### Function
##### `function`

Allows to modify the writing path.

Expand Down Expand Up @@ -263,7 +271,12 @@ module.exports = {

#### `context`

Type: `String`
Type:

```ts
type context = string;
```

Default: `options.context|compiler.options.context`

A path that determines how to interpret the `from` path.
Expand Down Expand Up @@ -306,7 +319,12 @@ More [`examples`](#examples)

#### `globOptions`

Type: `Object`
Type:

```ts
type globOptions = import("globby").Options;
```

Default: `undefined`

Allows to configure the glob pattern matching library used by the plugin. [See the list of supported options][glob-options]
Expand Down Expand Up @@ -335,7 +353,12 @@ module.exports = {

#### `filter`

Type: `Function`
Type:

```ts
type filter = (filepath: string) => boolean;
```

Default: `undefined`

> ℹ️ To ignore files by path please use the [`globOptions.ignore`](#globoptions) option.
Expand Down Expand Up @@ -370,19 +393,24 @@ module.exports = {

#### `toType`

Type: `String`
Type:

```ts
type toType = "dir" | "file" | "template";
```

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) |
| 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'`

Expand Down Expand Up @@ -446,7 +474,12 @@ module.exports = {

#### `force`

Type: `Boolean`
Type:

```ts
type force = boolean;
```

Default: `false`

Overwrites files already in `compilation.assets` (usually added by other plugins/loaders).
Expand All @@ -471,7 +504,12 @@ module.exports = {

#### `priority`

Type: `Number`
Type:

```ts
type priority = number;
```

Default: `0`

Allows to specify the priority of copying files with the same destination name.
Expand Down Expand Up @@ -506,12 +544,22 @@ module.exports = {

#### `transform`

Type: `Function|Object`
Type:

```ts
type transform =
| {
transformer: (input: string, absoluteFilename: string) => string;
cache?: boolean | TransformerCacheObject | undefined;
}
| ((input: string, absoluteFilename: string) => string);
```

Default: `undefined`

Allows to modify the file contents.

##### `Function`
##### `function`

**webpack.config.js**

Expand All @@ -535,16 +583,21 @@ module.exports = {
};
```

##### `Object`
##### `object`

| Name | Type | Default | Description |
| :-------------------------------: | :-----------------: | :---------: | :--------------------------------------------------------------------------------------------------------------- |
| **[`transformer`](#transformer)** | `{Function}` | `undefined` | Allows to modify the file contents. |
| **[`cache`](#cache)** | `{Boolean\|Object}` | `false` | Enable `transform` caching. You can use `transform: { cache: { key: 'my-cache-key' } }` to invalidate the cache. |
| 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: `Function`
Type:

```ts
type transformer = (input: string, absoluteFilename: string) => string;
```

Default: `undefined`

**webpack.config.js**
Expand Down Expand Up @@ -595,15 +648,37 @@ module.exports = {

###### `cache`

Type: `Boolean|Object`
Type:

```ts
type cache =
| boolean
| {
keys: {
[key: string]: any;
};
}
| {
keys: (
defaultCacheKeys: {
[key: string]: any;
},
absoluteFilename: string
) => Promise<{
[key: string]: any;
}>;
}
| undefined;
```

Default: `false`

**webpack.config.js**

Enable/disable and configure caching.
Default path to cache directory: `node_modules/.cache/copy-webpack-plugin`.

###### `Boolean`
###### `boolean`

Enables/Disable `transform` caching.

Expand All @@ -630,7 +705,7 @@ module.exports = {
};
```

##### `Object`
##### `object`

Enables `transform` caching and setup cache directory and invalidation keys.

Expand Down Expand Up @@ -738,7 +813,18 @@ module.exports = {

#### `transformAll`

Type: `Function`
Type:

```ts
type transformAll = (
data: {
data: Buffer;
sourceFilename: string;
absoluteFilename: string;
}[]
) => any;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should not be any

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 Am I looking at the wrong type then 😕

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add @returns to types here too, looks like bug on our side

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought this returned any

```

Default: `undefined`

Allows you to modify the contents of multiple files and save the result to one file.
Expand Down Expand Up @@ -777,7 +863,12 @@ module.exports = {

### `noErrorOnMissing`

Type: `Boolean`
Type:

```ts
type noErrorOnMissing = boolean;
```

Default: `false`

Doesn't generate an error on missing file(s).
Expand All @@ -799,7 +890,19 @@ module.exports = {

#### `info`

Type: `Object|Function<Object>`
Type:

```ts
type info =
| Record<string, string>
| ((item: {
absoluteFilename: string;
sourceFilename: string;
filename: string;
toType: ToType;
}) => Record<string, string>);
```

Default: `undefined`

Allows to add assets info.
Expand Down Expand Up @@ -844,12 +947,18 @@ module.exports = {

### Options

| Name | Type | Default | Description |
| :---------------------------: | :--------: | :-----: | :----------------------------------------------- |
| [`concurrency`](#concurrency) | `{Number}` | `100` | Limits the number of simultaneous requests to fs |
- [`concurrency`](#concurrency)

#### `concurrency`

type:

```ts
type concurrency = number;
```

default: `100`

limits the number of simultaneous requests to fs

**webpack.config.js**
Expand Down
2 changes: 2 additions & 0 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,13 @@ const template = /\[\\*([\w:]+)\\*\]/i;
/**
* @callback Filter
* @param {string} filepath
* @returns {boolean}
*/

/**
* @callback TransformAllFunction
* @param {{ data: Buffer, sourceFilename: string, absoluteFilename: string }[]} data
* @returns {string | Buffer}
*/

/**
Expand Down
Loading