@vkontakte/api-schema-typescript-generator 0.13.0 → 0.14.0

package/src/helpers.ts

@@ -4,6 +4,7 @@ import { capitalizeFirstLetter, trimArray } from './utils';
 import { newLineChar, primitiveTypes, spaceChar } from './constants';
 import { Dictionary } from './types';
 import { consoleLogErrorAndExit } from './log';
+import prettier from 'prettier';
 
 export async function readJSONFile(path: string): Promise<any> {
   const content = await fsPromises.readFile(path, 'utf-8');
@@ -31,16 +32,29 @@ export function prepareBuildDirectory(directoryPath: string) {
 
 export function writeFile(filePath: string, code: string, insertAutoGeneratedNote = true) {
   if (insertAutoGeneratedNote) {
-    code = [
-      '/**',
-      ' * This is auto-generated file, don\'t modify this file manually',
-      ' */',
-      // '/* eslint-disable max-len */',
-      // '/* eslint-disable @typescript-eslint/no-empty-interface */',
-    ].join(newLineChar) + newLineChar.repeat(2) + code.trim();
+    code =
+      [
+        '/**',
+        " * This is auto-generated file, don't modify this file manually",
+        ' */',
+        // '/* eslint-disable max-len */',
+        // '/* eslint-disable @typescript-eslint/no-empty-interface */',
+      ].join(newLineChar) +
+      newLineChar.repeat(2) +
+      code.trim();
   }
 
-  fs.mkdirSync(filePath.replace(path.basename(filePath), ''), { recursive: true });
+  code = prettier.format(code, {
+    semi: true,
+    singleQuote: true,
+    trailingComma: 'all',
+    quoteProps: 'consistent',
+    parser: 'typescript',
+  });
+
+  fs.mkdirSync(filePath.replace(path.basename(filePath), ''), {
+    recursive: true,
+  });
   fs.writeFileSync(filePath, code.trim() + newLineChar);
 }
 
@@ -49,10 +63,13 @@ export function prepareMethodsPattern(methodsPattern: string): Dictionary<boolea
     consoleLogErrorAndExit('methodsPattern is empty. Pass "*" to generate all methods');
   }
 
-  return methodsPattern.replace(/\s+/g, '').split(',').reduce<Dictionary<boolean>>((acc, pattern) => {
-    acc[pattern] = true;
-    return acc;
-  }, {});
+  return methodsPattern
+    .replace(/\s+/g, '')
+    .split(',')
+    .reduce<Dictionary<boolean>>((acc, pattern) => {
+      acc[pattern] = true;
+      return acc;
+    }, {});
 }
 
 export function isMethodNeeded(methodsPattern: Dictionary<boolean>, method: string): boolean {
@@ -77,18 +94,17 @@ export function getMethodSection(methodName: string): string {
 }
 
 export function getInterfaceName(name: string): string {
-  name = name.replace(/\.|(\s+)|_/g, ' ')
+  name = name
+    .replace(/\.|(\s+)|_/g, ' ')
     .split(' ')
-    .map((v) => capitalizeFirstLetter(v)).join('');
+    .map((v) => capitalizeFirstLetter(v))
+    .join('');
 
   return capitalizeFirstLetter(name);
 }
 
 export function getEnumPropertyName(name: string): string {
-  return name.toUpperCase()
-    .replace(/\s+/g, '_')
-    .replace(/-/g, '_')
-    .replace(/\./g, '_');
+  return name.toUpperCase().replace(/\s+/g, '_').replace(/-/g, '_').replace(/\./g, '_');
 }
 
 export function getObjectNameByRef(ref: string): string {
@@ -111,9 +127,10 @@ export function areQuotesNeededForProperty(name: string | number): boolean {
     return false;
   }
 
-  if (/[&]/.test(name)) {
+  if (/[&-]/.test(name)) {
     return true;
   }
+
   return !(/^[a-z_]([a-z0-9_])+$/i.test(name) || /^[a-z_]/i.test(name));
 }
 
@@ -135,10 +152,7 @@ export function joinCommentLines(indent = 2, ...description: Array<string | stri
         ...trimArray((entry || '').trim().split(newLineChar)),
       ];
     } else if (Array.isArray(entry)) {
-      descriptionLines = [
-        ...descriptionLines,
-        ...entry,
-      ];
+      descriptionLines = [...descriptionLines, ...entry];
     }
   });
 
@@ -170,7 +184,7 @@ export function joinOneOfValues(values: Array<string | number>, primitive?: bool
 }
 
 export function formatArrayDepth(value: string, depth: number) {
-  if (value.endsWith('\'') || value.includes('|')) {
+  if (value.endsWith("'") || value.includes('|')) {
     return `Array<${value}>` + '[]'.repeat(depth - 1); // Need decrement depth value because of Array<T> has its own depth
   } else {
     return value + '[]'.repeat(depth);

package/src/index.ts

@@ -11,16 +11,24 @@ const helpMessage = `
 
   ${chalk.greenBright('--help')}          Shows this help.
 
-  ${chalk.greenBright('--schemaDir')}     The relative path to directory with ${chalk.bold('methods.json')}, ${chalk.bold('objects.json')} and ${chalk.bold('responses.json')} files.
+  ${chalk.greenBright('--schemaDir')}     The relative path to directory with ${chalk.bold(
+  'methods.json',
+)}, ${chalk.bold('objects.json')} and ${chalk.bold('responses.json')} files.
 
   ${chalk.greenBright('--outDir')}        The directory where the files will be generated.
                   If you skip this param, script will work in linter mode without emitting files to file system.
-                  ${chalk.bold('Please note')} that this folder will be cleared after starting the generation.
+                  ${chalk.bold(
+                    'Please note',
+                  )} that this folder will be cleared after starting the generation.
 
-  ${chalk.greenBright('--methods')}       List of methods to generate responses and all needed objects.
+  ${chalk.greenBright(
+    '--methods',
+  )}       List of methods to generate responses and all needed objects.
                   Example:
-                  - ${chalk.bold('\'*\'')} - to generate all responses and objects.
-                  - ${chalk.bold('\'messages.*, users.get, groups.isMember\'')} - to generate all methods from messages section, users.get and groups.isMember.
+                  - ${chalk.bold("'*'")} - to generate all responses and objects.
+                  - ${chalk.bold(
+                    "'messages.*, users.get, groups.isMember'",
+                  )} - to generate all methods from messages section, users.get and groups.isMember.
 `;
 
 export async function main() {
@@ -61,6 +69,7 @@ export async function main() {
     methodsDefinitions,
     { definitions: responsesDefinitions },
     { definitions: objectsDefinitions },
+    { errors: errorsDefinitions },
   ] = await Promise.all([
     readJSONFile(path.resolve(schemaDir, 'methods.json')),
     readJSONFile(path.resolve(schemaDir, 'responses.json')),
@@ -91,6 +100,7 @@ export async function main() {
     methodsDefinitions,
     objects: objectsDefinitions,
     responses: responsesDefinitions,
+    errors: errorsDefinitions,
     methodsPattern: methods.join(','),
   });
 

package/src/types/schema.ts

@@ -150,3 +150,10 @@ export interface Response {
   };
   additionalProperties?: boolean;
 }
+
+export interface ErrorInterface {
+  code: number;
+  description: string;
+  $comment?: string;
+  subcodes?: Array<{ $ref: string }>;
+}