prettier (blocked on prettier/issues/648) (fix #45)

bcherny · bcherny · commit f59a8378c6c2 · 2017-11-09T12:48:57.000-08:00
diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md
@@ -23,3 +23,7 @@ Optimizes the IR to produce concise and readable TypeScript in step (6).
 #### 6. Generator
 
 Converts the intermediate respresentation to TypeScript code.
+
+#### 7. Formatter
+
+Formats the code so it is properly indented, etc.
diff --git a/README.md b/README.md
@@ -86,11 +86,7 @@ See [server demo](example) and [browser demo](https://github.com/bcherny/json-sc
 | cwd       | string      | Root directory for resolving `$ref`s |
 | declareExternallyReferenced | boolean | Declare external schemas referenced via `$ref`? |
 | enableConstEnums | boolean | Prepend enums with `const`? |
-| enableTrailingSemicolonForTypes | boolean | |
-| enableTrailingSemicolonForEnums | boolean | |
-| enableTrailingSemicolonForInterfaceProperties | boolean | |
-| enableTrailingSemicolonForInterfaces | boolean | |
-| indentWith | string | Tabs or spaces? |
+| style | object | A [Prettier](https://prettier.io/docs/en/options.html) configuration |
 
 ## CLI
 
diff --git a/package.json b/package.json
@@ -50,7 +50,8 @@
     "json-stringify-safe": "^5.0.1",
     "lodash": "^4.17.4",
     "minimist": "^1.2.0",
-    "mz": "^2.7.0",
+    "mz": "^2.6.0",
+    "prettier": "^1.7.0",
     "stdin": "0.0.1"
   },
   "devDependencies": {
@@ -59,10 +60,11 @@
     "@types/lodash": "4.14.74",
     "@types/minimist": "^1.2.0",
     "@types/mz": "0.0.31",
-    "@types/node": "^8.0.28",
-    "ava": "^0.22.0",
-    "browserify": "^14.4.0",
-    "concurrently": "^3.5.0",
+    "@types/node": "^7.0.13",
+    "@types/prettier": "^1.6.1",
+    "ava": "^0.19.1",
+    "browserify": "^14.3.0",
+    "concurrently": "^3.4.0",
     "fast-diff": "^1.1.1",
     "shx": "^0.2.2",
     "table-layout": "^0.4.2",
diff --git a/src/formatter.ts b/src/formatter.ts
@@ -0,0 +1,6 @@
+import { format as prettify } from 'prettier'
+import { DEFAULT_OPTIONS, Options } from './'
+
+export function format(code: string, options: Options = DEFAULT_OPTIONS): string {
+  return prettify(code, { parser: 'typescript', ...options.style })
+}
diff --git a/src/generator.ts b/src/generator.ts
@@ -127,7 +127,7 @@ function declareNamedTypes(
   return type
 }
 
-function generateType(ast: AST, options: Options, indentDepth: number): string {
+function generateType(ast: AST, options: Options): string {
   log(whiteBright.bgMagenta('generator'), ast)
 
   if (hasStandaloneName(ast)) {
@@ -137,94 +137,84 @@ function generateType(ast: AST, options: Options, indentDepth: number): string {
   switch (ast.type) {
     case 'ANY': return 'any'
     case 'ARRAY': return (() => {
-      let type = generateType(ast.params, options, indentDepth + 1)
+      let type = generateType(ast.params, options)
       return type.endsWith('"') ? '(' + type + ')[]' : type + '[]'
     })()
     case 'BOOLEAN': return 'boolean'
-    case 'INTERFACE': return generateInterface(ast, options, indentDepth + 1)
-    case 'INTERSECTION': return generateSetOperation(ast, options, indentDepth)
+    case 'INTERFACE': return generateInterface(ast, options)
+    case 'INTERSECTION': return generateSetOperation(ast, options)
     case 'LITERAL': return JSON.stringify(ast.params)
     case 'NUMBER': return 'number'
     case 'NULL': return 'null'
     case 'OBJECT': return 'object'
     case 'REFERENCE': return ast.params
     case 'STRING': return 'string'
     case 'TUPLE': return '['
-      + ast.params.map(_ => generateType(_, options, indentDepth + 1)).join(', ')
+      + ast.params.map(_ => generateType(_, options)).join(', ')
       + ']'
-    case 'UNION': return generateSetOperation(ast, options, indentDepth)
+    case 'UNION': return generateSetOperation(ast, options)
   }
 }
 
 /**
  * Generate a Union or Intersection
  */
-function generateSetOperation(ast: TIntersection | TUnion, options: Options, indentDepth: number): string {
-  const members = (ast as TUnion).params.map(_ => generateType(_, options, indentDepth))
+function generateSetOperation(ast: TIntersection | TUnion, options: Options): string {
+  const members = (ast as TUnion).params.map(_ => generateType(_, options))
   const separator = ast.type === 'UNION' ? '|' : '&'
   return members.length === 1 ? members[0] : '(' + members.join(' ' + separator + ' ') + ')'
 }
 
 function generateInterface(
   ast: TInterface,
-  options: Options,
-  indentDepth: number
+  options: Options
 ): string {
   return `{`
     + '\n'
-    + options.indentWith.repeat(indentDepth)
     + ast.params
-        .map(({ isRequired, keyName, ast }) => [isRequired, keyName, ast, generateType(ast, options, indentDepth)] as [boolean, string, AST, string])
+        .map(({ isRequired, keyName, ast }) => [isRequired, keyName, ast, generateType(ast, options)] as [boolean, string, AST, string])
         .map(([isRequired, keyName, ast, type]) =>
-          (hasComment(ast) && !ast.standaloneName ? generateComment(ast.comment, options, indentDepth + 1) + '\n' : '')
-            + options.indentWith
+          (hasComment(ast) && !ast.standaloneName ? generateComment(ast.comment) + '\n' : '')
             + escapeKeyName(keyName)
             + (isRequired ? '' : '?')
             + ': '
             + (hasStandaloneName(ast) ? toSafeString(type) : type)
-            + (options.enableTrailingSemicolonForInterfaceProperties ? ';' : '')
         )
-        .join('\n' + options.indentWith.repeat(indentDepth))
+        .join('\n')
     + '\n'
-    + options.indentWith.repeat(indentDepth) + '}'
+    + '}'
 }
 
-function generateComment(comment: string, options: Options, indentDepth: number): string {
-  return options.indentWith.repeat(indentDepth)
-    + [
-        '/**',
-        ...comment.split('\n').map(_ => ' * ' + _),
-        ' */'
-      ].join('\n' + options.indentWith.repeat(indentDepth))
+function generateComment(comment: string): string {
+  return [
+    '/**',
+    ...comment.split('\n').map(_ => ' * ' + _),
+    ' */'
+  ].join('\n')
 }
 
 function generateStandaloneEnum(ast: TEnum, options: Options): string {
-  return (hasComment(ast) ? generateComment(ast.comment, options, 0) + '\n' : '')
+  return (hasComment(ast) ? generateComment(ast.comment) + '\n' : '')
     + 'export ' + (options.enableConstEnums ? 'const ' : '') + `enum ${toSafeString(ast.standaloneName)} {`
     + '\n'
     + ast.params.map(({ ast, keyName }) =>
-        options.indentWith
-          + keyName
-          + ' = '
-          + generateType(ast, options, 0)
+        keyName + ' = ' + generateType(ast, options)
       )
       .join(',\n')
     + '\n'
     + '}'
 }
 
 function generateStandaloneInterface(ast: TNamedInterface, options: Options): string {
-  return (hasComment(ast) ? generateComment(ast.comment, options, 0) + '\n' : '')
+  return (hasComment(ast) ? generateComment(ast.comment) + '\n' : '')
     + `export interface ${toSafeString(ast.standaloneName)} `
     + (ast.superTypes.length > 0 ? `extends ${ast.superTypes.map(superType => toSafeString(superType.standaloneName)).join(', ')} ` : '')
-    + generateInterface(ast, options, 0)
-    + (options.enableTrailingSemicolonForInterfaces ? ';' : '')
+    + generateInterface(ast, options)
 }
 
 function generateStandaloneType(ast: ASTWithStandaloneName, options: Options): string {
-  return (hasComment(ast) ? generateComment(ast.comment, options, 0) + '\n' : '')
-    +  `export type ${toSafeString(ast.standaloneName)} = ${generateType(omit<ASTWithStandaloneName, AST>(ast, 'standaloneName'), options, 0)}`
-    + (options.enableTrailingSemicolonForTypes ? ';' : '')
+  return (hasComment(ast) ? generateComment(ast.comment) + '\n' : '')
+    +  `export type ${toSafeString(ast.standaloneName)} = ${generateType(omit<ASTWithStandaloneName, AST>(ast, 'standaloneName'), options)}`
 }
 
 function escapeKeyName(keyName: string): string {
diff --git a/src/index.ts b/src/index.ts
@@ -1,7 +1,9 @@
 import { readFileSync } from 'fs'
 import { JSONSchema4 } from 'json-schema'
-import { endsWith } from 'lodash'
+import { endsWith, merge } from 'lodash'
 import { dirname } from 'path'
+import { Options as PrettierOptions } from 'prettier'
+import { format } from './formatter'
 import { generate } from './generator'
 import { normalize } from './normalizer'
 import { optimize } from './optimizer'
@@ -17,11 +19,7 @@ export interface Options {
   cwd: string
   declareExternallyReferenced: boolean
   enableConstEnums: boolean
-  enableTrailingSemicolonForTypes: boolean
-  enableTrailingSemicolonForEnums: boolean
-  enableTrailingSemicolonForInterfaceProperties: boolean
-  enableTrailingSemicolonForInterfaces: boolean
-  indentWith: string
+  style: PrettierOptions
 }
 
 export const DEFAULT_OPTIONS: Options = {
@@ -33,11 +31,15 @@ export const DEFAULT_OPTIONS: Options = {
   cwd: process.cwd(),
   declareExternallyReferenced: true,
   enableConstEnums: true, // by default, avoid generating code
-  enableTrailingSemicolonForEnums: false,
-  enableTrailingSemicolonForInterfaceProperties: true,
-  enableTrailingSemicolonForInterfaces: false,
-  enableTrailingSemicolonForTypes: true,
-  indentWith: '  '
+  style: {
+    bracketSpacing: false,
+    printWidth: 120,
+    semi: true,
+    singleQuote: false,
+    tabWidth: 2,
+    trailingComma: 'none',
+    useTabs: false
+  }
 }
 
 export function compileFromFile(
@@ -65,7 +67,7 @@ export async function compile(
   options: Partial<Options> = {}
 ): Promise<string> {
 
-  const _options = { ...DEFAULT_OPTIONS, ...options }
+  const _options = merge({}, DEFAULT_OPTIONS, options)
 
   const errors = validate(schema, name)
   if (errors.length) {
@@ -78,10 +80,10 @@ export async function compile(
     _options.cwd += '/'
   }
 
-  return generate(
+  return format(generate(
     optimize(parse(await dereference(normalize(schema, name), _options.cwd))),
     _options
-  )
+  ))
 }
 
 export class ValidationError extends Error {}
diff --git a/yarn.lock b/yarn.lock
@@ -44,6 +44,10 @@
   dependencies:
     arrify "^1.0.1"
 
+"@types/babel-types@*":
+  version "6.25.1"
+  resolved "https://registry.yarnpkg.com/@types/babel-types/-/babel-types-6.25.1.tgz#ce8f126a4403e11e1b0033a424f11638afac7889"
+
 "@types/cli-color@^0.3.29":
   version "0.3.29"
   resolved "https://registry.yarnpkg.com/@types/cli-color/-/cli-color-0.3.29.tgz#c83a71fe02c8c7e1ccec048dd6a2458d1f6c96ea"
@@ -72,6 +76,16 @@
   version "8.0.28"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-8.0.28.tgz#86206716f8d9251cf41692e384264cbd7058ad60"
 
+"@types/node@^7.0.13":
+  version "7.0.43"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-7.0.43.tgz#a187e08495a075f200ca946079c914e1a5fe962c"
+
+"@types/prettier@^1.6.1":
+  version "1.6.1"
+  resolved "https://registry.yarnpkg.com/@types/prettier/-/prettier-1.6.1.tgz#b92e866b098e5d37b2d4dd2402291a8eb6072bf8"
+  dependencies:
+    "@types/babel-types" "*"
+
 JSONStream@^1.0.3:
   version "1.3.1"
   resolved "https://registry.yarnpkg.com/JSONStream/-/JSONStream-1.3.1.tgz#707f761e01dae9e16f1bcf93703b78c70966579a"
@@ -2922,6 +2936,16 @@ preserve@^0.2.0:
   version "0.2.0"
   resolved "https://registry.yarnpkg.com/preserve/-/preserve-0.2.0.tgz#815ed1f6ebc65926f865b310c0713bcb3315ce4b"
 
+prettier@^1.7.0:
+  version "1.7.0"
+  resolved "https://registry.yarnpkg.com/prettier/-/prettier-1.7.0.tgz#47481588f41f7c90f63938feb202ac82554e7150"
+
+pretty-format@^19.0.0:
+  version "19.0.0"
+  resolved "https://registry.yarnpkg.com/pretty-format/-/pretty-format-19.0.0.tgz#56530d32acb98a3fa4851c4e2b9d37b420684c84"
+  dependencies:
+    ansi-styles "^3.0.0"
+
 pretty-ms@^0.2.1:
   version "0.2.2"
   resolved "https://registry.yarnpkg.com/pretty-ms/-/pretty-ms-0.2.2.tgz#da879a682ff33a37011046f13d627f67c73b84f6"
