Skip to content

Commit a82b151

Browse files
omalleyandyclaude
andcommitted
fix(ci): format docs to pass presubmit check-format and check-docs
Run prettier on all markdown docs to match CI expectations. Add .venv/ to .prettierignore to prevent local linting noise. Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 97eeeb4 commit a82b151

6 files changed

Lines changed: 39 additions & 38 deletions

File tree

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
# Prettier-only ignores.
22
CHANGELOG.md
3+
.venv/

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -672,12 +672,12 @@ Please consult [these instructions](./docs/debugging-android.md).
672672
This fork includes detailed skill documentation for AI assistants in
673673
[`skills/chrome-devtools/`](./skills/chrome-devtools/):
674674

675-
| Doc | Description |
676-
|-----|-------------|
677-
| [SKILL.md](./skills/chrome-devtools/SKILL.md) | Main overview -- capabilities, workflow patterns, CLI reference |
678-
| [reference.md](./skills/chrome-devtools/reference.md) | Quick tool reference for all 30 tools by category |
679-
| [network-and-console-breakdown.md](./skills/chrome-devtools/network-and-console-breakdown.md) | Deep dive on collectors, formatters, and data flow |
680-
| [network-for-scraping-discovery.md](./skills/chrome-devtools/network-for-scraping-discovery.md) | Network-first API discovery and scraping guide |
675+
| Doc | Description |
676+
| ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
677+
| [SKILL.md](./skills/chrome-devtools/SKILL.md) | Main overview -- capabilities, workflow patterns, CLI reference |
678+
| [reference.md](./skills/chrome-devtools/reference.md) | Quick tool reference for all 30 tools by category |
679+
| [network-and-console-breakdown.md](./skills/chrome-devtools/network-and-console-breakdown.md) | Deep dive on collectors, formatters, and data flow |
680+
| [network-for-scraping-discovery.md](./skills/chrome-devtools/network-for-scraping-discovery.md) | Network-first API discovery and scraping guide |
681681

682682
## Known limitations
683683

docs/PRODUCTION_READINESS.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,43 +4,43 @@ This document tracks production-worthiness of the **chrome-devtools-mcp** server
44

55
## Chrome DevTools MCP
66

7-
| Check | Status | Notes |
8-
|-------|--------|-------|
9-
| Unit/integration tests | [OK] | `npm run test` - full suite in `tests/` |
10-
| CI (GitHub Actions) | [OK] | `run-tests.yml` - ubuntu, windows, macos x node 20-24 |
11-
| Build/bundle | [OK] | `npm run bundle` produces distributable |
12-
| TypeScript strict | [OK] | `tsc --noEmit` |
13-
| Lint/format | [OK] | ESLint + Prettier via `check-format` |
14-
| Documentation | [OK] | `docs/`, `tool-reference.md`, skill in `skills/chrome-devtools/` |
15-
| Release pipeline | [OK] | release-please, publish-to-npm-on-tag |
7+
| Check | Status | Notes |
8+
| ---------------------- | ------ | ---------------------------------------------------------------- |
9+
| Unit/integration tests | [OK] | `npm run test` - full suite in `tests/` |
10+
| CI (GitHub Actions) | [OK] | `run-tests.yml` - ubuntu, windows, macos x node 20-24 |
11+
| Build/bundle | [OK] | `npm run bundle` produces distributable |
12+
| TypeScript strict | [OK] | `tsc --noEmit` |
13+
| Lint/format | [OK] | ESLint + Prettier via `check-format` |
14+
| Documentation | [OK] | `docs/`, `tool-reference.md`, skill in `skills/chrome-devtools/` |
15+
| Release pipeline | [OK] | release-please, publish-to-npm-on-tag |
1616

1717
**Pre-deploy**: Run `npm run test` and `npm run bundle` from repo root.
1818

1919
---
2020

2121
## Overtime-ag-plugin
2222

23-
| Check | Status | Notes |
24-
|-------|--------|-------|
25-
| Unit tests (116) | [OK] | `uv run pytest tests/` - 13 test files covering all modules + edge cases |
26-
| Replay smoke | [OK] | `run_tests.ps1` - replay-only from `data/cbb_recording.json` |
27-
| E2E (record) | [!!] Manual | Requires headed browser + live site; run setup/record-cbb skill |
28-
| CI | [OK] | `overtime-ag-tests.yml` on push/PR to plugin paths |
29-
| Playwright install | [OK] | `uv run playwright install chromium` |
30-
| .env setup | [OK] | Copy `.env.example` to `.env` for OT_* vars |
23+
| Check | Status | Notes |
24+
| ------------------ | ----------- | ------------------------------------------------------------------------ |
25+
| Unit tests (116) | [OK] | `uv run pytest tests/` - 13 test files covering all modules + edge cases |
26+
| Replay smoke | [OK] | `run_tests.ps1` - replay-only from `data/cbb_recording.json` |
27+
| E2E (record) | [!!] Manual | Requires headed browser + live site; run setup/record-cbb skill |
28+
| CI | [OK] | `overtime-ag-tests.yml` on push/PR to plugin paths |
29+
| Playwright install | [OK] | `uv run playwright install chromium` |
30+
| .env setup | [OK] | Copy `.env.example` to `.env` for OT\_\* vars |
3131

3232
**Pre-deploy**: Run `.\run_tests.ps1` from `project/` or `.\scripts\test-production-readiness.ps1` from repo root.
3333

3434
---
3535

3636
## Skills Coverage
3737

38-
| Skill | Purpose | Tested By |
39-
|-------|---------|-----------|
40-
| **chrome-devtools** | MCP reference for browser automation | Chrome DevTools MCP suite |
41-
| **setup** | Init uv + Playwright, verify advanced-mode | `run_tests.ps1` step 3 |
42-
| **record-cbb** | Record CBB network calls | E2E manual |
43-
| **scrape-cbb** | Replay and export to JSON/CSV/Parquet | `run_tests.ps1` replay smoke |
38+
| Skill | Purpose | Tested By |
39+
| ------------------- | ------------------------------------------ | ---------------------------- |
40+
| **chrome-devtools** | MCP reference for browser automation | Chrome DevTools MCP suite |
41+
| **setup** | Init uv + Playwright, verify advanced-mode | `run_tests.ps1` step 3 |
42+
| **record-cbb** | Record CBB network calls | E2E manual |
43+
| **scrape-cbb** | Replay and export to JSON/CSV/Parquet | `run_tests.ps1` replay smoke |
4444

4545
---
4646

docs/claude-code-docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,4 @@
5656
- [Optimize your terminal setup](https://code.claude.com/docs/en/terminal-config.md): Claude Code works best when your terminal is properly configured. Follow these guidelines to optimize your experience.
5757
- [Enterprise deployment overview](https://code.claude.com/docs/en/third-party-integrations.md): Learn how Claude Code can integrate with various third-party services and infrastructure to meet enterprise deployment requirements.
5858
- [Troubleshooting](https://code.claude.com/docs/en/troubleshooting.md): Discover solutions to common issues with Claude Code installation and usage.
59-
- [Use Claude Code in VS Code](https://code.claude.com/docs/en/vs-code.md): Install and configure the Claude Code extension for VS Code. Get AI coding assistance with inline diffs, @-mentions, plan review, and keyboard shortcuts.
59+
- [Use Claude Code in VS Code](https://code.claude.com/docs/en/vs-code.md): Install and configure the Claude Code extension for VS Code. Get AI coding assistance with inline diffs, @-mentions, plan review, and keyboard shortcuts.

docs/tool-reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -298,12 +298,12 @@ so returned values have to be JSON-serializable.
298298
**Parameters:**
299299

300300
- **function** (string) **(required)**: A JavaScript function declaration to be executed by the tool in the currently selected page.
301-
Example without arguments: `() => {
301+
Example without arguments: `() => {
302302
return document.title
303303
}` or `async () => {
304304
return await fetch("example.com")
305305
}`.
306-
Example with arguments: `(el) => {
306+
Example with arguments: `(el) => {
307307
return el.innerText;
308308
}`
309309

examples/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ python overtime_ag_scraper.py --no-headless
3636

3737
### APIs used
3838

39-
| Purpose | Method | URL / Body |
40-
|----------------|--------|------------|
41-
| Session | Playwright | `GET https://overtime.ag/sports#/` |
42-
| Sports list | POST | `Offering.asmx/GetSports``{"getInactiveSports":false}` |
43-
| Game lines | POST | `Offering.asmx/GetSportOffering``{"sportType":"Basketball","sportSubType":"NBA",...}` |
44-
| Event IDs | GET | `https://bv2-us.digitalsportstech.com/api/schedule?sb=ticosports-asi` |
39+
| Purpose | Method | URL / Body |
40+
| ----------- | ---------- | ---------------------------------------------------------------------------------------- |
41+
| Session | Playwright | `GET https://overtime.ag/sports#/` |
42+
| Sports list | POST | `Offering.asmx/GetSports``{"getInactiveSports":false}` |
43+
| Game lines | POST | `Offering.asmx/GetSportOffering``{"sportType":"Basketball","sportSubType":"NBA",...}` |
44+
| Event IDs | GET | `https://bv2-us.digitalsportstech.com/api/schedule?sb=ticosports-asi` |
4545

4646
Cookie handling (and optional `cf_clearance`) is done via the Playwright session; the same cookies are then used in the `requests` session.

0 commit comments

Comments
 (0)