Skip to content

Commit e75a25a

Browse files
claudiacodacyclaude
andcommitted
fix: resolve vale and mkdocs CI failures
- Replace spaced em dashes with parentheses/periods (Microsoft.Dashes) - Add unignore to vale vocabulary accept list - Fix PR's possessive to pull request - Wrap GitHub Actions YAML example in raw tags to prevent Jinja2 parsing Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent aea4e6f commit e75a25a

2 files changed

Lines changed: 12 additions & 9 deletions

File tree

.github/styles/config/vocabularies/Codacy/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ TSLint
9393
TSQLLint
9494
unassigns
9595
unfollow
96+
unignore
9697
vacuumdb
9798
Visualforce
9899
VSCode

docs/codacy-cloud-cli/index.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Install and use the Codacy Cloud CLI to manage your repositories, i
44

55
# Codacy Cloud CLI
66

7-
The Codacy Cloud CLI gives you a fast terminal interface to your Codacy data. Add repositories, review issues, investigate security findings, inspect pull requests, and configure toolsall without opening a browser.
7+
The Codacy Cloud CLI gives you a fast terminal interface to your Codacy data. Add repositories, review issues, investigate security findings, inspect pull requests, and configure toolsall without opening a browser.
88

99
Pair it with the [Codacy Claude Code skill](#install-the-claude-code-skill) to interact with your Codacy data in plain language directly from your AI assistant.
1010

@@ -18,7 +18,7 @@ Install the CLI using npm:
1818
npm install -g @codacy/codacy-cloud-cli
1919
```
2020

21-
Alternatively, you can build from source — see the [GitHub repository](https://github.com/codacy/codacy-cloud-cli) for instructions.
21+
Alternatively, you can build from source. See the [GitHub repository](https://github.com/codacy/codacy-cloud-cli) for instructions.
2222

2323
## Authentication {: id="authentication"}
2424

@@ -28,7 +28,7 @@ Run `codacy login` and enter your API token when prompted. Codacy stores your cr
2828
codacy login
2929
```
3030

31-
To authenticate without a prompt for example in a CI/CD pipeline pass your token directly:
31+
To authenticate without a prompt (for example, in a CI/CD pipeline), pass your token directly:
3232

3333
```bash
3434
codacy login --token <your-api-token>
@@ -43,7 +43,7 @@ To remove your stored credentials, run `codacy logout`.
4343
## Install the Claude Code skill {: id="install-the-claude-code-skill"}
4444

4545
!!! tip
46-
This step is optional but highly recommended. The Codacy skill for Claude Code lets you ask questions about your Codacy data in plain language without needing to remember command syntax.
46+
This step is optional but highly recommended. The Codacy skill for Claude Code lets you ask questions about your Codacy data in plain language, without needing to remember command syntax.
4747

4848
Install the Codacy skills package in Claude Code:
4949

@@ -77,13 +77,13 @@ List the repositories in an organization and see their analysis status:
7777
codacy repositories gh my-org
7878
```
7979

80-
Get a full overview of a specific repository analysis status, quality metrics, and recent activity:
80+
Get a full overview of a specific repository (analysis status, quality metrics, and recent activity):
8181

8282
```bash
8383
codacy repository gh my-org my-repo
8484
```
8585

86-
You can also add or remove repositories, follow/unfollow them, link coding standards, and request reanalysis — all from the same command using flags like `--add`, `--remove`, and `--reanalyze`.
86+
You can also add or remove repositories, follow/unfollow them, link coding standards, and request reanalysis. Use flags like `--add`, `--remove`, and `--reanalyze` on the same command.
8787

8888
### Review code issues
8989

@@ -107,7 +107,7 @@ Ignore all issues matching your current filters in one step:
107107
codacy issues gh my-org my-repo --severities Critical --ignore --ignore-reason FalsePositive
108108
```
109109

110-
Inspect a single issue and ignore or unignore it:
110+
Inspect a single issue and ignore or remove the ignore flag:
111111

112112
```bash
113113
codacy issue gh my-org my-repo <issueId> --ignore --ignore-reason AcceptedUse
@@ -151,7 +151,7 @@ Ignore all potential false positives in a PR at once:
151151
codacy pull-request gh my-org my-repo 42 --ignore-all-false-positives
152152
```
153153

154-
Request reanalysis of the PR's HEAD commit:
154+
Request reanalysis of the pull request HEAD commit:
155155

156156
```bash
157157
codacy pull-request gh my-org my-repo 42 --reanalyze
@@ -198,7 +198,7 @@ codacy pattern gh my-org my-repo eslint max-len --enable --parameter max=120
198198

199199
### Terminal-first PR review
200200

201-
Before merging, check the full analysis of a pull request issues, coverage delta, and security findings without leaving the terminal:
201+
Before merging, check the full analysis of a pull request (issues, coverage delta, and security findings) without leaving the terminal:
202202

203203
```bash
204204
# See the PR summary
@@ -241,6 +241,7 @@ gh issue comment 123 --body "Monthly quality report: $REPORT"
241241

242242
Use the CLI in a GitHub Actions workflow to automatically review and flag issues on a schedule:
243243

244+
{% raw %}
244245
```yaml
245246
name: Monthly Codacy Issue Triage
246247
on:
@@ -263,6 +264,7 @@ jobs:
263264
--output json > issues.json
264265
echo "Open critical/high issues: $(cat issues.json | jq length)"
265266
```
267+
{% endraw %}
266268
267269
## See also
268270

0 commit comments

Comments
 (0)