Skip to content
6 changes: 3 additions & 3 deletions docs/generator-instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The npm client.

- Type: `() => void`

Run `git init` synchonously in output directory.
Run `git init` synchronously in output directory.

### npmInstall

Expand All @@ -72,7 +72,7 @@ Use `npm` or `yarn` to install packages in output directory.
function npmInstall(opts?: InstallOpts): Promise<void>

interface InstallOpts {
/* The packages to install, if omited, it will install packages in `package.json` */
/* The packages to install, if omitted, it will install packages in `package.json` */
packages?: string[]
/* Install packages as devDependencies, false by default */
saveDev?: boolean
Expand All @@ -83,4 +83,4 @@ interface InstallOpts {

- Type: `() => void`

Display a message for successful project creation.
Display a message for successful project creation.
4 changes: 2 additions & 2 deletions docs/guide/creating-generators.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ module.exports = {
},
{
name: 'description',
message: 'How would you descripe the new project',
message: 'How would you describe the new project',
default: `my ${superb()} project`
},
{
Expand Down Expand Up @@ -89,7 +89,7 @@ module.exports = {
}
```

- `prompts`: CLI prompts to retrive answers from current user.
- `prompts`: CLI prompts to retrieve answers from current user.
- `actions`: A series of actions to manipulate files.
- `completed`: A function that will be invoked when the whole process is finished.

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ sao nm my-project

By running this command, SAO will install a generator which in this case is [sao-nm](https://npm.im/sao-nm) from npm, and use it to generate files into `my-project` directory.

If you want it to generate into current directoy, just omit the second argument like this: `sao nm`.
If you want it to generate into current directory, just omit the second argument like this: `sao nm`.

A generator could be one of:

Expand Down Expand Up @@ -69,4 +69,4 @@ Sub-generators are supposed to be running in an existing project, which means th

### Update Cached Generator

Once you've run a generator, it will be cached locally in `~/.sao` directory. To run the same generator with an up-to-date version, you can add the `--update` or `-u` flag.
Once you've run a generator, it will be cached locally in `~/.sao` directory. To run the same generator with an up-to-date version, you can add the `--update` or `-u` flag.
2 changes: 1 addition & 1 deletion docs/guide/sharing-generators.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

To share your generator with others, you can push your the generator directory to GitHub or to any Git provider that is supported by SAO. It's recommended to create a repository following the `sao-*` naming convention.

However, it's recommeneded to publish your generator on npm too.
However, it's recommended to publish your generator on npm too.

📝 __package.json__:

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/testing-generators.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

You can test your generators with your testing framework of choice, like [AVA](https://ava.li) we are going to use here.

Before writing actual tests, you need to install `sao` and your testing frameworkin the generator as dev dependencies:
Before writing actual tests, you need to install `sao` and your testing framework in the generator as dev dependencies:

```bash
cd my-generator
Expand Down
2 changes: 1 addition & 1 deletion docs/saofile.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ actions: [
```

- __files__: One or more glob patterns.
- __handler__: The function we use to get new file contents. For `.json` we automatically parse and stringify it. Otherwise you will recieve raw string.
- __handler__: The function we use to get new file contents. For `.json` we automatically parse and stringify it. Otherwise you will receive raw string.

### `type: 'move'`

Expand Down