Skip to content

Commit

Permalink
docs: Clarify Root Tasks. (#9098)
Browse files Browse the repository at this point in the history
### Description

@nickfujita in #8972 pointed
out that the docs were confusing about how to use a Root Task, so making
sure to clarify that here.

### Testing Instructions

👀
  • Loading branch information
anthonyshew authored Sep 2, 2024
1 parent b96d8ad commit 0d0425e
Showing 1 changed file with 3 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -280,14 +280,16 @@ You can also run scripts in the `package.json` in the Workspace root using `turb
```json title="./package.json"
{
"scripts": {
"lint": "turbo run lint",
"lint": "turbo run lint lint:root",
"lint:root": "eslint ." // [!code highlight]
}
}
```
</Tab>
</Tabs>

With the Root Task now registered, `turbo run lint:root` will now run the task. You can also run `turbo run lint lint:root` to run all your linting tasks.

#### When to use Root Tasks

- **Linting and formatting of the Workspace root**: You might have code in your Workspace root that you want to lint and format. For example, you might want to run ESLint or Prettier in your root directory.
Expand Down

0 comments on commit 0d0425e

Please sign in to comment.