Use single quote literals in output for tslint

Author: darcyparker

src/TsTypes.ts

@@ -107,7 +107,13 @@ export namespace TsType {
   export class Literal extends TsTypeBase {
     constructor(private value: any) { super() }
     _type() {
-      return JSON.stringify(this.value)
+      // if Literal is a string, format result with single quoted string literals
+      var stringValue = JSON.stringify(this.value)
+      const lastPos = stringValue.length - 1
+      if (stringValue.charAt(0) === '"' && stringValue.charAt(lastPos) === '"') {
+        stringValue = `'${stringValue.substring(1, lastPos).replace(/'/g,'\\\'')}'`
+      }
+      return stringValue
     }
   }
 

test/cases/anyOf.ts

@@ -41,7 +41,7 @@ export var types = `export interface Foo {
   b?: number;
 }
 export interface Bar {
-  a?: "a" | "b" | "c";
+  a?: 'a' | 'b' | 'c';
   [k: string]: any;
 }
 export interface Baz {

test/cases/enum.ts

@@ -9,6 +9,10 @@ export var schema = {
     "impliedStringEnum": {
       "enum": ["a", "b", "c"]
     },
+    "literalWithSingleQuote": {
+      "type": "string",
+      "enum": ["Some 'string' with inner single quote", "b", "c"]
+    },
     "booleanEnum": {
       "type" : "boolean",
       "enum": [ true ]
@@ -40,7 +44,7 @@ export var schema = {
       "enum": [-20.1, null, "foo", false]
     }
   },
-  "required": ["stringEnum", "impliedStringEnum", "booleanEnum", "impliedBooleanEnum", "integerEnum", "impliedIntegerEnum", "impliedNamedIntegerEnum"],
+  "required": ["stringEnum", "impliedStringEnum", "literalWithSingleQuote", "booleanEnum", "impliedBooleanEnum", "integerEnum", "impliedIntegerEnum", "impliedNamedIntegerEnum"],
   "additionalProperties": false
 }
 
@@ -61,16 +65,17 @@ export${useConstEnums ? ' const ' : ' '}enum ImpliedNamedIntegerEnum {
   Six = 6
 }
 export interface Enum {
-  stringEnum: "a" | "b" | "c";
-  impliedStringEnum: "a" | "b" | "c";
+  stringEnum: 'a' | 'b' | 'c';
+  impliedStringEnum: 'a' | 'b' | 'c';
+  literalWithSingleQuote: 'Some \\\'string\\\' with inner single quote' | 'b' | 'c';
   booleanEnum: true;
   impliedBooleanEnum: true;
   integerEnum: -1 | 0 | 1;
   impliedIntegerEnum: -1 | 0 | 1;
   numberEnum?: -1.1 | 0 | 1.2;
   namedIntegerEnum?: NamedIntegerEnum;
   impliedNamedIntegerEnum: ImpliedNamedIntegerEnum;
-  impliedHeterogeneousEnum?: -20.1 | null | "foo" | false;
+  impliedHeterogeneousEnum?: -20.1 | null | 'foo' | false;
 }`
   }
 })

test/cases/json-schema.ts

@@ -158,7 +158,7 @@ export var configurations = [
 export type PositiveIntegerDefault0 = PositiveInteger;
 export type SchemaArray = HttpJsonSchemaOrgDraft04Schema[];
 export type StringArray = string[];
-export type SimpleTypes = "array" | "boolean" | "integer" | "null" | "number" | "object" | "string";
+export type SimpleTypes = 'array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string';
 /** Core schema meta-schema */
 export interface HttpJsonSchemaOrgDraft04Schema {
   id?: string;
@@ -208,7 +208,7 @@ export interface HttpJsonSchemaOrgDraft04Schema {
     settings: {
         declareSimpleType: false
     },
-    types:`export type SimpleTypes = "array" | "boolean" | "integer" | "null" | "number" | "object" | "string";
+    types:`export type SimpleTypes = 'array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string';
 /** Core schema meta-schema */
 export interface HttpJsonSchemaOrgDraft04Schema {
   id?: string;

test/cases/root-anyOf.ts

@@ -32,7 +32,7 @@ export var types = `export interface Foo {
   b?: number;
 }
 export interface Bar {
-  a?: "a" | "b" | "c";
+  a?: 'a' | 'b' | 'c';
   [k: string]: any;
 }
 export interface Baz {

test/test.ts

@@ -1,8 +1,27 @@
 import { compile } from '../src/index'
+import { TsType } from '../src/TsTypes'
 import test from 'ava'
 import * as fs from 'fs'
 import * as path from 'path'
 
+test('literal strings use single quotes for tslint', t => {
+  const someLiteralString: string = 'a'
+  t.is((new TsType.Literal(someLiteralString))._type(), `'${someLiteralString}'`)
+})
+test('literal number is not wrapped in quotes', t => {
+  const aNumber: number = -1.2
+  t.is((new TsType.Literal(aNumber))._type(), aNumber.toString())
+})
+test('literal boolean is not wrapped in quotes', t => {
+  t.is((new TsType.Literal(true))._type(), 'true')
+})
+test('literal null is not wrapped in quotes', t => {
+  t.is((new TsType.Literal(null))._type(), 'null')
+})
+test('literal object is not wrapped in quotes', t => {
+  t.is((new TsType.Literal({}))._type(), '{}')
+})
+
 var modules = new Map<string, any>()
 var dir = __dirname + '/cases'
 fs.readdirSync(dir).forEach(function(moduleName) {