@jackchuka/sdl-decompose 1.0.2 → 1.1.0

package/README.md

@@ -12,6 +12,7 @@ A powerful tool to decompose GraphQL SDL (Schema Definition Language) by operati
 - 🔄 **All operation types**: Support for queries, mutations, and subscriptions
 - 📝 **TypeScript support**: Full TypeScript definitions included
 - 🛠️ **CLI and programmatic API**: Use from command line or integrate into your code
+- 🚫 **Deprecated field filtering**: Exclude deprecated fields by default
 - ⚡ **Fast and lightweight**: Minimal dependencies, built on top of `graphql-js`
 
 ## Installation
@@ -54,6 +55,8 @@ Options:
   -t, --type <type>       Operation type: query, mutation, subscription (default: "query")
   --output <file>         Output file path (optional, prints to stdout if not provided)
   --include-builtins      Include builtin scalar types in output (default: false)
+  --exclude-comments      Remove comments and descriptions from output SDL (default: false)
+  --include-deprecated    Include deprecated fields in output (default: false)
   -h, --help              display help for command
 ```
 
@@ -115,7 +118,21 @@ type Post {
 npx @jackchuka/sdl-decompose --sdl schema.graphql --operation createUser --type mutation --output create-user.graphql
 ```
 
-#### Example 3: Using with Pipes
+#### Example 3: Remove Comments from Output
+
+```bash
+# Clean output without comments or descriptions
+npx @jackchuka/sdl-decompose --sdl schema.graphql --operation getUser --exclude-comments
+```
+
+#### Example 4: Include Deprecated Fields
+
+```bash
+# Include deprecated fields in output (excluded by default)
+npx @jackchuka/sdl-decompose --sdl schema.graphql --operation getUser --include-deprecated
+```
+
+#### Example 5: Using with Pipes
 
 ```bash
 # Download schema and decompose in one command
@@ -160,7 +177,9 @@ const fullSDL = `
 `;
 
 const result = decomposeGraphQL(fullSDL, 'getUser', 'query', {
-  includeBuiltinScalars: false
+  includeBuiltinScalars: false,
+  excludeComments: true,
+  includeDeprecated: false
 });
 
 console.log(result.sdl);
@@ -180,6 +199,8 @@ console.log('Operation found:', result.operationFound);
 
 **Options:**
 - `includeBuiltinScalars` (boolean): Include built-in scalar types (String, Int, Float, Boolean, ID) in the output. Defaults to `false`
+- `excludeComments` (boolean): Remove comments and descriptions from the output SDL. Defaults to `false`
+- `includeDeprecated` (boolean): Include deprecated fields in the output SDL. Defaults to `false`
 
 **Returns:**
 ```typescript
@@ -195,6 +216,8 @@ interface DecomposeResult {
 ```typescript
 interface DecomposeOptions {
   includeBuiltinScalars?: boolean;
+  excludeComments?: boolean;
+  includeDeprecated?: boolean;
 }
 
 interface DecomposeResult {
@@ -235,4 +258,4 @@ MIT © [jackchuka](https://github.com/jackchuka)
 ## Related Projects
 
 - [GraphQL Tools](https://www.graphql-tools.com/) - Comprehensive GraphQL utilities
-- [GraphQL Code Generator](https://www.graphql-code-generator.com/) - Generate code from GraphQL schemas
+- [GraphQL Code Generator](https://www.graphql-code-generator.com/) - Generate code from GraphQL schemas