opensourcemirror
/
webpack
mirror of https://github.com/webpack/webpack.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Improve description in config schema

This commit is contained in:
Tobias Koppers 2020-07-09 08:55:52 +02:00
parent 1de9e16858
commit 71ec6adf3b
4 changed files with 34 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
declarations/WebpackOptions.d.ts vendored
View File

@ -1188,11 +1188,11 @@ export interface ResolveOptions {
*/
resolver?: import("enhanced-resolve").Resolver;
/**
* A list of resolve restrictions.
* A list of resolve restrictions. Resolve results must fulfill all of these restrictions to resolve successfully. Other resolve paths are taken when restrictions are not met.
*/
restrictions?: (RegExp | string)[];
/**
* A list of root paths.
* A list of directories in which requests that are server-relative URLs (starting with '/') are resolved. On non-windows system these requests are tried to resolve as absolute path first.
*/
roots?: string[];
/**

8
schemas/WebpackOptions.json
View File

@ -2232,10 +2232,10 @@
"tsType": "(import('enhanced-resolve').Resolver)"
},
"restrictions": {
"description": "A list of resolve restrictions.",
"description": "A list of resolve restrictions. Resolve results must fulfill all of these restrictions to resolve successfully. Other resolve paths are taken when restrictions are not met.",
"type": "array",
"items": {
"description": "Resolve restriction.",
"description": "Resolve restriction. Resolve result must fulfill this restriction.",
"anyOf": [
{
"instanceof": "RegExp",
@ -2248,10 +2248,10 @@
}
},
"roots": {
"description": "A list of root paths.",
"description": "A list of directories in which requests that are server-relative URLs (starting with '/') are resolved. On non-windows system these requests are tried to resolve as absolute path first.",
"type": "array",
"items": {
"description": "Root path.",
"description": "Directory in which requests that are server-relative URLs (starting with '/') are resolved.",
"type": "string"
}
},

36
test/__snapshots__/Cli.test.js.snap
View File

@ -3225,58 +3225,58 @@ Object {
"resolve-loader-restrictions": Object {
"configs": Array [
Object {
"description": "Resolve restriction.",
"description": "Resolve restriction. Resolve result must fulfill this restriction.",
"multiple": true,
"path": "resolveLoader.restrictions[]",
"type": "RegExp",
},
Object {
"description": "Resolve restriction.",
"description": "Resolve restriction. Resolve result must fulfill this restriction.",
"multiple": true,
"path": "resolveLoader.restrictions[]",
"type": "string",
},
],
"description": "Resolve restriction.",
"description": "Resolve restriction. Resolve result must fulfill this restriction.",
"multiple": true,
"simpleType": "string",
},
"resolve-loader-restrictions-reset": Object {
"configs": Array [
Object {
"description": "Clear all items provided in configuration. A list of resolve restrictions.",
"description": "Clear all items provided in configuration. A list of resolve restrictions. Resolve results must fulfill all of these restrictions to resolve successfully. Other resolve paths are taken when restrictions are not met.",
"multiple": false,
"path": "resolveLoader.restrictions",
"type": "reset",
},
],
"description": "Clear all items provided in configuration. A list of resolve restrictions.",
"description": "Clear all items provided in configuration. A list of resolve restrictions. Resolve results must fulfill all of these restrictions to resolve successfully. Other resolve paths are taken when restrictions are not met.",
"multiple": false,
"simpleType": "boolean",
},
"resolve-loader-roots": Object {
"configs": Array [
Object {
"description": "Root path.",
"description": "Directory in which requests that are server-relative URLs (starting with '/') are resolved.",
"multiple": true,
"path": "resolveLoader.roots[]",
"type": "string",
},
],
"description": "Root path.",
"description": "Directory in which requests that are server-relative URLs (starting with '/') are resolved.",
"multiple": true,
"simpleType": "string",
},
"resolve-loader-roots-reset": Object {
"configs": Array [
Object {
"description": "Clear all items provided in configuration. A list of root paths.",
"description": "Clear all items provided in configuration. A list of directories in which requests that are server-relative URLs (starting with '/') are resolved. On non-windows system these requests are tried to resolve as absolute path first.",
"multiple": false,
"path": "resolveLoader.roots",
"type": "reset",
},
],
"description": "Clear all items provided in configuration. A list of root paths.",
"description": "Clear all items provided in configuration. A list of directories in which requests that are server-relative URLs (starting with '/') are resolved. On non-windows system these requests are tried to resolve as absolute path first.",
"multiple": false,
"simpleType": "boolean",
},
@ -3400,58 +3400,58 @@ Object {
"resolve-restrictions": Object {
"configs": Array [
Object {
"description": "Resolve restriction.",
"description": "Resolve restriction. Resolve result must fulfill this restriction.",
"multiple": true,
"path": "resolve.restrictions[]",
"type": "RegExp",
},
Object {
"description": "Resolve restriction.",
"description": "Resolve restriction. Resolve result must fulfill this restriction.",
"multiple": true,
"path": "resolve.restrictions[]",
"type": "string",
},
],
"description": "Resolve restriction.",
"description": "Resolve restriction. Resolve result must fulfill this restriction.",
"multiple": true,
"simpleType": "string",
},
"resolve-restrictions-reset": Object {
"configs": Array [
Object {
"description": "Clear all items provided in configuration. A list of resolve restrictions.",
"description": "Clear all items provided in configuration. A list of resolve restrictions. Resolve results must fulfill all of these restrictions to resolve successfully. Other resolve paths are taken when restrictions are not met.",
"multiple": false,
"path": "resolve.restrictions",
"type": "reset",
},
],
"description": "Clear all items provided in configuration. A list of resolve restrictions.",
"description": "Clear all items provided in configuration. A list of resolve restrictions. Resolve results must fulfill all of these restrictions to resolve successfully. Other resolve paths are taken when restrictions are not met.",
"multiple": false,
"simpleType": "boolean",
},
"resolve-roots": Object {
"configs": Array [
Object {
"description": "Root path.",
"description": "Directory in which requests that are server-relative URLs (starting with '/') are resolved.",
"multiple": true,
"path": "resolve.roots[]",
"type": "string",
},
],
"description": "Root path.",
"description": "Directory in which requests that are server-relative URLs (starting with '/') are resolved.",
"multiple": true,
"simpleType": "string",
},
"resolve-roots-reset": Object {
"configs": Array [
Object {
"description": "Clear all items provided in configuration. A list of root paths.",
"description": "Clear all items provided in configuration. A list of directories in which requests that are server-relative URLs (starting with '/') are resolved. On non-windows system these requests are tried to resolve as absolute path first.",
"multiple": false,
"path": "resolve.roots",
"type": "reset",
},
],
"description": "Clear all items provided in configuration. A list of root paths.",
"description": "Clear all items provided in configuration. A list of directories in which requests that are server-relative URLs (starting with '/') are resolved. On non-windows system these requests are tried to resolve as absolute path first.",
"multiple": false,
"simpleType": "boolean",
},

20
types.d.ts vendored
View File

@ -6047,12 +6047,12 @@ declare interface ResolveOptionsWebpackOptions {
resolver?: Resolver;
/**
* A list of resolve restrictions.
* A list of resolve restrictions. Resolve results must fulfill all of these restrictions to resolve successfully. Other resolve paths are taken when restrictions are not met.
*/
restrictions?: (string | RegExp)[];
/**
* A list of root paths.
* A list of directories in which requests that are server-relative URLs (starting with '/') are resolved. On non-windows system these requests are tried to resolve as absolute path first.
*/
roots?: string[];
@ -6239,11 +6239,11 @@ declare abstract class ResolverFactory {
*/
resolver?: Resolver;
/**
* A list of resolve restrictions.
* A list of resolve restrictions. Resolve results must fulfill all of these restrictions to resolve successfully. Other resolve paths are taken when restrictions are not met.
*/
restrictions?: (string | RegExp)[];
/**
* A list of root paths.
* A list of directories in which requests that are server-relative URLs (starting with '/') are resolved. On non-windows system these requests are tried to resolve as absolute path first.
*/
roots?: string[];
/**
@ -6354,11 +6354,11 @@ declare abstract class ResolverFactory {
*/
resolver?: Resolver;
/**
* A list of resolve restrictions.
* A list of resolve restrictions. Resolve results must fulfill all of these restrictions to resolve successfully. Other resolve paths are taken when restrictions are not met.
*/
restrictions?: (string | RegExp)[];
/**
* A list of root paths.
* A list of directories in which requests that are server-relative URLs (starting with '/') are resolved. On non-windows system these requests are tried to resolve as absolute path first.
*/
roots?: string[];
/**
@ -6469,11 +6469,11 @@ declare abstract class ResolverFactory {
*/
resolver?: Resolver;
/**
* A list of resolve restrictions.
* A list of resolve restrictions. Resolve results must fulfill all of these restrictions to resolve successfully. Other resolve paths are taken when restrictions are not met.
*/
restrictions?: (string | RegExp)[];
/**
* A list of root paths.
* A list of directories in which requests that are server-relative URLs (starting with '/') are resolved. On non-windows system these requests are tried to resolve as absolute path first.
*/
roots?: string[];
/**
@ -8415,11 +8415,11 @@ declare interface WithOptions {
*/
resolver?: Resolver;
/**
* A list of resolve restrictions.
* A list of resolve restrictions. Resolve results must fulfill all of these restrictions to resolve successfully. Other resolve paths are taken when restrictions are not met.
*/
restrictions?: (string | RegExp)[];
/**
* A list of root paths.
* A list of directories in which requests that are server-relative URLs (starting with '/') are resolved. On non-windows system these requests are tried to resolve as absolute path first.
*/
roots?: string[];
/**