Fix array generation, add more robust tests

Author: drwpow

.eslintrc.js

@@ -1,4 +1,5 @@
 module.exports = {
+  parser: '@typescript-eslint/parser',
   extends: ['prettier/react', 'airbnb'],
   plugins: ['prettier', 'import'],
   env: {
@@ -14,5 +15,6 @@ module.exports = {
     'no-underscore-dangle': 0,
     'react/jsx-filename-extension': 0,
     'react/destructuring-assignment': 0,
+    'space-before-function-paren': 0, // let Prettier handle it
   },
 };

README.md

@@ -6,19 +6,31 @@ Convert Swagger files to TypeScript interfaces using Node.js.
 
 💅 Prettifies output with [Prettier][prettier].
 
+| OpenAPI Feature   | TypeScript equivalent |
+| :---------------- | :-------------------: |
+| `type: 'string'`  |       `string`        |
+| `type: 'number'`  |       `number`        |
+| `type: 'integer'` |       `number`        |
+| `allOf`           | `TypeB extends TypeA` |
+| `oneOf`           |   `TypeA \| TypeB`    |
+| `required`        |    (not optional)     |
+
+To compare actual generated output, see the [example](./example) folder.
+
 ## Usage
 
 ### CLI
 
 ```bash
-npx @manifoldco/swagger-to-ts schema.yaml --output schema.ts --namespace OpenAPI
+npx @manifoldco/swagger-to-ts schema.yaml --namespace OpenAPI --output schema.ts
 
 # 🚀 schema.yaml -> schema.ts [2ms]
 ```
 
 This will save a `schema.ts` file in the current folder under the TypeScript
-[namespace][namespace] `OpenAPI`. The CLI can accept YAML or JSON for the
-input file.
+[namespace][namespace] `OpenAPI` (namespaces are required because chances of
+collision among specs is highly likely). The CLI can accept YAML or JSON for
+the input file.
 
 ### Node
 

spec/catalog/v1.yaml renamed to example/input.yaml

@@ -43,7 +43,7 @@ namespace OpenAPI2 {
     features?: ProductIntegrationFeatures;
   }
   export enum UpdateProductBodyIntegrationVersion {
-    V1 = 'v1',
+    V1 = "v1"
   }
   export interface UpdateProduct {
     id: string;
@@ -84,10 +84,10 @@ namespace OpenAPI2 {
     body: RegionBody;
   }
   export enum RegionVersion {
-    Version1 = 1,
+    Version1 = 1
   }
   export enum RegionType {
-    Region = 'region',
+    Region = "region"
   }
   export interface ProviderBody {
     teamId: string;
@@ -104,10 +104,10 @@ namespace OpenAPI2 {
     body: ProviderBody;
   }
   export enum ProviderType {
-    Provider = 'provider',
+    Provider = "provider"
   }
   export enum ProviderVersion {
-    Version1 = 1,
+    Version1 = 1
   }
   export interface ProductListing {
     // When true, everyone can see the product when requested. When false it will
@@ -155,8 +155,8 @@ namespace OpenAPI2 {
     region?: ProductIntegrationFeaturesRegion;
   }
   export enum ProductIntegrationFeaturesRegion {
-    UserSpecified = 'user-specified',
-    Unspecified = 'unspecified',
+    UserSpecified = "user-specified",
+    Unspecified = "unspecified"
   }
   export interface ProductBody {
     providerId: string;
@@ -189,19 +189,19 @@ namespace OpenAPI2 {
     features: ProductIntegrationFeatures;
   }
   export enum ProductBodyIntegrationVersion {
-    V1 = 'v1',
+    V1 = "v1"
   }
   export interface ProductBodyBilling {
     type: ProductBodyBillingType;
     currency: ProductBodyBillingCurrency;
   }
   export enum ProductBodyBillingCurrency {
-    Usd = 'usd',
+    Usd = "usd"
   }
   export enum ProductBodyBillingType {
-    MonthlyProrated = 'monthly-prorated',
-    MonthlyAnniversary = 'monthly-anniversary',
-    AnnualAnniversary = 'annual-anniversary',
+    MonthlyProrated = "monthly-prorated",
+    MonthlyAnniversary = "monthly-anniversary",
+    AnnualAnniversary = "annual-anniversary"
   }
   export interface ProductBodyTerms {
     url?: string;
@@ -214,10 +214,10 @@ namespace OpenAPI2 {
     body: ProductBody;
   }
   export enum ProductType {
-    Product = 'product',
+    Product = "product"
   }
   export enum ProductVersion {
-    Version1 = 1,
+    Version1 = 1
   }
   export interface PlanBody {
     providerId: string;
@@ -244,10 +244,10 @@ namespace OpenAPI2 {
     body: PlanBody;
   }
   export enum PlanType {
-    Plan = 'plan',
+    Plan = "plan"
   }
   export enum PlanVersion {
-    Version1 = 1,
+    Version1 = 1
   }
   export interface FeatureValueDetails {
     label: string;
@@ -299,9 +299,9 @@ namespace OpenAPI2 {
     values?: FeatureValueDetails[];
   }
   export enum FeatureTypeType {
-    Boolean = 'boolean',
-    String = 'string',
-    Number = 'number',
+    Boolean = "boolean",
+    String = "string",
+    Number = "number"
   }
   export interface FeatureNumericRange {
     // Defines the end of the range ( inclusive ), from the previous, or 0;
@@ -338,10 +338,10 @@ namespace OpenAPI2 {
     provider: Provider;
   }
   export enum ExpandedProductType {
-    Product = 'product',
+    Product = "product"
   }
   export enum ExpandedProductVersion {
-    Version1 = 1,
+    Version1 = 1
   }
   export interface ExpandedPlanBody extends PlanBody {
     // An array of feature definitions for the plan, as defined on the Product.
@@ -360,10 +360,10 @@ namespace OpenAPI2 {
     body: ExpandedPlanBody;
   }
   export enum ExpandedPlanType {
-    Plan = 'plan',
+    Plan = "plan"
   }
   export enum ExpandedPlanVersion {
-    Version1 = 1,
+    Version1 = 1
   }
   export interface ExpandedFeature extends FeatureType {
     // The string value set for the feature on the plan, this should only be used if the value property is null.

types/catalog/v1.ts renamed to example/output.ts

@@ -1,6 +1,6 @@
 {
   "name": "@manifoldco/swagger-to-ts",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Generate TypeScript types from Swagger OpenAPI specs",
   "main": "dist/cjs",
   "engines": {
@@ -34,10 +34,11 @@
     "build": "node scripts/build",
     "pregenerate": "npm run build",
     "generate": "node scripts/generate",
-    "lint:js": "eslint --ignore-path .gitignore --ext .js src",
+    "lint:js": "eslint --ignore-path .gitignore --ext .js,.ts src",
     "prepublish": "npm run build",
     "pretest": "npm run build",
-    "test": "jest"
+    "test": "jest",
+    "test:coverage": "jest --coverage"
   },
   "dependencies": {
     "chalk": "^2.4.2",
@@ -51,6 +52,7 @@
     "@types/jest": "^23.3.13",
     "@types/js-yaml": "^3.12.0",
     "@types/prettier": "^1.15.2",
+    "@typescript-eslint/parser": "^1.1.1",
     "eslint": "^5.12.1",
     "eslint-config-airbnb": "^17.1.0",
     "eslint-config-prettier": "^2.10.0",

package-lock.json

@@ -1,31 +1,11 @@
-const { resolve, sep } = require('path');
+const { resolve } = require('path');
 const { exec } = require('child_process');
-const glob = require('glob');
 
 const swaggerToTS = resolve(__dirname, '..', 'bin', 'cli.js');
 
 // Settings
-const INPUT_DIR = 'spec';
-const OUTPUT_DIR = 'types';
+const INPUT = resolve(__dirname, '..', 'example', 'input.yaml');
+const OUTPUT = resolve(__dirname, '..', 'example', 'output.ts');
 
-// Methods
-function rename(filename) {
-  return filename
-    .replace(`${sep}${INPUT_DIR}${sep}`, `${sep}${OUTPUT_DIR}${sep}`)
-    .replace(/\.ya?ml$/i, '.ts');
-}
-
-// Initialize
-glob('./spec/**/*.yaml', { root: resolve(__dirname, '..') }, (error, matches) => {
-  if (error) {
-    console.error('No files found');
-    return;
-  }
-
-  if (typeof matches === 'string') {
-    exec(`node ${swaggerToTS} ${matches} -o ${rename(matches)}`);
-    return;
-  }
-
-  matches.forEach(file => exec(`node ${swaggerToTS} ${file} -o ${rename(file)}`));
-});
+// Generate
+exec(`node ${swaggerToTS} ${INPUT} -o ${OUTPUT}`);

package.json

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