Skip to content

docs: refresh flaglint-go pages — 6 listed gaps are resolved, add --strict-types and baseline counts#21

Merged
Krishan27 merged 1 commit into
mainfrom
docs/go-refresh-resolved-gaps
Jul 8, 2026
Merged

docs: refresh flaglint-go pages — 6 listed gaps are resolved, add --strict-types and baseline counts#21
Krishan27 merged 1 commit into
mainfrom
docs/go-refresh-resolved-gaps

Conversation

@flaglint

@flaglint flaglint commented Jul 8, 2026

Copy link
Copy Markdown
Owner

Summary

Every identity-resolution gap listed as "not resolved yet" on the flaglint-go docs pages has actually been closed — verified directly against the flaglint-go issue tracker:

Listed as unresolved Issue Actual status
Chained factory-call-then-method #20 Closed
Method values #6 Closed
Interface satisfaction #15 Closed (via --strict-types)
Block-scoped shadowing #5 Closed
Factory returning a wrapper type #16 Closed (via --strict-types)
Nested go.mod files #17 Closed

These pages were dated right before that work landed, so the site was significantly understating what flaglint-go can currently do.

Changes

  • limitations.md / supported-scope.md: mark all six as resolved (distinguishing Phase 1 default vs. opt-in --strict-types), add two newer Phase-1 mechanisms these pages never mentioned at all (a struct field declared *ld.LDClient with no observed construction anywhere, and a composite literal directly initializing a package-level var), and state plainly that zero identity-resolution gaps are currently tracked.
  • identity-model.md: adds worked examples for both newer Phase-1 mechanisms, plus an entirely new "Phase 2 — --strict-types" section (interface satisfaction, transitive factory wrapping, cross-function method-value forwarding) that didn't exist on this page before.
  • index.md: same correction to the "what flaglint-go does/doesn't do" summary — it previously named method values and interface satisfaction as open gaps.
  • cli/{scan,audit,validate}.md: --strict-types wasn't documented as a flag anywhere on the site despite being available on all three commands since it shipped — added to each page's options table. audit.md's baseline JSON example was also missing the schemaVersion/counts fields flaglint-go now emits; validate.md's Baseline Mode section gains a note on what counts actually catches (a brand-new duplicate of an already-baselined call, not just a brand-new fingerprint).

Verification

npm run build completes cleanly (90 pages built), spot-checked the rendered Limitations page's actual output.

Summary by CodeRabbit

  • Documentation
    • Updated Go CLI and reference docs with the new --strict-types option.
    • Clarified that default scanning is syntax-based, while strict mode adds type-aware identity resolution and requires the module to build.
    • Refreshed baseline examples to show occurrence counts and the newer baseline schema.
    • Revised identity-resolution coverage and limitations to reflect the current behavior and recently closed gaps.
    • Updated page timestamps across the Go docs.

@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@flaglint, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 56 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 3f700874-3634-4cc5-aa8d-6d012a163418

📥 Commits

Reviewing files that changed from the base of the PR and between bd2b38b and a440782.

📒 Files selected for processing (7)
  • src/content/docs/docs/go/cli/audit.md
  • src/content/docs/docs/go/cli/scan.md
  • src/content/docs/docs/go/cli/validate.md
  • src/content/docs/docs/go/concepts/identity-model.md
  • src/content/docs/docs/go/index.md
  • src/content/docs/docs/go/reference/limitations.md
  • src/content/docs/docs/go/reference/supported-scope.md
📝 Walkthrough

Walkthrough

Documentation-only update to flaglint-go docs introducing a new opt-in --strict-types CLI option across audit, scan, and validate commands, updated baseline JSON schema with occurrence counts, and a two-phase (syntax-only vs. type-checked) identity resolution model reflected in the identity-model, index, limitations, and supported-scope pages.

Changes

Go docs updates

Layer / File(s) Summary
CLI docs: --strict-types option and baseline schema updates
src/content/docs/docs/go/cli/audit.md, src/content/docs/docs/go/cli/scan.md, src/content/docs/docs/go/cli/validate.md
Adds --strict-types option documentation to the three CLI command pages, updates the audit baseline JSON example with schemaVersion and counts, and expands validate's Baseline Mode section with occurrence-count tracking and a duplicate-detection example.
Identity Model concept doc: Phase 1/Phase 2 patterns
src/content/docs/docs/go/concepts/identity-model.md
Documents new Phase 1 syntax-based binding patterns and expands Phase 2 (--strict-types) with interface satisfaction, wrapper-type factories, and method-value forwarding cases; rewords the out-of-scope section.
Landing page summary updates
src/content/docs/docs/go/index.md
Describes the opt-in --strict-types pass and revises the does/does-not-do bullets to state there are no open identity-resolution gaps.
Limitations and supported-scope reference updates
src/content/docs/docs/go/reference/limitations.md, src/content/docs/docs/go/reference/supported-scope.md
Replaces prior unresolved-gap lists with a two-phase pattern framework, a "recently closed" gaps list, and updated coverage tables split into Phase 1 and Phase 2 sections.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the doc refresh, resolved identity gaps, new --strict-types coverage, and baseline count updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/go-refresh-resolved-gaps

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 8, 2026

Copy link
Copy Markdown

Deploying flaglint with  Cloudflare Pages  Cloudflare Pages

Latest commit: a440782
Status:⚡️  Build in progress...

View logs

…trict-types and baseline counts

Every identity-resolution gap listed as "not resolved yet" on the
flaglint-go Limitations and Supported Scope pages has actually been
closed (verified directly against the flaglint-go issue tracker):
chained factory-call-then-method (#20), method values (#6), interface
satisfaction (#15), block-scoped shadowing (#5), factory returning a
wrapper type (#16), and nested go.mod files (#17). These pages were last
updated right before that work landed.

- limitations.md / supported-scope.md: mark all six as resolved (noting
  which layer resolves each — Phase 1 default vs. opt-in --strict-types),
  add two newer Phase-1 mechanisms these pages never mentioned at all
  (a struct field declared *ld.LDClient with no observed construction,
  and a composite literal directly initializing a package-level var),
  and state plainly that zero identity-resolution gaps are currently
  tracked.
- identity-model.md: add worked examples for both newer Phase-1
  mechanisms above, plus a new "Phase 2 — --strict-types" section
  (interface satisfaction, transitive factory wrapping, cross-function
  method-value forwarding) that didn't exist on this page at all before.
- index.md: same corrections to the "what flaglint-go does/doesn't do"
  summary — it previously named method values and interface satisfaction
  as open gaps.
- cli/{scan,audit,validate}.md: --strict-types wasn't documented as a
  flag anywhere on the site despite being available on all three
  commands since it shipped; added to each page's options table.
  audit.md's baseline JSON example was also missing the "schemaVersion"
  and "counts" fields flaglint-go now emits; validate.md's Baseline Mode
  section gains a note on what "counts" actually catches (a brand-new
  duplicate of an already-baselined call, not just a brand-new
  fingerprint).

Verified: `npm run build` completes cleanly (90 pages), spot-checked the
rendered Limitations page's output directly.

Signed-off-by: Krishan Kant Sharma <krishansharma0327@gmail.com>
@flaglint flaglint force-pushed the docs/go-refresh-resolved-gaps branch from bd2b38b to a440782 Compare July 8, 2026 13:56
@Krishan27 Krishan27 merged commit 9303929 into main Jul 8, 2026
2 of 4 checks passed
@Krishan27 Krishan27 deleted the docs/go-refresh-resolved-gaps branch July 8, 2026 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants