Commit 0ac1a90
docs: comprehensive godoc documentation update across all packages (#186)
* docs: update documentation to reflect v1.6.0 features as available
This commit updates all documentation to reflect that v1.6.0 features
are now available (not planned):
Migration Guides:
- FROM_SQLFLUFF.md: Updated linting rules (10 rules L001-L010), auto-fix,
VSCode extension, and .gosqlx.yml config as available in v1.6.0
- FROM_PG_QUERY.md: Updated JSON/JSONB operators as supported in v1.6.0
Documentation Updates:
- Updated version references from v1.5.x to v1.6.0 across all docs
- Added v1.6.0 upgrade section to UPGRADE_GUIDE.md
- Updated COMPARISON.md with v1.6.0 features and performance data
- Updated CLAUDE.md production status to v1.6.0+
- Updated performance_baselines.json to v1.6.0
Key v1.6.0 Features Now Documented:
- PostgreSQL Extensions (LATERAL JOIN, JSON/JSONB operators, DISTINCT ON)
- Language Server Protocol (LSP) server
- VSCode Extension
- 10 Linting Rules (L001-L010) with auto-fix
- .gosqlx.yml configuration file support
- go-task Taskfile.yml
- Structured error codes (E1001-E3004)
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* docs: comprehensive v1.6.0 feature documentation update
Based on parallel agent review of all documentation, this commit updates:
Migration Guides:
- FROM_SQLFLUFF.md: Fixed "Coming in v1.5.0" → "Available in v1.6.0" for linting
- FROM_SQLFLUFF.md: Updated FAQ to reflect 10 linting rules now available
- FROM_PG_QUERY.md: Fixed "planned for v1.5.0" → "planned for future release"
SQL Compatibility (SQL_COMPATIBILITY.md):
- LATERAL JOIN: Updated from "10% Syntax" to "95% Full support"
- JSON/JSONB: Updated from "30% Syntax" to "95% Full support" with all operators
- Added DISTINCT ON: 95% Full support
- Added FILTER clause: 95% Full support
- Added RETURNING clause: 95% Full support
Comparison Guide (COMPARISON.md):
- Updated linting from "❌ Planned" to "✅ 10 rules (L001-L010)"
- Updated limitations section to reflect 10 rules available
Documentation Index (docs/README.md):
- Updated all document versions from v1.5.1 to v1.6.0
- Updated dates from 2025-11 to 2025-12
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* docs: add dedicated LSP, linting, and configuration guides with PostgreSQL examples
New Documentation:
- docs/LSP_GUIDE.md: Complete Language Server Protocol guide covering
IDE integration, features, error codes, and troubleshooting
- docs/LINTING_RULES.md: Full reference for all 10 linting rules (L001-L010)
with examples, severity levels, and auto-fix capabilities
- docs/CONFIGURATION.md: Comprehensive configuration guide for .gosqlx.yml
with schema documentation, defaults, and best practices
New PostgreSQL Feature Examples:
- examples/postgresql/lateral-join/: LATERAL JOIN parsing demonstrations
- examples/postgresql/jsonb-operators/: JSON/JSONB operator support
(->/->>/#>/#>>/@>/<@/?/?|/?&/#-)
- examples/postgresql/filter-clause/: FILTER clause for conditional aggregation
- examples/postgresql/returning-clause/: RETURNING clause for DML statements
Updated:
- examples/README.md: Added new examples to documentation
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* docs: comprehensive godoc documentation update across all packages
This commit adds professional-quality Go documentation to all packages,
following Go best practices with detailed package-level doc.go files.
## New Package Documentation Files (24 doc.go files)
### SQL Core Packages
- pkg/sql/doc.go - SQL processing pipeline overview
- pkg/sql/parser/doc.go - Recursive descent parser (~300 lines)
- pkg/sql/tokenizer/doc.go - Zero-copy tokenizer documentation
- pkg/sql/ast/doc.go - AST nodes and visitor pattern
- pkg/sql/keywords/doc.go - Multi-dialect keyword handling
- pkg/sql/token/doc.go - Parser token types
- pkg/sql/monitor/doc.go - Lightweight monitoring
### Supporting Packages
- pkg/metrics/doc.go - Production monitoring (~440 lines)
- pkg/errors/doc.go - Structured error handling
- pkg/models/doc.go - Core data structures
- pkg/config/doc.go - Configuration management
- pkg/compatibility/doc.go - Backward compatibility testing
- pkg/gosqlx/doc.go - High-level API
- pkg/gosqlx/testing/doc.go - Test helper utilities
### Linter Packages
- pkg/linter/doc.go - SQL linting engine
- pkg/linter/rules/keywords/doc.go - Keyword rules
- pkg/linter/rules/style/doc.go - Style rules
- pkg/linter/rules/whitespace/doc.go - Whitespace rules
### CLI Packages
- cmd/gosqlx/doc.go - CLI tool entry point
- cmd/gosqlx/cmd/doc.go - Command implementations
- cmd/gosqlx/internal/config/doc.go - CLI configuration
- cmd/gosqlx/internal/output/doc.go - Output formatters
- cmd/gosqlx/internal/validate/doc.go - Validation logic
### LSP Package
- pkg/lsp/doc.go - LSP server (~600 lines)
## Enhanced Source File Documentation
Updated 48 source files with comprehensive godoc comments including:
- All exported types, functions, and methods
- Thread-safety notes and concurrency patterns
- Memory management and pool usage guidelines
- Performance characteristics and benchmarks
- Usage examples with best practices
- Error handling patterns
## Documentation Standards Applied
- Package overview sections with feature summaries
- Architecture and design documentation
- Quick start examples with working code
- Thread-safety and memory management notes
- Performance characteristics and benchmarks
- Related packages and further reading sections
- v1.6.0 feature coverage (LATERAL JOIN, JSON operators, etc.)
## Quality Verification
- All tests pass with race detection (go test -race ./...)
- No lint issues (golangci-lint run)
- Code properly formatted (go fmt ./...)
- No vet issues (go vet ./...)
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* docs: update roadmap to reflect v1.6.0 progress
Updated the README.md roadmap section to accurately reflect project progress:
## Completed Phases
- Phase 1 (v1.1.0): JOIN Support ✅
- Phase 2 (v1.2.0): CTEs & Set Operations ✅
- Phase 2.5 (v1.3.0-v1.4.0): Window Functions, MERGE, Grouping Sets ✅
- Phase 3 (v1.5.0-v1.6.0): PostgreSQL Extensions, LSP, Linter ✅
## Updated Future Phases
- Phase 4 (v1.7.0): MySQL & SQL Server Dialects 🚧
- Phase 5 (v2.0.0): Query Intelligence & Optimization 📋
- Phase 6 (v2.1.0): Schema Awareness & Validation 📋
- Future Considerations: Stored Procedures, Triggers, PL/pgSQL, WASM 🔮
Added summary table at top for quick status overview and detailed
feature lists for each completed phase showing actual accomplishments.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
---------
Co-authored-by: Ajit Pratap Singh <ajitpratapsingh@Ajits-Mac-mini.local>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>1 parent d4d5746 commit 0ac1a90
File tree
97 files changed
+25070
-1567
lines changed- cmd/gosqlx
- cmd
- internal
- config
- output
- validate
- docs
- examples/tutorials
- 01-sql-validator
- 02-sql-formatter
- pkg
- compatibility
- config
- errors
- gosqlx
- testing
- linter
- rules
- keywords
- style
- whitespace
- lsp
- metrics
- models
- sql
- ast
- keywords
- monitor
- parser
- security
- tokenizer
- token
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
97 files changed
+25070
-1567
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
9 | 12 | | |
10 | 13 | | |
11 | 14 | | |
| |||
27 | 30 | | |
28 | 31 | | |
29 | 32 | | |
| 33 | + | |
30 | 34 | | |
31 | 35 | | |
32 | 36 | | |
| |||
42 | 46 | | |
43 | 47 | | |
44 | 48 | | |
45 | | - | |
| 49 | + | |
46 | 50 | | |
47 | 51 | | |
48 | 52 | | |
| |||
129 | 133 | | |
130 | 134 | | |
131 | 135 | | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
132 | 144 | | |
133 | 145 | | |
134 | 146 | | |
| |||
181 | 193 | | |
182 | 194 | | |
183 | 195 | | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
184 | 204 | | |
185 | 205 | | |
186 | 206 | | |
| |||
294 | 314 | | |
295 | 315 | | |
296 | 316 | | |
| 317 | + | |
| 318 | + | |
| 319 | + | |
| 320 | + | |
| 321 | + | |
| 322 | + | |
297 | 323 | | |
298 | 324 | | |
299 | 325 | | |
| |||
602 | 628 | | |
603 | 629 | | |
604 | 630 | | |
| 631 | + | |
| 632 | + | |
| 633 | + | |
| 634 | + | |
| 635 | + | |
| 636 | + | |
| 637 | + | |
| 638 | + | |
| 639 | + | |
| 640 | + | |
| 641 | + | |
| 642 | + | |
| 643 | + | |
| 644 | + | |
| 645 | + | |
| 646 | + | |
| 647 | + | |
| 648 | + | |
| 649 | + | |
| 650 | + | |
| 651 | + | |
| 652 | + | |
| 653 | + | |
| 654 | + | |
| 655 | + | |
| 656 | + | |
605 | 657 | | |
606 | 658 | | |
607 | 659 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
913 | 913 | | |
914 | 914 | | |
915 | 915 | | |
916 | | - | |
| 916 | + | |
| 917 | + | |
| 918 | + | |
| 919 | + | |
| 920 | + | |
| 921 | + | |
| 922 | + | |
| 923 | + | |
| 924 | + | |
| 925 | + | |
| 926 | + | |
| 927 | + | |
| 928 | + | |
| 929 | + | |
| 930 | + | |
917 | 931 | | |
918 | | - | |
919 | | - | |
| 932 | + | |
| 933 | + | |
920 | 934 | | |
921 | | - | |
922 | | - | |
| 935 | + | |
923 | 936 | | |
924 | | - | |
| 937 | + | |
925 | 938 | | |
926 | 939 | | |
927 | 940 | | |
928 | 941 | | |
929 | | - | |
930 | | - | |
931 | 942 | | |
932 | 943 | | |
933 | | - | |
934 | | - | |
935 | | - | |
936 | | - | |
937 | | - | |
938 | | - | |
939 | | - | |
940 | | - | |
941 | | - | |
942 | | - | |
943 | | - | |
944 | | - | |
945 | | - | |
| 944 | + | |
| 945 | + | |
| 946 | + | |
| 947 | + | |
| 948 | + | |
| 949 | + | |
| 950 | + | |
| 951 | + | |
| 952 | + | |
| 953 | + | |
| 954 | + | |
| 955 | + | |
| 956 | + | |
| 957 | + | |
| 958 | + | |
| 959 | + | |
| 960 | + | |
| 961 | + | |
| 962 | + | |
| 963 | + | |
| 964 | + | |
| 965 | + | |
| 966 | + | |
| 967 | + | |
| 968 | + | |
| 969 | + | |
| 970 | + | |
| 971 | + | |
| 972 | + | |
| 973 | + | |
| 974 | + | |
| 975 | + | |
| 976 | + | |
| 977 | + | |
| 978 | + | |
| 979 | + | |
| 980 | + | |
| 981 | + | |
| 982 | + | |
| 983 | + | |
| 984 | + | |
| 985 | + | |
| 986 | + | |
| 987 | + | |
| 988 | + | |
| 989 | + | |
| 990 | + | |
| 991 | + | |
| 992 | + | |
| 993 | + | |
| 994 | + | |
| 995 | + | |
| 996 | + | |
| 997 | + | |
| 998 | + | |
946 | 999 | | |
947 | 1000 | | |
948 | 1001 | | |
| |||
0 commit comments