From 79794b3d15fb351d583e1b3122b36fb89e52f889 Mon Sep 17 00:00:00 2001 From: Krishan Kant Sharma Date: Mon, 6 Jul 2026 14:19:49 -0500 Subject: [PATCH] docs: fix stale claims that Go is unsupported/roadmap-only MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit flaglint-go shipped (v0.1.0/v0.1.1) as a separate, real CLI months after these pages were written — they still said Go SDK usage was entirely unsupported/roadmap-only via a tree-sitter-go plan that was never built. - supported-scope.md: split the "Go, Java, Python..." row; Go now points to flaglint-go's own supported-scope page instead of being lumped in with genuinely-unsupported languages. - safety-model.md: clarified this page is specifically about flaglint-js's migrate --apply (which flaglint-go doesn't have), not a blanket "Go is unsupported by FlagLint" statement. - changelog.md: updated the ADR 006 (Go language support, PROPOSED) entry to note it was superseded — Go support shipped as flaglint-go, built on native go/parser instead of the originally-proposed tree-sitter-go. Links to the new /docs/go/ section (landing in a follow-up PR) — the actual Go docs content doesn't exist yet, so those links 404 until that PR merges. Signed-off-by: Krishan Kant Sharma --- src/content/docs/docs/concepts/safety-model.md | 7 +++++-- src/content/docs/docs/reference/changelog.md | 8 ++++++-- src/content/docs/docs/reference/supported-scope.md | 7 +++++-- 3 files changed, 16 insertions(+), 6 deletions(-) diff --git a/src/content/docs/docs/concepts/safety-model.md b/src/content/docs/docs/concepts/safety-model.md index 2602cb1..2f21c69 100644 --- a/src/content/docs/docs/concepts/safety-model.md +++ b/src/content/docs/docs/concepts/safety-model.md @@ -1,9 +1,11 @@ --- title: Safety Model description: What FlagLint auto-rewrites, what it skips, and why the safety-over-coverage principle guides every pattern. -lastUpdated: 2026-06-22 +lastUpdated: 2026-07-06 --- +This page covers **flaglint-js**'s `migrate --apply` rewrite safety model, which is specific to the JavaScript/TypeScript CLI — flaglint-go does not have an automated migration/rewrite command (audit, scan, and validate only). See [flaglint-go's concepts docs](/docs/go/concepts/identity-model/) for the Go CLI's own safety guarantees. + FlagLint is conservative by design. It separates inventory, review, and source edits so teams can inspect every migration change before it lands in production. ## Safety Model Diagram @@ -45,7 +47,8 @@ When every condition is met, FlagLint produces an idempotent, argument-order-cor | **Wrappers not configured in `.flaglintrc`** | FlagLint cannot distinguish a custom wrapper from an unrelated function unless it is explicitly declared | Add wrapper declarations to `wrappers: []` in `.flaglintrc`, then re-run | | **Ambiguous fallback types** — e.g. `null`, a variable, or a union-typed expression | FlagLint cannot determine which `get*Value` method to use without a concrete literal type | Replace the fallback with an explicit literal (`false`, `""`, `0`, `{}`) at the call site | | **Non-LaunchDarkly providers** | FlagLint is a LaunchDarkly-specific static analysis tool | No action; these calls are reported in the inventory but never touched | -| **Non-Node.js SDKs** — browser SDK, Go SDK, Java SDK | Only the Node.js server-side SDK import provenance is verified | Migrate browser and other-language calls manually | +| **Non-Node.js SDKs** — browser SDK, Java SDK | Only the Node.js server-side SDK import provenance is verified | Migrate browser and other-language calls manually | +| **Go SDK** | flaglint-js only verifies the Node.js server-side SDK import — Go usage is out of scope for this tool entirely | Use [flaglint-go](/docs/go/) to audit Go usage; it has no `--apply`-style rewrite yet, only `scan`/`audit`/`validate` | ## Why Fallback Value Does Not Equal Production Value diff --git a/src/content/docs/docs/reference/changelog.md b/src/content/docs/docs/reference/changelog.md index 180bbe3..fa1b1da 100644 --- a/src/content/docs/docs/reference/changelog.md +++ b/src/content/docs/docs/reference/changelog.md @@ -75,8 +75,12 @@ v1.0.0 is the CI-readiness release. The core scanner and migrator are stable. Th - **ADR 005 — Cleanup command** (DEFERRED) — documents the safe path for automated branch removal via `--assume`/`--flag-values`; deferred until `--assume` mechanism is designed. -- **ADR 006 — Go language support** (PROPOSED) — tree-sitter-go parser design, - import tracing for `go-server-sdk`, go.mod boundary handling, 6-phase plan. +- **ADR 006 — Go language support** (PROPOSED, later superseded) — + tree-sitter-go parser design, import tracing for `go-server-sdk`, go.mod + boundary handling, 6-phase plan. Go support ultimately shipped as a + separate project, [flaglint-go](https://github.com/flaglint/flaglint-go), + built around Go's native `go/parser`/`go/ast` instead of tree-sitter — see + [flaglint-go's docs](/docs/go/). ### Fixed diff --git a/src/content/docs/docs/reference/supported-scope.md b/src/content/docs/docs/reference/supported-scope.md index f905014..f9b0f1b 100644 --- a/src/content/docs/docs/reference/supported-scope.md +++ b/src/content/docs/docs/reference/supported-scope.md @@ -1,9 +1,11 @@ --- title: Supported Scope description: What FlagLint detects, migrates, reports for manual review, and excludes. -lastUpdated: 2026-07-01 +lastUpdated: 2026-07-06 --- +This page covers **flaglint-js**, the JavaScript/TypeScript CLI. For the Go CLI's supported scope, see [flaglint-go: Supported Scope](/docs/go/reference/supported-scope/). + FlagLint currently supports LaunchDarkly Node.js server-side SDK evaluation calls in JavaScript and TypeScript from: - `@launchdarkly/node-server-sdk` @@ -30,7 +32,8 @@ React SDK hooks, HOC, and provider are detected and reported for manual review. | React SDK hooks (`useFlags`, `useLDClient`, `useVariation`) | Yes | No | Yes | No | | React SDK HOC (`withLDConsumer`) | Yes | No | Yes | No | | React SDK provider (`LDProvider`, `asyncWithLDProvider`) | Yes | No | Yes | No | -| Go, Java, Python, or other SDKs | No | No | No | Yes | +| Go SDK | Handled by the separate [flaglint-go](/docs/go/) CLI | — | — | — | +| Java, Python, or other SDKs | No | No | No | Yes | | Non-LaunchDarkly providers | No | No | No | Yes | ## Supported Import Provenance