Merge pull request #83 from JulienSergent/hotfix/ignore-file-type

Hotfix/ignore file type

Author: thiagobustamante

.gitignore

@@ -7,3 +7,4 @@ node_modules
 coverage
 *.log
 npm-debug.log*
+.idea

README.MD

@@ -271,7 +271,10 @@ See an example:
                 "name": "access_token",
                 "in": "query"
             }
-        }
+        },
+        "ignore": [
+          "**/node_modules/**"
+        ]
     }
 }
 ```
@@ -296,4 +299,6 @@ swagger:
       type: apiKey
       name: access_token
       in: query
+  ignore:
+    - /node_modules/**    
 ```

package-lock.json

@@ -57,7 +57,8 @@
     "swagger2openapi": "^5.3.0",
     "typescript": "^3.5.2",
     "typescript-rest": "^2.2.0",
-    "yamljs": "^0.2.10"
+    "yamljs": "^0.2.10",
+    "minimatch": "^3.0.4"
   },
   "devDependencies": {
     "@types/argparse": "^1.0.36",
@@ -69,6 +70,7 @@
     "@types/mkdirp": "^0.3.29",
     "@types/mocha": "^2.2.48",
     "@types/yamljs": "^0.2.30",
+    "@types/minimatch": "^3.0.3",
     "chai": "4.2.0",
     "coveralls": "^3.0.4",
     "cross-env": "^4.0.0",

package.json

@@ -60,7 +60,7 @@ const swaggerConfig = validateSwaggerConfig(config.swagger);
 debugLog('Swagger Config: %j', swaggerConfig);
 
 debugLog('Processing Services Metadata');
-const metadata = new MetadataGenerator(swaggerConfig.entryFile, compilerOptions).generate();
+const metadata = new MetadataGenerator(swaggerConfig.entryFile, compilerOptions, swaggerConfig.ignore).generate();
 debugLog('Generated Metadata: %j', metadata);
 
 new SpecGenerator(metadata, swaggerConfig).generate()

src/cli.ts

@@ -102,4 +102,9 @@ export interface SwaggerConfig {
      * Possible values are `csv`, `ssv`, `tsv`, `pipes`, `multi`. If not specified, Swagger defaults to `csv`.
      */
     collectionFormat?: string;
+
+    /**
+     * Directory to ignore during TypeScript metadata scan
+     */
+    ignore?: [string];
 }

src/config.ts

@@ -1,6 +1,7 @@
 import * as debug from 'debug';
 import * as glob from 'glob';
 import * as _ from 'lodash';
+import * as mm from 'minimatch';
 import * as ts from 'typescript';
 import { ControllerGenerator } from './controllerGenerator';
 
@@ -13,7 +14,7 @@ export class MetadataGenerator {
     private circularDependencyResolvers = new Array<(referenceTypes: { [typeName: string]: ReferenceType }) => void>();
     private debugger = debug('typescript-rest-swagger:metadata');
 
-    constructor(entryFile: string | Array<string>, compilerOptions: ts.CompilerOptions) {
+    constructor(entryFile: string | Array<string>, compilerOptions: ts.CompilerOptions, private readonly  ignorePaths?: Array<string>) {
         const sourceFiles = this.getSourceFiles(entryFile);
         this.debugger('Starting Metadata Generator');
         this.debugger('Source files: %j ', sourceFiles);
@@ -25,6 +26,14 @@ export class MetadataGenerator {
 
     public generate(): Metadata {
         this.program.getSourceFiles().forEach(sf => {
+            if (this.ignorePaths && this.ignorePaths.length) {
+                for (const path of this.ignorePaths) {
+                    if(!sf.fileName.includes('node_modules/typescript-rest-swagger/') && mm(sf.fileName, path)) {
+                        return;
+                    }
+                }
+            }
+
             ts.forEachChild(sf, node => {
                 this.nodes.push(node);
             });

src/metadata/metadataGenerator.ts

@@ -1,7 +1,7 @@
 'use strict';
 
 import {
-    Accept, DELETE, GET, Path,
+    Accept, DELETE, FormParam, GET, Path,
     PathParam, POST, PUT, QueryParam,
     Return,
     Security
@@ -96,6 +96,12 @@ export class MyService {
     public async testCompilerOptions(payload: TestInterface): Promise<TestInterface> {
         return { a: 'string', b: 123 };
     }
+
+    @POST
+    @Path('test-form-param')
+    public testFormParam(@FormParam('id') id: string): string {
+        return id;
+    }
 }
 
 class BaseService {

test/data/apis.ts

@@ -234,6 +234,19 @@ describe('Definition generation', () => {
       expression = jsonata('paths."/mypath/test-compiler-options".post.parameters[0].schema');
       expect(expression.evaluate(spec)).to.eql({ $ref: '#/definitions/TestInterface' });
     });
+    it('should support formparam', () => {
+      expect(spec.paths).to.have.property('/mypath/test-form-param');
+      let expression = jsonata('paths."/mypath/test-form-param".post.responses."200".schema');
+      expect(expression.evaluate(spec)).to.eql({ type: 'string' });
+      expression = jsonata('paths."/mypath/test-form-param".post.parameters[0]');
+      expect(expression.evaluate(spec)).to.eql({
+        description: '',
+        in: 'formData',
+        name: 'id',
+        required: true,
+        type: 'string',
+      });
+    });
   });
 
   describe('PrimitiveEndpoint', () => {