Skip to content

Commit 52956a2

Browse files
authored
Fixing the typos and grammatical errors in Readme files (#1246)
* chore: fix grammatical errors * chore: fix typos
1 parent 7faaed2 commit 52956a2

File tree

2 files changed

+34
-34
lines changed

2 files changed

+34
-34
lines changed

SECURITY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ webpack CLI is currently supporting webpack v4 and webpack v5. Security fixes ar
1818

1919
## Reporting a Vulnerability
2020

21-
To report a vulnerability, please contact one of webpack maintainers through the email provided from either npm, GitHub or reach out at other social media platforms. For third party security vulnerabilities, submitting an issue or Pull Request to fix the security vulerability is much appreciated.
21+
To report a vulnerability, please contact one of webpack maintainers through the email provided from either npm, GitHub or reach out at other social media platforms. For third party security vulnerabilities, submitting an issue or Pull Request to fix the security vulnerability is much appreciated.

packages/webpack-scaffold/README.md

+33-33
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ Param: `String`
3434
Used when you cannot use regular conventions. Handy for examples like `RegExp` or `output.sourcePrefix`
3535

3636
```js
37-
const parseValue = require("@webpack-cli/webpack-scaffold").parseValue;
37+
const parseValue = require('@webpack-cli/webpack-scaffold').parseValue;
3838

39-
this.configuration.myScaffold.webpackOptions.output.sourcePrefix = parseValue("\t");
39+
this.configuration.myScaffold.webpackOptions.output.sourcePrefix = parseValue('\t');
4040
// sourcePrefix: '\t'
4141
```
4242

@@ -47,9 +47,9 @@ Param: `String`
4747
Generally used when dealing with an entry point as an arrow function
4848

4949
```js
50-
const createArrowFunction = require("@webpack-cli/webpack-scaffold").createArrowFunction;
50+
const createArrowFunction = require('@webpack-cli/webpack-scaffold').createArrowFunction;
5151

52-
this.configuration.myScaffold.webpackOptions.entry = createArrowFunction("app.js");
52+
this.configuration.myScaffold.webpackOptions.entry = createArrowFunction('app.js');
5353
// entry: () => 'app.js'
5454
```
5555

@@ -60,9 +60,9 @@ Param: `String`
6060
Used when creating a function that returns a single value
6161

6262
```js
63-
const createRegularFunction = require("@webpack-cli/webpack-scaffold").createRegularFunction;
63+
const createRegularFunction = require('@webpack-cli/webpack-scaffold').createRegularFunction;
6464

65-
this.configuration.myScaffold.webpackOptions.entry = createRegularFunction("app.js");
65+
this.configuration.myScaffold.webpackOptions.entry = createRegularFunction('app.js');
6666
// entry: function() { return 'app.js' }
6767
```
6868

@@ -73,12 +73,12 @@ Param: `Array` | `String`
7373
Used to create a dynamic entry point
7474

7575
```js
76-
const createDynamicPromise = require("@webpack-cli/webpack-scaffold").createDynamicPromise;
76+
const createDynamicPromise = require('@webpack-cli/webpack-scaffold').createDynamicPromise;
7777

78-
this.confguration.myScaffold.webpackOptions.entry = createDynamicPromise("app.js");
78+
this.confguration.myScaffold.webpackOptions.entry = createDynamicPromise('app.js');
7979
// entry: () => new Promise((resolve) => resolve('app.js'))
8080

81-
this.configuration.myScaffold.webpackOptions.entry = createDynamicPromise(["app.js", "index.js"]);
81+
this.configuration.myScaffold.webpackOptions.entry = createDynamicPromise(['app.js', 'index.js']);
8282
// entry: () => new Promise((resolve) => resolve(['app.js','index.js']))
8383
```
8484

@@ -89,22 +89,22 @@ Param: `String`
8989
Used to create an [assetFilterFunction](https://webpack.js.org/configuration/performance/#performance-assetfilter)
9090

9191
```js
92-
const createAssetFilterFunction = require("@webpack-cli/webpack-scaffold").createAssetFilterFunction;
92+
const createAssetFilterFunction = require('@webpack-cli/webpack-scaffold').createAssetFilterFunction;
9393

94-
this.configuration.myScaffold.webpackOptions.performance.assetFilter = createAssetFilterFunction("js");
94+
this.configuration.myScaffold.webpackOptions.performance.assetFilter = createAssetFilterFunction('js');
9595
// assetFilter: function (assetFilename) { return assetFilename.endsWith('.js'); }
9696
```
9797

9898
## createExternalFunction
9999

100100
Param: `String`
101101

102-
Used to create an [general function from Externals](https://webpack.js.org/configuration/externals/#function)
102+
Used to create a [general function from Externals](https://webpack.js.org/configuration/externals/#function)
103103

104104
```js
105-
const createExternalFunction = require("@webpack-cli/webpack-scaffold").createExternalFunction;
105+
const createExternalFunction = require('@webpack-cli/webpack-scaffold').createExternalFunction;
106106

107-
this.configuration.myScaffold.webpackOptions.externals = [createExternalFunction("^yourregex$")];
107+
this.configuration.myScaffold.webpackOptions.externals = [createExternalFunction('^yourregex$')];
108108
/*
109109
externals: [
110110
function(context, request, callback) {
@@ -123,9 +123,9 @@ Param: `String`
123123
Used to create a module in `topScope`
124124

125125
```js
126-
const createRequire = require("@webpack-cli/webpack-scaffold").createRequire;
126+
const createRequire = require('@webpack-cli/webpack-scaffold').createRequire;
127127

128-
this.configuration.myScaffold.topScope = [createRequire("webpack")];
128+
this.configuration.myScaffold.topScope = [createRequire('webpack')];
129129
// const webpack = require('webpack')
130130
```
131131

@@ -138,9 +138,9 @@ Param: `name<String>, message<String>, choices<Array>`
138138
Creates a List from Inquirer
139139

140140
```js
141-
const List = require("@webpack-cli/webpack-scaffold").List;
141+
const List = require('@webpack-cli/webpack-scaffold').List;
142142

143-
List("entry", "what kind of entry do you want?", ["Array", "Function"]);
143+
List('entry', 'what kind of entry do you want?', ['Array', 'Function']);
144144
```
145145

146146
### RawList
@@ -150,9 +150,9 @@ Param: `name<String>, message<String>, choices<Array>`
150150
Creates a RawList from Inquirer
151151

152152
```js
153-
const RawList = require("@webpack-cli/webpack-scaffold").RawList;
153+
const RawList = require('@webpack-cli/webpack-scaffold').RawList;
154154

155-
RawList("entry", "what kind of entry do you want?", ["Array", "Function"]);
155+
RawList('entry', 'what kind of entry do you want?', ['Array', 'Function']);
156156
```
157157

158158
### CheckList
@@ -162,9 +162,9 @@ Param: `name<String>, message<String>, choices<Array>`
162162
Creates a CheckList(`checkbox`) from Inquirer
163163

164164
```js
165-
const CheckList = require("@webpack-cli/webpack-scaffold").CheckList;
165+
const CheckList = require('@webpack-cli/webpack-scaffold').CheckList;
166166

167-
CheckList("entry", "what kind of entry do you want?", ["Array", "Function"]);
167+
CheckList('entry', 'what kind of entry do you want?', ['Array', 'Function']);
168168
```
169169

170170
### Input
@@ -174,9 +174,9 @@ Param: `name<String>, message<String>, [default<String>]`
174174
Creates an Input from Inquirer
175175

176176
```js
177-
const Input = require("@webpack-cli/webpack-scaffold").Input;
177+
const Input = require('@webpack-cli/webpack-scaffold').Input;
178178

179-
Input("entry", "what is your entry point?", "src/index");
179+
Input('entry', 'what is your entry point?', 'src/index');
180180
```
181181

182182
### InputValidate
@@ -186,16 +186,16 @@ Param: `name<String>, message<String>, [validate<Function>, default<String>]`
186186
Creates an Input from Inquirer
187187

188188
```js
189-
const InputValidate = require("@webpack-cli/webpack-scaffold").InputValidate;
189+
const InputValidate = require('@webpack-cli/webpack-scaffold').InputValidate;
190190

191191
const validation = value => {
192-
if (value.length > 4) {
193-
return true;
194-
} else {
195-
return "Your answer must be longer than 4 characters, try again";
196-
}
192+
if (value.length > 4) {
193+
return true;
194+
} else {
195+
return 'Your answer must be longer than 4 characters, try again';
196+
}
197197
};
198-
InputValidate("entry", "what is your entry point?", validation, "src/index");
198+
InputValidate('entry', 'what is your entry point?', validation, 'src/index');
199199
```
200200

201201
### Confirm
@@ -205,9 +205,9 @@ Param: `name<String>, message<String>, [default<Boolean>]`
205205
Creates an Input from Inquirer
206206

207207
```js
208-
const Confirm = require("@webpack-cli/webpack-scaffold").Confirm;
208+
const Confirm = require('@webpack-cli/webpack-scaffold').Confirm;
209209

210-
Confirm("contextConfirm", "Is this your context?");
210+
Confirm('contextConfirm', 'Is this your context?');
211211
```
212212

213213
[downloads]: https://img.shields.io/npm/dm/@webpack-cli/webpack-scaffold.svg

0 commit comments

Comments
 (0)