vscode: migrate settings.json writer to full hujson AST manipulation
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 58/100
Línea de trabajo
Comienza con cmd/modern/root/open/jsonc.go y cmd/modern/root/open/vscode.go para rastrear el análisis actual de hujson, la construcción de perfiles y las rutas de actualización. Amplía cmd/modern/root/open/jsonc_test.go, incluido TestApplyJSONCSettingsUpdates_PreservesComments, para los comentarios adyacentes a add y por conexión. Se considera terminado cuando las actualizaciones directas del AST de hujson conservan los comentarios, el orden y los campos no relacionados para los perfiles nuevos y existentes.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Background
PR #688 added sqlcmd open vscode, which writes the user's settings.json to register a connection profile. The original implementation stripped JSONC comments and trailing commas, marshaled fresh JSON, and saved the user's original to a .sqlcmd-backup file. dlevy flagged that this clobbers the backup on every subsequent run (e.g. creating a second container loses the first backup) and silently destroys hand-authored comments.
PR #688 follow-up commit replaced the strip-and-marshal round trip with github.com/tailscale/hujson. We now parse the original AST and apply an RFC 6902 patch that touches only the two keys we own (mssql.connections, mssql.connectionGroups). Comments, trailing commas, and unrelated user keys round-trip untouched on replace operations, and the .sqlcmd-backup file is no longer needed.
Remaining limitation
hujson's Patch "add" operation (used when the document doesn't yet have an mssql.connections key) can blank a comment immediately adjacent to the insertion point. Unrelated keys are preserved; only a comment line at the insertion site is affected. This is a one-time event per settings.json (subsequent runs use the "replace" path, which fully preserves comments).
Additionally, createProfile / updateOrAddProfile in cmd/modern/root/open/vscode.go operate on map[string]interface{} for the connection array itself. This means per-connection comments inside mssql.connections[*] are not preserved when sqlcmd updates an existing profile.
Proposed work
Refactor cmd/modern/root/open/jsonc.go and the profile-construction helpers to operate directly on hujson.Value AST nodes instead of decoded maps. Specifically:
- Walk the parsed root
*hujson.Objectto findmssql.connectionsandmssql.connectionGroupsmembers, mutating theirValuein place rather than going through a JSON patch. - For the array of profiles, locate the existing profile member by
idand rewrite its*hujson.Objectfields one at a time, leaving member ordering and surrounding extras intact. - When inserting a new profile or a new top-level key, set
ObjectMember.Name.BeforeExtraexplicitly so the preceding comment isn't absorbed by hujson's leading-comment extraction.
Verification
The round-trip test in cmd/modern/root/open/jsonc_test.go (TestApplyJSONCSettingsUpdates_PreservesComments) should be extended to cover the add-comment-adjacent case, and a new test should verify per-connection comments inside the mssql.connections array survive an update to an existing profile.
References
- PR: #688
- Related review thread: https://github.com/microsoft/go-sqlcmd/pull/688#discussion_r3325235606
- hujson patch semantics: https://github.com/tailscale/hujson/blob/main/patch.go
- Lenguaje dominante
- Go
- Estrellas
- 595
- Forks
- 91
- Merge medio
- 9 h 35 min
- PR fusionados (30 d)
- 1
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de microsoft/go-sqlcmd
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
Fix CVEs in Version v1.10.0 Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
-
":Help" command not working Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 65/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 76/100
Todos los issues de microsoft/go-sqlcmd
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 60/100
github/gh-aw-mcpg#13748 ·
-
agentic-workflows
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
needs-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
googleapis/librarian#7670 · 2 comentarios ·