Merge pull request #338 from hristozov/topic/ghristozov/fix-no-module-export

Do not emit an empty module export in the index if no module is required

Fixes #337

Author: luisfpg

templates/index.handlebars

@@ -6,7 +6,9 @@ export { {{configurationClass}} } from './{{{configurationFile}}}';
 export { {{baseServiceClass}} } from './{{{baseServiceFile}}}';
 export { {{requestBuilderClass}} } from './{{{requestBuilderFile}}}';
 export { {{responseClass}} } from './{{{responseFile}}}';
+{{#if moduleClass}}
 export { {{moduleClass}} } from './{{{moduleFile}}}';
+{{/if}}
 {{#modelIndex.imports}}export { {{{typeName}}}{{#useAlias}} as {{{qualifiedName}}}{{/useAlias}} } from './models{{{file}}}';
 {{/modelIndex.imports}}
 {{#services}}export { {{typeName}} } from './services/{{{fileName}}}';

test/all-types.spec.ts

@@ -1,5 +1,5 @@
 import { OpenAPIObject } from '@loopback/openapi-v3-types';
-import { ClassDeclaration, EnumDeclaration, InterfaceDeclaration, TypeAliasDeclaration, TypescriptParser } from 'typescript-parser';
+import { ClassDeclaration, EnumDeclaration, InterfaceDeclaration, NamedExport, TypeAliasDeclaration, TypescriptParser } from 'typescript-parser';
 import { NgOpenApiGen } from '../lib/ng-openapi-gen';
 import { Options } from '../lib/options';
 import options from './all-types.config.json';
@@ -526,4 +526,19 @@ describe('Generation tests using all-types.json', () => {
       done();
     });
   });
+
+  it('index file', done => {
+    const ref = gen.models.get('InlineObject');
+    const ts = gen.templates.apply('index', ref);
+    const parser = new TypescriptParser();
+    parser.parseSource(ts).then(ast => {
+      expect(ast.exports.length).withContext('Has the correct number of exports').toBe(5);
+      expect(ast.exports.some((ex: NamedExport) => ex.from === './api-configuration')).withContext('Has an ApiConfiguration export').toBeDefined();
+      expect(ast.exports.some((ex: NamedExport) => ex.from === './base-service')).withContext('Has a BaseService export').toBeDefined();
+      expect(ast.exports.some((ex: NamedExport) => ex.from === './request-builder')).withContext('Has a RequestBuilder export').toBeDefined();
+      expect(ast.exports.some((ex: NamedExport) => ex.from === './strict-http-response')).withContext('Has a StrictHttpResponse export').toBeDefined();
+      expect(ast.exports.some((ex: NamedExport) => ex.from === './api.module')).withContext('Has an ApiModule export').toBeDefined();
+      done();
+    });
+  });
 });

test/noModule.config.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "../ng-openapi-gen-schema.json",
+  "input": "test/noModule.json",
+  "output": "out/noModule",
+  "useTempDir": true,
+  "module": false,
+  "indexFile": true
+}

test/noModule.json

@@ -0,0 +1,25 @@
+{
+  "openapi": "3.0",
+  "info": {
+    "title": "Test with noModule",
+    "version": "1.0"
+  },
+  "paths": {
+    "/foo": {
+      "get": {
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string"
+                }
+              },
+              "text/plain": {}
+            }
+          }
+        }
+      }
+    }
+  }
+}

test/noModule.spec.ts

@@ -0,0 +1,28 @@
+import { OpenAPIObject } from 'openapi3-ts';
+import { NgOpenApiGen } from '../lib/ng-openapi-gen';
+import options from './noModule.config.json';
+import templatesSpec from './noModule.json';
+import { NamedExport, TypescriptParser } from 'typescript-parser';
+
+describe('Generation tests with index and no ApiModule', () => {
+  const gen = new NgOpenApiGen(templatesSpec as OpenAPIObject, options);
+
+  beforeAll(() => {
+    gen.generate();
+  });
+
+  it('index file', done => {
+    const ref = gen.models.get('InlineObject');
+    const ts = gen.templates.apply('index', ref);
+    const parser = new TypescriptParser();
+    parser.parseSource(ts).then(ast => {
+      expect(ast.exports.length).withContext('Has the correct number of exports').toBe(4);
+      expect(ast.exports.some((ex: NamedExport) => ex.from === './api-configuration')).withContext('Has an ApiConfiguration export').toBeDefined();
+      expect(ast.exports.some((ex: NamedExport) => ex.from === './base-service')).withContext('Has a BaseService export').toBeDefined();
+      expect(ast.exports.some((ex: NamedExport) => ex.from === './request-builder')).withContext('Has a RequestBuilder export').toBeDefined();
+      expect(ast.exports.some((ex: NamedExport) => ex.from === './strict-http-response')).withContext('Has a StrictHttpResponse export').toBeDefined();
+      done();
+    });
+  });
+
+});