Skip to content

Commit d181efb

Browse files
committed
update readme
1 parent b7981f3 commit d181efb

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -89,12 +89,12 @@ The `generateTemplateFiles` function takes an array of `IConfigItem` items.
8989
#### `IConfigItem`
9090

9191
- `option` - The name of the option to choose when asked.
92-
- `defaultCase` - The default [Case Converters](#case-converters) to use with the [Replacer Slots](#replacer-slots) in the template files. Default is `(noCase)`.
92+
- `defaultCase` - The default [Case Converters](#case-converters) to use with the [Replacer Slots](#replacer-slots-or-ireplacerslotquestion) in the template files. Default is `(noCase)`.
9393
- `entry.folderPath` - Path to a folder of files or a single template file.
9494

95-
- `stringReplacers` - An array of [Replacer Slots](#replacer-slots) used to replace content in the designated `entry.folderPath`.
95+
- `stringReplacers` - An array of [Replacer Slots](#replacer-slots-or-ireplacerslotquestion) used to replace content in the designated `entry.folderPath`.
9696
- `dynamicReplacers` - (Optional) An array of IReplacer used to replace content in the designated `entry.folderPath`.
97-
- `output.path` - The desired output path for generated files. [Case Converters](#case-converters) and [Replacer Slots](#replacer-slots) can be used to make the path somewhat dynamic.
97+
- `output.path` - The desired output path for generated files. [Case Converters](#case-converters) and [Replacer Slots](#replacer-slots-or-ireplacerslotquestion) can be used to make the path somewhat dynamic.
9898
- `output.pathAndFileNameDefaultCase` - The [Case Converters](#case-converters) to use for the file path and file name(s).
9999
- `onComplete` - (Optional) Takes a callback function that is called once the file(s) have been outputted. A [IResults](#iresults) object will be passed to the callback.
100100

@@ -124,13 +124,13 @@ The `generateTemplateFiles` function takes an array of `IConfigItem` items.
124124

125125
#### `IResults`
126126

127-
Below is an example of what you receive from the `onComplete` callback. It has the output path, list of files created and the [Replacer Slots](#replacer-slots) with the value entered.
127+
Below is an example of what you receive from the `onComplete` callback. It has the output path, list of files created and the [Replacer Slots](#replacer-slots-or-ireplacerslotquestion) with the value entered.
128128

129129
- `output.path` - The file(s) output path
130130
- `output.files` - List of files created
131-
- `stringReplacers` - List of [Replacer Slots](#replacer-slots); name and values entered during the setup process
131+
- `stringReplacers` - List of [Replacer Slots](#replacer-slots-or-ireplacerslotquestion); name and values entered during the setup process
132132

133-
###### Example data you would get from the onComplate callback
133+
###### Example data you would get from the onComplete callback
134134

135135
```javascript
136136
{
@@ -161,7 +161,7 @@ Below is an example of what you receive from the `onComplete` callback. It has t
161161

162162
### Replacer Slots or IReplacerSlotQuestion
163163

164-
[Replacer Slots](#replacer-slots) are unique string value(s) to be replaced by the generator. An array of string values and/or `IReplacerSlotQuestion` objects can be used.
164+
[Replacer Slots](#replacer-slots-or-ireplacerslotquestion) are unique string value(s) to be replaced by the generator. An array of string values and/or `IReplacerSlotQuestion` objects can be used.
165165

166166
```javascript
167167
stringReplacers: ['__store__', {question: 'Insert model name', slot: '__model__'}];
@@ -197,7 +197,7 @@ Here is the string `Lives down BY the River` with each of the converters:
197197
(snakeCase) // lives_down_by_the_river
198198
(titleCase) // Lives Down By The River
199199

200-
One Rule: no spaces between the [Replacer Slots](#replacer-slots) and [Case Converters](#case-converters). If there is a space, [Case Converters](#case-converters) will not work.
200+
One Rule: no spaces between the [Replacer Slots](#replacer-slots-or-ireplacerslotquestion) and [Case Converters](#case-converters). If there is a space, [Case Converters](#case-converters) will not work.
201201

202202
- :white_check_mark: `__name__(camelCase)`
203203
- :warning: `__name__ (camelCase)`

0 commit comments

Comments
 (0)