Skip to content

Commit 58b00c4

Browse files
Merge pull request #396 from AndreaPontrandolfo/AndreaPontrandolfo/issue384
AndreaPontrandolfo/issue384
2 parents f0a7553 + bf3644f commit 58b00c4

File tree

31 files changed

+2135
-2094
lines changed

31 files changed

+2135
-2094
lines changed

.changeset/lovely-donkeys-rule.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
'eslint-config-sheriff': minor
3+
'@sherifforg/create-config': minor
4+
'@sherifforg/cli': minor
5+
---
6+
7+
feat: bumped some deps

.github/workflows/merge-checks.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,6 @@ jobs:
3333
- name: Install dependencies
3434
run: pnpm install
3535
- name: Launch Turborepo Remote Caching
36-
uses: rharkor/caching-for-turbo@v1.5
36+
uses: rharkor/caching-for-turbo@v1.8
3737
- name: Run qa checks
3838
run: pnpm merge-checks

apps/config-validation-playground/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"@types/node": "^22.10.3",
2323
"@types/react": "^18.3.18",
2424
"@types/react-dom": "^18.3.5",
25-
"eslint": "^9.19.0",
25+
"eslint": "^9.25.1",
2626
"eslint-config-sheriff": "workspace:*",
2727
"tsconfig": "workspace:*",
2828
"typescript": "^5.8.3"
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "🤖 CLI usage",
3+
"position": 14,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "In this section you will learn about everything you can do with the Sheriff CLI."
7+
}
8+
}

apps/docs-website/docs/cli-reference.mdx renamed to apps/docs-website/docs/cli-usage/commands-reference.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
sidebar_position: 10
2+
sidebar_position: 2
3+
description: "🗺️ All the CLI commands."
34
---
45

56
import { CLIOptionsCatalog } from "@sherifforg/constants";
67

7-
# 🗺️ CLI reference
8+
# Commands reference
89

910
## @sherifforg/create-config
1011

apps/docs-website/docs/usage-in-ci.md renamed to apps/docs-website/docs/cli-usage/get-started.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
2-
sidebar_position: 15
2+
sidebar_position: 1
3+
description: 'How to use the Sheriff CLI.'
34
---
45

5-
# 🤖 Usage in CI
6+
# Get started
67

78
## Intro
89

@@ -13,9 +14,9 @@ The Sheriff CLI is composed of 2 packages:
1314

1415
The `@sherifforg/cli` is invoked in the CLI with the `sheriff` command.
1516

16-
It is advised to integrate the `@sherifforg/cli` in your CI pipelines to ensure that the Sheriff configuration is always correct and up-to-date, but you can also integrate it into pre-commit hooks if that's your preference.
17+
It is advised to integrate the `@sherifforg/cli` in your **CI pipelines** to ensure that the Sheriff configuration is always correct and up-to-date, but you can also integrate it into pre-commit hooks if that's your preference.
1718

18-
## Usage
19+
## How to run it
1920

2021
To get started, install it in your project:
2122

@@ -82,7 +83,7 @@ Sheriff will scan the config file trying to find a variable named **exactly** `s
8283

8384
## Options
8485

85-
The `@sherifforg/cli` is very flexible and offers a variety of options to customize it's behavior. Look at the [API reference](./cli-reference#sherifforgcli) for detailed info on the available options.
86+
The `@sherifforg/cli` is very flexible and offers a variety of options to customize it's behavior. Look at the [API reference](./commands-reference#sherifforgcli) for detailed info on the available options.
8687

8788
You can:
8889

apps/docs-website/docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 19
2+
sidebar_position: 18
33
---
44

55
# 📚 FAQ

apps/docs-website/docs/migration-guide.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 17
2+
sidebar_position: 16
33
---
44

55
import Tabs from "@theme/Tabs";

apps/docs-website/docs/monorepo-support.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 13
2+
sidebar_position: 12
33
---
44

55
import Tabs from "@theme/Tabs";

apps/docs-website/docs/performance-considerations.mdx renamed to apps/docs-website/docs/performance-tips.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 16
2+
sidebar_position: 15
33
---
44

55
import Tabs from "@theme/Tabs";

0 commit comments

Comments
 (0)