Add missing namespace option to README, alter API

Author: drwpow

README.md

@@ -29,18 +29,19 @@ npm i --save-dev @manifoldco/swagger-to-ts
 ```js
 const swaggerToTS = require('@manifoldco/swagger-to-ts');
 
-graphqlGen(spec, [options]);
+swaggerToTS(spec, [options]);
 ```
 
 `spec` must be in JSON format. For an example of converting YAML to JSON, see
 the [generate.js](./scripts/generate.js) script.
 
 ### Options
 
-| Name      | Default  | Description                                                |
-| :-------- | :------- | :--------------------------------------------------------- |
-| `output`  | (stdout) | Where should the output file be saved?                     |
-| `swagger` | `2`      | Which Swagger version to use. Currently only supports `2`. |
+| Name        | Default    | Description                                                                                          |
+| :---------- | :--------- | :--------------------------------------------------------------------------------------------------- |
+| `output`    | (stdout)   | Where should the output file be saved?                                                               |
+| `namespace` | `OpenAPI2` | How should the output be namespaced? (namespacing is enforced as there’s a high chance of collision) |
+| `swagger`   | `2`        | Which Swagger version to use. Currently only supports `2`.                                           |
 
 [namespace]: https://www.typescriptlang.org/docs/handbook/namespaces.html
 [prettier]: https://npmjs.com/prettier

bin/cli.js

@@ -69,7 +69,7 @@ try {
   );
 }
 
-const result = swaggerToTS(spec, cli.flags.namespace, cli.flags);
+const result = swaggerToTS(spec, cli.flags);
 
 // Write to file if specifying output
 if (cli.flags.output) {
@@ -81,11 +81,7 @@ if (cli.flags.output) {
 
   const timeEnd = process.hrtime(timeStart);
   const time = timeEnd[0] + Math.round(timeEnd[1] / 1e6);
-  console.log(
-    chalk.green(
-      `🚀 ${cli.input[0]} -> ${chalk.bold(cli.flags.output)} [${time}ms]`
-    )
-  );
+  console.log(chalk.green(`🚀 ${cli.input[0]} -> ${chalk.bold(cli.flags.output)} [${time}ms]`));
   return;
 }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manifoldco/swagger-to-ts",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Generate TypeScript types from Swagger OpenAPI specs",
   "main": "dist/cjs",
   "engines": {

scripts/build.js

@@ -20,13 +20,13 @@ if (!existsSync(output)) {
 // Build JS
 const build = format =>
   rollup({
-    input: `./src/index.ts`,
+    input: './src/index.ts',
     plugins: PLUGINS[format],
   }).then(bundle =>
     bundle.write({
       file: resolve(output, `${format}.js`),
       format,
-      name: 'graphqlGen',
+      name: 'SwaggerToTS',
     })
   );
 

src/index.ts

@@ -1,12 +1,13 @@
 import swagger2, { Swagger2 } from './swagger-2';
 
-export default (spec: Swagger2, namespace?: string, options?: { version?: number }) => {
+export default (spec: Swagger2, options?: { namespace?: string; version?: number }) => {
   const version = (options && options.version) || 2;
+  const namespace = (options && options.namespace) || `OpenAPI${version}`;
 
   if (version === 1 || version === 3) {
     console.error('That version is not supported');
     return;
   }
 
-  return swagger2(spec, namespace || `OpenAPI${version}`);
+  return swagger2(spec, namespace);
 };