feat(hide field): Allow hide field in type matching by pattern

close: #37
unlight · Jul 2, 2021 · 6c05123 · 6c05123
1 parent 00412d2
commit 6c05123
Show file tree

Hide file tree

Showing 8 changed files with 113 additions and 14 deletions.
diff --git a/.cz-config.js b/.cz-config.js
@@ -30,6 +30,7 @@ module.exports = {
     ],
 
     scopes: [
+        { name: 'hide field' },
         { name: 'configuration' },
         { name: 'custom decorators' },
         { name: 'compatibility' },

diff --git a/README.md b/README.md
@@ -237,11 +237,15 @@ Removes field from GraphQL schema.
 Alias: `@TypeGraphQL.omit(output: true)`
 
 By default (without arguments) field will be decorated for hide only in output types (type in schema).  
-To hide input types add `input: true`.  
+To hide field in input types add `input: true`.  
+To hide field in specific type you can use glob pattern `match: string | string[]`
+see [outmatch](https://github.com/axtgr/outmatch#usage) for details.
+
 Examples:
 
--   `@HideField()` same as `@HideField(output: true)` or `@HideField({ output: true })`
+-   `@HideField()` same as `@HideField({ output: true })`
 -   `@HideField({ input: true, output: true })`
+-   `@HideField({ match: 'UserCreate*Input' })`
 
 ```prisma
 model User {
@@ -250,6 +254,8 @@ model User {
     password String
     /// @HideField({ output: true, input: true })
     secret String
+    /// @HideField({ match: '@(User|Comment)Create*Input' })
+    createdAt DateTime @default(now())
 }
 ```
 
@@ -262,6 +268,8 @@ export class User {
     password: string;
     @HideField()
     secret: string;
+    @Field(() => Date, { nullable: false })
+    createdAt: Date;
 }
 ```
 
@@ -272,6 +280,8 @@ export class UserCreateInput {
     password: string;
     @HideField()
     secret: string;
+    @HideField()
+    createdAt: Date;
 }
 ```
 

diff --git a/prisma/schema.prisma b/prisma/schema.prisma
@@ -59,6 +59,7 @@ model Article {
   description    String
   body           String
   tags           Tag[]
+  /// @HideField({ match: '*Create*Input' })
   createdAt      DateTime  @default(now())
   updatedAt      DateTime  @updatedAt
   favoritesCount Int       @default(0)
@@ -72,6 +73,7 @@ model Article {
 model Comment {
   id        String   @id @default(cuid())
   createdAt DateTime @default(now())
+  /// @HideField({ match: '*Update*Input' })
   updatedAt DateTime @updatedAt
   body      String
   author    User     @relation(fields: [authorId], references: [id])

diff --git a/src/handlers/input-type.ts b/src/handlers/input-type.ts
@@ -152,7 +152,7 @@ export function inputType(
         //     });
         // }
 
-        if (settings?.hideInput) {
+        if (settings?.shouldHideField({ name: inputType.name, input: true })) {
             importDeclarations.add('HideField', '@nestjs/graphql');
             property.decorators?.push({ name: 'HideField', arguments: [] });
         } else {

diff --git a/src/handlers/model-output-type.ts b/src/handlers/model-output-type.ts
@@ -172,7 +172,7 @@ export function modelOutputType(outputType: OutputType, args: EventArguments) {
             importDeclarations.add(customType.fieldType, customType.fieldModule);
         }
 
-        if (settings?.hideOutput) {
+        if (settings?.shouldHideField({ name: outputType.name, output: true })) {
             importDeclarations.add('HideField', nestjsGraphql);
             property.decorators?.push({ name: 'HideField', arguments: [] });
         } else {

diff --git a/src/handlers/output-type.ts b/src/handlers/output-type.ts
@@ -119,7 +119,7 @@ export function outputType(outputType: OutputType, args: EventArguments) {
             importDeclarations.add(customType.fieldType, customType.fieldModule);
         }
 
-        if (settings?.hideOutput) {
+        if (settings?.shouldHideField({ name: outputType.name, output: true })) {
             importDeclarations.add('HideField', nestjsGraphql);
             property.decorators?.push({ name: 'HideField', arguments: [] });
         } else {

diff --git a/src/helpers/field-settings.ts b/src/helpers/field-settings.ts
@@ -1,5 +1,6 @@
 import JSON5 from 'json5';
 import { merge, trim } from 'lodash';
+import outmatch from 'outmatch';
 
 import { GeneratorConfiguration } from '../types';
 
@@ -12,6 +13,7 @@ export type FieldSetting = {
     arguments?: string[];
     input: boolean;
     output: boolean;
+    match?: (test: string) => boolean;
     from: string;
     namespace?: string;
     defaultImport?: string | true;
@@ -20,12 +22,22 @@ export type FieldSetting = {
 };
 
 export class FieldSettings extends Array<FieldSetting> {
-    get hideInput() {
-        return this.some(s => s.name === 'HideField' && s.input);
-    }
+    shouldHideField({
+        name,
+        input = false,
+        output = false,
+    }: {
+        name: string;
+        input?: boolean;
+        output?: boolean;
+    }): boolean {
+        const hideField = this.find(s => s.name === 'HideField');
 
-    get hideOutput() {
-        return this.some(s => s.name === 'HideField' && s.output);
+        return Boolean(
+            (hideField?.input && input) ||
+                (hideField?.output && output) ||
+                hideField?.match?.(name),
+        );
     }
 
     getFieldType() {
@@ -46,7 +58,7 @@ export function createFieldSettings(args: {
     const textLines = text.split('\n');
     const documentationLines: string[] = [];
     for (const line of textLines) {
-        const match = /^@(?<name>\w+(\.(\w+))?)\((?<args>.*?)\)/.exec(line);
+        const match = /^@(?<name>\w+(\.(\w+))?)\((?<args>.*)\)/.exec(line);
         const name = match?.groups?.name;
         if (!match || !name) {
             documentationLines.push(line);
@@ -113,17 +125,29 @@ function hideFieldDecorator(match: RegExpExecArray) {
         from: '@nestjs/graphql',
         defaultImport: undefined,
         namespaceImport: undefined,
+        match: undefined,
     };
-    if (match.groups?.args) {
+    if (!match.groups?.args) {
+        result.output = true;
+        return result;
+    }
+
+    if (match.groups.args.includes('{') && match.groups.args.includes('}')) {
+        const options = parseArgs(match.groups.args) as Record<string, unknown>;
+        result.output = Boolean(options.output);
+        result.input = Boolean(options.input);
+        if (typeof options.match === 'string' || Array.isArray(options.match)) {
+            result.match = outmatch(options.match, { separator: false });
+        }
+    } else {
         if (/output:\s*true/.test(match.groups.args)) {
             result.output = true;
         }
         if (/input:\s*true/.test(match.groups.args)) {
             result.input = true;
         }
-    } else {
-        result.output = true;
     }
+
     return result;
 }
 

diff --git a/src/test/generate.spec.ts b/src/test/generate.spec.ts
@@ -1291,6 +1291,61 @@ describe('hide field', () => {
             // it('^', () => console.log(sourceFile.getText()));
         });
     });
+
+    describe('hide field using match', () => {
+        before(async () => {
+            ({ project, sourceFiles } = await testGenerate({
+                schema: `
+                    model User {
+                        id String @id
+                        /// @HideField({ match: '@(User|Comment)Create*Input' })
+                        createdAt DateTime @default(now())
+                        /// @HideField( { match: '*Update*Input' } )
+                        updatedAt DateTime @updatedAt
+                    }
+                    `,
+                options: [`outputFilePattern = "{name}.{type}.ts"`],
+            }));
+        });
+
+        it('in model nothing should be hidden', () => {
+            setSourceFile('user.model.ts');
+            expect(p('createdAt')?.decorators).toHaveLength(1);
+            expect(d('createdAt')).toEqual(expect.objectContaining({ name: 'Field' }));
+        });
+
+        it('user-create-many.input', () => {
+            setSourceFile('user-create-many.input.ts');
+            expect(p('createdAt')?.decorators).toHaveLength(1);
+            expect(d('createdAt')).toEqual(
+                expect.objectContaining({ name: 'HideField' }),
+            );
+        });
+
+        it('user-create.input', () => {
+            setSourceFile('user-create.input.ts');
+            expect(p('createdAt')?.decorators).toHaveLength(1);
+            expect(d('createdAt')).toEqual(
+                expect.objectContaining({ name: 'HideField' }),
+            );
+        });
+
+        it('user-update-many-mutation.input', () => {
+            setSourceFile('user-update-many-mutation.input.ts');
+            expect(p('updatedAt')?.decorators).toHaveLength(1);
+            expect(d('updatedAt')).toEqual(
+                expect.objectContaining({ name: 'HideField' }),
+            );
+        });
+
+        it('user-update.input', () => {
+            setSourceFile('user-update.input.ts');
+            expect(p('updatedAt')?.decorators).toHaveLength(1);
+            expect(d('updatedAt')).toEqual(
+                expect.objectContaining({ name: 'HideField' }),
+            );
+        });
+    });
 });
 
 it('model with prisma keyword output', async () => {
@@ -1808,3 +1863,10 @@ describe('output without fields', () => {
         expect(t('comments')).toEqual('() => Int');
     });
 });
+
+// it('filePaths', () => {
+//     console.log(
+//         'filePaths',
+//         sourceFiles.map(s => s.getBaseName()),
+//     );
+// });