Add singularNames option

Signed-off-by: Alan Cha <[email protected]>

Author: Alan-Cha

packages/openapi-to-graphql-cli/README.md

@@ -32,9 +32,10 @@ Options:
 
   -o, --operationIdFieldNames    create field names based on the operationId
   -f, --fillEmptyResponses       create placeholder schemas for operations with no response body rather than ignore them
-  -a, --addLimitArgument         add a limit argument on fields returning lists of objects/lists to control the data size
-  -g, --genericPayloadArgName    Sets argument name for the payload of a mutation to 'requestBody'
-  -N, --simpleNames             Only remove illegal characters from names in the OAS and ignore casing and formatting
+  --addLimitArgument             add a limit argument on fields returning lists of objects/lists to control the data size
+  --genericPayloadArgName        Sets argument name for the payload of a mutation to 'requestBody'
+  --simpleNames                  Only remove illegal characters from names in the OAS and ignore casing and formatting
+  --singularNames                Experimental feature that will create more meaningful names from the operation path
 
   -H, --header <key:value>       add headers to every request; repeatable flag; set using key:value notation (default: [])
   -Q, --queryString <key:value>  add query parameters to every request; repeatable flag; set using key:value notation (default: [])

packages/openapi-to-graphql-cli/lib/openapi-to-graphql.js

@@ -47,17 +47,21 @@ program
     'create placeholder schemas for operations with no response body rather than ignore them'
   )
   .option(
-    '-a, --addLimitArgument',
+    '--addLimitArgument',
     'add a limit argument on fields returning lists of objects/lists to control the data size'
   )
   .option(
-    '-g, --genericPayloadArgName',
+    '--genericPayloadArgName',
     "Sets argument name for the payload of a mutation to 'requestBody'"
   )
   .option(
-    '-N, --simpleNames',
+    '--simpleNames',
     'Only remove illegal characters from names in the OAS and ignore casing and formatting'
   )
+  .option(
+    '--singularNames',
+    'Experimental feature that will create more meaningful names from the operation path'
+  )
 
   // Resolver options
   .option(
@@ -112,6 +116,7 @@ const options: Options = {
   addLimitArgument: program.addLimitArgument,
   genericPayloadArgName: program.genericPayloadArgName,
   simpleNames: program.simpleNames,
+  singularNames: program.singularNames,
 
   // Resolver options
   headers,

packages/openapi-to-graphql-cli/lib/openapi-to-graphql.js.map

@@ -162,6 +162,8 @@ Schema options:
 
 - `simpleNames` (type: `boolean`, default: `false`): By default, field names are sanitized to conform with GraphQL conventions, i.e. types should be in PascalCase, fields should be in camelCase, and enum values should be in ALL_CAPS. This option will prevent OTG from enforcing camelCase field names and PascalCase type names, only removing illegal characters and staying as true to the provided names in the OAS as possible. 
 
+- `singularNames` (type: `boolean`, default: `false`): Experimental feature that will try to create more meaningful names from the operation path than the response object by leveraging common conventions. For example, given the operation `GET /users/{userId}/car`, OtG will create a `Query` field `userCar`. Note that because `users` is followed by the parameter `userId`, it insinuates that this operation will get the car that belongs to a singular user. Hence, the name `userCar` is more fitting than `usersCar` so the pluralizing 's' is dropped. This option will also consider irregular plural forms.
+
 ***
 
 Resolver options:
@@ -257,9 +259,9 @@ OpenAPI-to-GraphQL further provides `anyAuth` viewers (for queries and mutations
       password: "secret"
     }
   ) {
-    patentWithId (patentId: "test") {  // requires "exampleApiKeyProtocol"
+    patent (patentId: "test") {  // requires "exampleApiKeyProtocol"
       patentId
-      inventor {                       // requires "exampleBasicProtocol"
+      inventor {                 // requires "exampleBasicProtocol"
         name
       }
     }