feat: make list queries included by default

Remove the conditional inclusion check for list queries in the SQL template,
making them always generated. Update tests to reflect that ListUsers and other
list queries are now part of the default generated queries rather than opt-in.

Signed-off-by: Svetlin Ralchev <iamralch@users.noreply.github.com>

Author: iamralch

README.md

@@ -12,8 +12,8 @@ A CLI tool that generates [sqlc](https://sqlc.dev)-compatible SQL queries from y
 ## Features
 
 - Generate CRUD queries (`SELECT`, `INSERT`, `UPDATE`, `DELETE`) from a database schema catalog
-- Primary key CRUD operations generated by default — no configuration needed
-- Opt-in to additional queries (List, Copy, FK joins, non-unique index queries) via `queries` allowlist
+- Primary key CRUD and List operations generated by default — no configuration needed
+- Opt-in to additional queries (Copy, FK joins, non-unique index queries) via `queries` allowlist
 - Configurable via YAML — shares the same `sqlc.yaml` configuration file
 - Works as a standalone CLI or as part of a CI/CD pipeline
 - Supports custom query templates
@@ -61,20 +61,21 @@ sql:
         out: "ent/query"
         options:
           queries:
-            - "ListUsers"
             - "CopyUsers"
             - "GetUserWithPost"
 ```
 
 ### Default queries (always generated)
 
-Primary key CRUD operations and their Exec/Batch variants are generated
-automatically for every table:
+Primary key CRUD operations, List queries, and their Exec/Batch variants are
+generated automatically for every table:
 
 | Query                     | Description                                |
 | ------------------------- | ------------------------------------------ |
 | `Get<Table>`              | Select a row by primary key                |
 | `BatchGet<Tables>`        | Batch select rows by primary key           |
+| `List<Tables>`            | Paginated list with filtering              |
+| `List<Tables>By<Columns>` | Paginated list by non-unique index         |
 | `Insert<Table>`           | Insert a row                               |
 | `ExecInsert<Table>`       | Insert a row (exec, returns affected rows) |
 | `BatchInsert<Tables>`     | Batch insert rows                          |
@@ -94,12 +95,10 @@ These queries are only generated when explicitly listed in `options.queries`:
 
 | Query                           | Description                              |
 | ------------------------------- | ---------------------------------------- |
-| `List<Tables>`                  | Paginated list with filtering            |
 | `Copy<Tables>`                  | Bulk insert via PostgreSQL COPY protocol |
 | `Get<Table>With<Related>`       | Select with FK join                      |
 | `BatchGet<Tables>With<Related>` | Batch select with FK join                |
 | `Get<Table>By<Columns>`         | Select by non-PK unique index            |
-| `List<Tables>By<Columns>`       | Paginated list by non-unique index       |
 | `Update<Tables>By<Columns>`     | Update by non-unique index               |
 | `Delete<Tables>By<Columns>`     | Delete by non-unique index               |
 

internal/sqlc/config_test.go

@@ -24,8 +24,8 @@ var _ = Describe("Config", func() {
 			Expect(config.SQL[0].Codegen[0].Plugin).To(Equal("gen-queries"))
 			Expect(config.SQL[0].Codegen[0].Out).To(Equal("ent/query"))
 			opts := config.SQL[0].GetOptions()
-			Expect(opts.Queries).To(HaveLen(3))
-			Expect(opts.Queries).To(ContainElements("ListUsers", "CopyUsers", "GetUserByEmail"))
+			Expect(opts.Queries).To(HaveLen(2))
+			Expect(opts.Queries).To(ContainElements("CopyUsers", "GetUserByEmail"))
 		})
 
 		When("the file does not exist", func() {

internal/sqlc/config_test_exclude.yaml

@@ -12,6 +12,5 @@ sql:
         out: "ent/query"
         options:
           queries:
-            - "ListUsers"
             - "CopyUsers"
             - "GetUserByEmail"

internal/sqlc/generator_test.go

@@ -65,8 +65,10 @@ var _ = Describe("Generator", func() {
 				Expect(string(content)).To(ContainSubstring("name: UpdateUser :one"))
 				Expect(string(content)).To(ContainSubstring("name: DeleteUser :one"))
 
+				// Default List queries are present
+				Expect(string(content)).To(ContainSubstring("name: ListUsers :many"))
+
 				// Opt-in queries are not present without config
-				Expect(string(content)).NotTo(ContainSubstring("name: ListUsers :many"))
 				Expect(string(content)).NotTo(ContainSubstring("name: CopyUsers :copyfrom"))
 			}
 		})
@@ -103,7 +105,6 @@ var _ = Describe("Generator", func() {
 										Out:    dir,
 										Options: sqlc.CodegenOptions{
 											Queries: []string{
-												"ListUsers",
 												"CopyUsers",
 											},
 										},
@@ -130,8 +131,10 @@ var _ = Describe("Generator", func() {
 					Expect(string(content)).To(ContainSubstring("name: UpdateUser :one"))
 					Expect(string(content)).To(ContainSubstring("name: DeleteUser :one"))
 
-					// Opt-in queries that were listed are present
+					// Default List queries are present
 					Expect(string(content)).To(ContainSubstring("name: ListUsers :many"))
+
+					// Opt-in queries that were listed are present
 					Expect(string(content)).To(ContainSubstring("name: CopyUsers :copyfrom"))
 				}
 			})
@@ -150,8 +153,10 @@ var _ = Describe("Generator", func() {
 					Expect(string(content)).To(ContainSubstring("name: GetUser :one"))
 					Expect(string(content)).To(ContainSubstring("name: InsertUser :one"))
 
+					// Default List queries are present
+					Expect(string(content)).To(ContainSubstring("name: ListUsers :many"))
+
 					// Opt-in queries are not present
-					Expect(string(content)).NotTo(ContainSubstring("name: ListUsers :many"))
 					Expect(string(content)).NotTo(ContainSubstring("name: CopyUsers :copyfrom"))
 				}
 			})
@@ -170,8 +175,8 @@ var _ = Describe("Generator", func() {
 					Expect(string(content)).To(ContainSubstring("name: GetUser :one"))
 					Expect(string(content)).To(ContainSubstring("name: DeleteUser :one"))
 
-					// Opt-in queries are not present
-					Expect(string(content)).NotTo(ContainSubstring("name: ListUsers :many"))
+					// Default List queries are present
+					Expect(string(content)).To(ContainSubstring("name: ListUsers :many"))
 				}
 			})
 
@@ -189,8 +194,8 @@ var _ = Describe("Generator", func() {
 					Expect(string(content)).To(ContainSubstring("name: GetUser :one"))
 					Expect(string(content)).To(ContainSubstring("name: InsertUser :one"))
 
-					// Non-existent opt-in queries don't cause errors
-					Expect(string(content)).NotTo(ContainSubstring("name: ListUsers :many"))
+					// Default List queries are still present
+					Expect(string(content)).To(ContainSubstring("name: ListUsers :many"))
 				}
 			})
 		})

internal/sqlc/template/template.sql.tmpl

@@ -264,7 +264,6 @@ INSERT INTO {{.Table.Name}} (
 );
 {{- end}}
 {{- $query_name := printf "List%s" (table_name .Table.Name "many")}}
-{{- if should_include . $query_name}}
 
 -- List{{table_name .Table.Name "many"}} retrieves a paginated list of rows from '{{$.Table.Name}}'.
 --
@@ -298,10 +297,8 @@ LIMIT
     sqlc.narg(page_limit)::int
 OFFSET
     sqlc.narg(page_offset)::int;
-{{- end}}
 
 {{range $idx, $key := .Table.GetNonUniqueIndexes}}{{- $query_name := printf "List%s%s" (table_name $.Table.Name "many") (query_index $key)}}
-{{- if should_include $ $query_name}}
 
 -- List{{table_name $.Table.Name "many"}}{{query_index $key}} retrieves a paginated list of rows from '{{$.Table.Name}}'{{if $key.Name}} filtered by {{$key.Name}}{{end}}.
 --
@@ -341,7 +338,6 @@ LIMIT
     sqlc.narg(page_limit)::int
 OFFSET
     sqlc.narg(page_offset)::int;
-{{- end}}
 
 {{- $query_name := printf "Update%s%s" (table_name $.Table.Name "many") (query_index $key)}}
 {{- if should_include $ $query_name}}