refactor(codegen): rename --fields to --select for TS SDK consistency

Author: pyramation

graphql/codegen/src/__tests__/codegen/__snapshots__/cli-generator.test.ts.snap

@@ -321,7 +321,7 @@ myapp car find-first --where.id.equalTo <value>
 ### List car records with field selection
 
 \`\`\`bash
-myapp car list --fields id,id
+myapp car list --select id,id
 \`\`\`
 
 ### List car records with filtering and ordering
@@ -393,7 +393,7 @@ myapp driver find-first --where.id.equalTo <value>
 ### List driver records with field selection
 
 \`\`\`bash
-myapp driver list --fields id,id
+myapp driver list --select id,id
 \`\`\`
 
 ### List driver records with filtering and ordering
@@ -706,7 +706,7 @@ const fieldSchema: FieldSchema = {
   isElectric: "boolean",
   createdAt: "string"
 };
-const usage = "\\ncar <command>\\n\\nCommands:\\n  list                  List car records\\n  find-first            Find first matching car record\\n  get                   Get a car by ID\\n  create                Create a new car\\n  update                Update an existing car\\n  delete                Delete a car\\n\\nList Options:\\n  --limit <n>           Max number of records to return (forward pagination)\\n  --last <n>            Number of records from the end (backward pagination)\\n  --after <cursor>      Cursor for forward pagination\\n  --before <cursor>     Cursor for backward pagination\\n  --offset <n>          Number of records to skip\\n  --fields <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.name.equalTo foo)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n  --orderBy <values>    Comma-separated ordering values (e.g. NAME_ASC,CREATED_AT_DESC)\\n\\nFind-First Options:\\n  --fields <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.status.equalTo active)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n\\n  --help, -h            Show this help message\\n";
+const usage = "\\ncar <command>\\n\\nCommands:\\n  list                  List car records\\n  find-first            Find first matching car record\\n  get                   Get a car by ID\\n  create                Create a new car\\n  update                Update an existing car\\n  delete                Delete a car\\n\\nList Options:\\n  --limit <n>           Max number of records to return (forward pagination)\\n  --last <n>            Number of records from the end (backward pagination)\\n  --after <cursor>      Cursor for forward pagination\\n  --before <cursor>     Cursor for backward pagination\\n  --offset <n>          Number of records to skip\\n  --select <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.name.equalTo foo)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n  --orderBy <values>    Comma-separated ordering values (e.g. NAME_ASC,CREATED_AT_DESC)\\n\\nFind-First Options:\\n  --select <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.status.equalTo active)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n\\n  --help, -h            Show this help message\\n";
 export default async (argv: Partial<Record<string, unknown>>, prompter: Inquirerer, _options: CLIOptions) => {
   if (argv.help || argv.h) {
     console.log(usage);
@@ -1166,7 +1166,7 @@ const fieldSchema: FieldSchema = {
   name: "string",
   licenseNumber: "string"
 };
-const usage = "\\ndriver <command>\\n\\nCommands:\\n  list                  List driver records\\n  find-first            Find first matching driver record\\n  get                   Get a driver by ID\\n  create                Create a new driver\\n  update                Update an existing driver\\n  delete                Delete a driver\\n\\nList Options:\\n  --limit <n>           Max number of records to return (forward pagination)\\n  --last <n>            Number of records from the end (backward pagination)\\n  --after <cursor>      Cursor for forward pagination\\n  --before <cursor>     Cursor for backward pagination\\n  --offset <n>          Number of records to skip\\n  --fields <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.name.equalTo foo)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n  --orderBy <values>    Comma-separated ordering values (e.g. NAME_ASC,CREATED_AT_DESC)\\n\\nFind-First Options:\\n  --fields <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.status.equalTo active)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n\\n  --help, -h            Show this help message\\n";
+const usage = "\\ndriver <command>\\n\\nCommands:\\n  list                  List driver records\\n  find-first            Find first matching driver record\\n  get                   Get a driver by ID\\n  create                Create a new driver\\n  update                Update an existing driver\\n  delete                Delete a driver\\n\\nList Options:\\n  --limit <n>           Max number of records to return (forward pagination)\\n  --last <n>            Number of records from the end (backward pagination)\\n  --after <cursor>      Cursor for forward pagination\\n  --before <cursor>     Cursor for backward pagination\\n  --offset <n>          Number of records to skip\\n  --select <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.name.equalTo foo)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n  --orderBy <values>    Comma-separated ordering values (e.g. NAME_ASC,CREATED_AT_DESC)\\n\\nFind-First Options:\\n  --select <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.status.equalTo active)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n\\n  --help, -h            Show this help message\\n";
 export default async (argv: Partial<Record<string, unknown>>, prompter: Inquirerer, _options: CLIOptions) => {
   if (argv.help || argv.h) {
     console.log(usage);
@@ -3197,7 +3197,7 @@ const fieldSchema: FieldSchema = {
   email: "string",
   name: "string"
 };
-const usage = "\\nuser <command>\\n\\nCommands:\\n  list                  List user records\\n  find-first            Find first matching user record\\n  get                   Get a user by ID\\n  create                Create a new user\\n  update                Update an existing user\\n  delete                Delete a user\\n\\nList Options:\\n  --limit <n>           Max number of records to return (forward pagination)\\n  --last <n>            Number of records from the end (backward pagination)\\n  --after <cursor>      Cursor for forward pagination\\n  --before <cursor>     Cursor for backward pagination\\n  --offset <n>          Number of records to skip\\n  --fields <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.name.equalTo foo)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n  --orderBy <values>    Comma-separated ordering values (e.g. NAME_ASC,CREATED_AT_DESC)\\n\\nFind-First Options:\\n  --fields <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.status.equalTo active)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n\\n  --help, -h            Show this help message\\n";
+const usage = "\\nuser <command>\\n\\nCommands:\\n  list                  List user records\\n  find-first            Find first matching user record\\n  get                   Get a user by ID\\n  create                Create a new user\\n  update                Update an existing user\\n  delete                Delete a user\\n\\nList Options:\\n  --limit <n>           Max number of records to return (forward pagination)\\n  --last <n>            Number of records from the end (backward pagination)\\n  --after <cursor>      Cursor for forward pagination\\n  --before <cursor>     Cursor for backward pagination\\n  --offset <n>          Number of records to skip\\n  --select <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.name.equalTo foo)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n  --orderBy <values>    Comma-separated ordering values (e.g. NAME_ASC,CREATED_AT_DESC)\\n\\nFind-First Options:\\n  --select <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.status.equalTo active)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n\\n  --help, -h            Show this help message\\n";
 export default async (argv: Partial<Record<string, unknown>>, prompter: Inquirerer, _options: CLIOptions) => {
   if (argv.help || argv.h) {
     console.log(usage);
@@ -3425,7 +3425,7 @@ const fieldSchema: FieldSchema = {
   id: "uuid",
   role: "string"
 };
-const usage = "\\nmember <command>\\n\\nCommands:\\n  list                  List member records\\n  find-first            Find first matching member record\\n  get                   Get a member by ID\\n  create                Create a new member\\n  update                Update an existing member\\n  delete                Delete a member\\n\\nList Options:\\n  --limit <n>           Max number of records to return (forward pagination)\\n  --last <n>            Number of records from the end (backward pagination)\\n  --after <cursor>      Cursor for forward pagination\\n  --before <cursor>     Cursor for backward pagination\\n  --offset <n>          Number of records to skip\\n  --fields <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.name.equalTo foo)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n  --orderBy <values>    Comma-separated ordering values (e.g. NAME_ASC,CREATED_AT_DESC)\\n\\nFind-First Options:\\n  --fields <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.status.equalTo active)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n\\n  --help, -h            Show this help message\\n";
+const usage = "\\nmember <command>\\n\\nCommands:\\n  list                  List member records\\n  find-first            Find first matching member record\\n  get                   Get a member by ID\\n  create                Create a new member\\n  update                Update an existing member\\n  delete                Delete a member\\n\\nList Options:\\n  --limit <n>           Max number of records to return (forward pagination)\\n  --last <n>            Number of records from the end (backward pagination)\\n  --after <cursor>      Cursor for forward pagination\\n  --before <cursor>     Cursor for backward pagination\\n  --offset <n>          Number of records to skip\\n  --select <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.name.equalTo foo)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n  --orderBy <values>    Comma-separated ordering values (e.g. NAME_ASC,CREATED_AT_DESC)\\n\\nFind-First Options:\\n  --select <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.status.equalTo active)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n\\n  --help, -h            Show this help message\\n";
 export default async (argv: Partial<Record<string, unknown>>, prompter: Inquirerer, _options: CLIOptions) => {
   if (argv.help || argv.h) {
     console.log(usage);
@@ -3640,7 +3640,7 @@ const fieldSchema: FieldSchema = {
   isElectric: "boolean",
   createdAt: "string"
 };
-const usage = "\\ncar <command>\\n\\nCommands:\\n  list                  List car records\\n  find-first            Find first matching car record\\n  get                   Get a car by ID\\n  create                Create a new car\\n  update                Update an existing car\\n  delete                Delete a car\\n\\nList Options:\\n  --limit <n>           Max number of records to return (forward pagination)\\n  --last <n>            Number of records from the end (backward pagination)\\n  --after <cursor>      Cursor for forward pagination\\n  --before <cursor>     Cursor for backward pagination\\n  --offset <n>          Number of records to skip\\n  --fields <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.name.equalTo foo)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n  --orderBy <values>    Comma-separated ordering values (e.g. NAME_ASC,CREATED_AT_DESC)\\n\\nFind-First Options:\\n  --fields <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.status.equalTo active)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n\\n  --help, -h            Show this help message\\n";
+const usage = "\\ncar <command>\\n\\nCommands:\\n  list                  List car records\\n  find-first            Find first matching car record\\n  get                   Get a car by ID\\n  create                Create a new car\\n  update                Update an existing car\\n  delete                Delete a car\\n\\nList Options:\\n  --limit <n>           Max number of records to return (forward pagination)\\n  --last <n>            Number of records from the end (backward pagination)\\n  --after <cursor>      Cursor for forward pagination\\n  --before <cursor>     Cursor for backward pagination\\n  --offset <n>          Number of records to skip\\n  --select <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.name.equalTo foo)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n  --orderBy <values>    Comma-separated ordering values (e.g. NAME_ASC,CREATED_AT_DESC)\\n\\nFind-First Options:\\n  --select <fields>     Comma-separated list of fields to return\\n  --where.<field>.<op>  Filter (dot-notation, e.g. --where.status.equalTo active)\\n  --condition.<f>.<op>  Condition filter (dot-notation)\\n\\n  --help, -h            Show this help message\\n";
 export default async (argv: Partial<Record<string, unknown>>, prompter: Inquirerer, _options: CLIOptions) => {
   if (argv.help || argv.h) {
     console.log(usage);

graphql/codegen/src/core/codegen/cli/docs-generator.ts

@@ -427,7 +427,7 @@ export function generateSkills(
           },
           {
             description: `List ${singularName} records with field selection`,
-            code: [`${toolName} ${kebab} list --fields id,${pk.name}`],
+            code: [`${toolName} ${kebab} list --select id,${pk.name}`],
           },
           {
             description: `List ${singularName} records with filtering and ordering`,

graphql/codegen/src/core/codegen/cli/table-command-generator.ts

@@ -572,7 +572,7 @@ function buildListHandler(table: Table, vectorFieldNames: string[], targetName?:
 
 /**
  * Build a `handleFindFirst` function — CLI equivalent of the TS SDK's findFirst().
- * Accepts --fields, --where.<field>.<op>, --condition.<field>.<op> flags.
+ * Accepts --select, --where.<field>.<op>, --condition.<field>.<op> flags.
  * Internally calls findMany with first:1 and returns a single record (or null).
  */
 function buildFindFirstHandler(table: Table, targetName?: string, typeRegistry?: TypeRegistry): t.FunctionDeclaration {
@@ -654,7 +654,7 @@ function buildFindFirstHandler(table: Table, targetName?: string, typeRegistry?:
  * Build a `handleSearch` function for tables with search-capable fields.
  * Extracts the first positional arg as the query string and auto-builds a
  * `where` clause that targets all detected search fields (tsvector, BM25,
- * trigram, vector embedding).  Supports --limit, --offset, --fields, --orderBy.
+ * trigram, vector embedding).  Supports --limit, --offset, --select, --orderBy.
  */
 function buildSearchHandler(
   table: Table,
@@ -1376,13 +1376,13 @@ export function generateTableCommand(table: Table, options?: TableCommandOptions
     '  --after <cursor>      Cursor for forward pagination',
     '  --before <cursor>     Cursor for backward pagination',
     '  --offset <n>          Number of records to skip',
-    '  --fields <fields>     Comma-separated list of fields to return',
+    '  --select <fields>     Comma-separated list of fields to return',
     '  --where.<field>.<op>  Filter (dot-notation, e.g. --where.name.equalTo foo)',
     '  --condition.<f>.<op>  Condition filter (dot-notation)',
     '  --orderBy <values>    Comma-separated ordering values (e.g. NAME_ASC,CREATED_AT_DESC)',
     '',
     'Find-First Options:',
-    '  --fields <fields>     Comma-separated list of fields to return',
+    '  --select <fields>     Comma-separated list of fields to return',
     '  --where.<field>.<op>  Filter (dot-notation, e.g. --where.status.equalTo active)',
     '  --condition.<f>.<op>  Condition filter (dot-notation)',
     '',
@@ -1393,7 +1393,7 @@ export function generateTableCommand(table: Table, options?: TableCommandOptions
       '  <query>               Search query string (required)',
       '  --limit <n>           Max number of records to return',
       '  --offset <n>          Number of records to skip',
-      '  --fields <fields>     Comma-separated list of fields to return',
+      '  --select <fields>     Comma-separated list of fields to return',
       '  --orderBy <values>    Comma-separated list of ordering values',
     );
     if (hasEmbeddings) {