Skip to content

Commit 9ade2de

Browse files
committed
chore: fix various documentation discrepencies from monorepo move
1 parent 77c49a8 commit 9ade2de

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

.changeset/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"fixed": [],
66
"linked": [],
77
"access": "public",
8-
"baseBranch": "master",
8+
"baseBranch": "main",
99
"updateInternalDependencies": "patch",
1010
"ignore": []
1111
}

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ Method | Parameters | Returns | Description
173173
[**setPartial**](#setpartial) | *String, String* | | setup a handlebars partial
174174
[**setActionType**](#setactiontype) | *String, [CustomAction](#functionsignature-custom-action)* | | register a custom action type
175175
[**setPrompt**](#setprompt) | *String, InquirerPrompt* | | registers a custom prompt type with inquirer
176-
[**load**](https://github.com/plopjs/plop/blob/master/plop-load.md) | *Array[String], Object, Object* | | loads generators, helpers and/or partials from another plopfile or npm module
176+
[**load**](https://github.com/plopjs/plop/blob/main/plop-load.md) | *Array[String], Object, Object* | | loads generators, helpers and/or partials from another plopfile or npm module
177177

178178
## setHelper
179179
`setHelper` directly corresponds to the handlebars method `registerHelper`. So if you are familiar with [handlebars helpers](https://handlebarsjs.com/guide/expressions.html#helpers), then you already know how this works.
@@ -247,7 +247,7 @@ export default function (plop) {
247247
```
248248

249249
## setPrompt
250-
[Inquirer](https://github.com/SBoudrias/Inquirer.js) provides many types of prompts out of the box, but it also allows developers to build prompt plugins. If you'd like to use a prompt plugin, you can register it with `setPrompt`. For more details see the [Inquirer documentation for registering prompts](https://github.com/SBoudrias/Inquirer.js#inquirerregisterpromptname-prompt). Also check out the [plop community driven list of custom prompts](https://github.com/plopjs/plop/blob/master/inquirer-prompts.md).
250+
[Inquirer](https://github.com/SBoudrias/Inquirer.js) provides many types of prompts out of the box, but it also allows developers to build prompt plugins. If you'd like to use a prompt plugin, you can register it with `setPrompt`. For more details see the [Inquirer documentation for registering prompts](https://github.com/SBoudrias/Inquirer.js#inquirerregisterpromptname-prompt). Also check out the [plop community driven list of custom prompts](https://github.com/plopjs/plop/blob/main/inquirer-prompts.md).
251251

252252
``` javascript
253253
import autocompletePrompt from 'inquirer-autocomplete-prompt';
@@ -391,7 +391,7 @@ The `Add` and `Modify` actions will take care of almost every case that plop is
391391
- The function must let plop known what’s happening through the return value. If you return a `Promise`, we won’t start other actions until the promise resolves. If you return a message (*String*), we know that the action is done and we’ll report the message in the status of the action.
392392
- A custom action fails if the promise is rejected, or the function throws an `Exception`
393393

394-
_See the [example plopfile](https://github.com/plopjs/plop/blob/master/tests/examples/javascript/plopfile.js) for a sample synchronous custom action._
394+
_See the [example plopfile](https://github.com/plopjs/plop/blob/main/packages/plop/tests/examples/javascript/plopfile.js) for a sample synchronous custom action._
395395

396396
## Comments
397397
Comment lines can be added to the actions array by adding a string in place of an action config object. Comments are printed to the screen when plop comes to them and have no functionality of their own.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)