Fixed lint errors

Author: siamakp-elastic

compiler/src/steps/add-examples.ts

@@ -24,29 +24,25 @@ import * as fs from 'fs'
 import * as yaml from 'js-yaml'
 
 /**
- * Scan the API folders in the specification to locate examples 
+ * Scan the API folders in the specification to locate examples
  * for all the API endpoints. Then add the examples to the model.
  */
 export default class ExamplesProcessor {
-
   specsFolder: string
 
-  constructor (specsFolder: string)
-  {
+  constructor (specsFolder: string) {
     this.specsFolder = specsFolder
   }
 
-  // Add request and response examples for all the endpoints in the model.  
+  // Add request and response examples for all the endpoints in the model.
   // Note that the 'jsonSpec' is a parameter that is passed to a 'Step'.
   // We don't need that parameter for the the 'addExamples' functionality.
   async addExamples (model: model.Model, jsonSpec: Map<string, JsonSpec>): Promise<model.Model> {
     const requestExamplesProcessor = new RequestExamplesProcessor(model, this.specsFolder)
     const responseExamplesProcessor = new ResponseExamplesProcessor(model, this.specsFolder)
     for (const endpoint of model.endpoints) {
-      if (endpoint.request != null) 
-        requestExamplesProcessor.addExamples(endpoint.request)
-      if (endpoint.response != null) 
-        responseExamplesProcessor.addExamples(endpoint.response)
+      if (endpoint.request != null) { requestExamplesProcessor.addExamples(endpoint.request) }
+      if (endpoint.response != null) { responseExamplesProcessor.addExamples(endpoint.response) }
     }
     return model
   }
@@ -65,18 +61,18 @@ class BaseExamplesProcessor {
   }
 
   // Log a 'warning' message.
-  warning(message: string): void {
-    console.warn("=== [ExamplesProcessor]: " + message)
+  warning (message: string): void {
+    console.warn('=== [ExamplesProcessor]: ' + message)
   }
 
-  // Get all the subfolders in a folder.  
+  // Get all the subfolders in a folder.
   getSubfolders (folderPath: string): string[] {
     const entries = fs.readdirSync(folderPath, { withFileTypes: true })
     const folders = entries
       .filter(entry => entry.isDirectory())
       .map(entry => entry.name)
     return folders
-  } 
+  }
 
   // Get all the files in a folder.
   getFilesInFolder (folderPath: string): string[] {
@@ -90,39 +86,41 @@ class BaseExamplesProcessor {
   // Check if a path exists and is a directory.
   isDirectory (path: string): boolean {
     try {
-      const stats = fs.statSync(path);
-      return stats.isDirectory();
+      const stats = fs.statSync(path)
+      return stats.isDirectory()
     } catch (error) {
       if (error.code === 'ENOENT') {
         // Path does not exist
-        return false;
+        return false
       } else {
         // Other error, rethrow
-        throw error;
+        throw error
       }
     }
   }
 
   // Given the spec location of a request or response,
   // return the path to the examples folder for that
   // request or response.
-  getExamplesFolder (specLocation: string): string | undefined { 
+  getExamplesFolder (specLocation: string): string | undefined {
     const specDir = path.dirname(specLocation)
     const specPath = path.join(this.specsFolder, specDir)
-    const examplesFolder =  path.join(specPath, "examples") 
-    if (this.isDirectory(examplesFolder)) 
-      return examplesFolder 
+    const examplesFolder = path.join(specPath, 'examples')
+    if (this.isDirectory(examplesFolder)) {
+      return examplesFolder
+    }
     return undefined
   }
 
   // Given an examples request or response folder, return all the
   // valid example files in that folder.
   getExampleFiles (folder: string): string[] {
-    if (!this.isDirectory(folder)) 
+    if (!this.isDirectory(folder)) {
       return []
-  // Currently we only allow YAML example files.
+    }
+    // Currently we only allow YAML example files.
     const exampleFiles = this.getFilesInFolder(folder)
-        .filter(file => file.endsWith('.yml') || file.endsWith('.yaml'))
+      .filter(file => file.endsWith('.yml') || file.endsWith('.yaml'))
     if (exampleFiles.length === 0) {
       this.warning(`No example files found in ${folder}`)
       return []
@@ -132,34 +130,33 @@ class BaseExamplesProcessor {
 
   // Look up all the example files in a folder. Use the filename without extension
   // as the name of the example, and the YAML content as the example value.
-  // Return a map of example names to example values.  
-  getExampleMap(folder: string): Map<string, model.Example> {
+  // Return a map of example names to example values.
+  getExampleMap (folder: string): Map<string, model.Example> {
     const exampleFiles = this.getExampleFiles(folder)
     const examples = new Map<string, model.Example>()
     for (const fileName of exampleFiles) {
-      const filePath = path.join(folder, fileName) 
+      const filePath = path.join(folder, fileName)
       const exampleFileContent = fs.readFileSync(filePath, 'utf8')
       const exampleName = path.basename(fileName, path.extname(fileName))
       const example: model.Example = yaml.load(exampleFileContent)
-      // Some of the example files set their 'value' as a JSON string, 
+      // Some of the example files set their 'value' as a JSON string,
       // and some files set their 'value' as an object. For consistency,
       // if the value is not a JSON string, convert it to a JSON string.
       if (typeof example.value !== 'string') {
         // Convert to prettified JSON string
-        example.value = JSON.stringify(example.value, null, 2)  
-      } 
+        example.value = JSON.stringify(example.value, null, 2)
+      }
       examples[exampleName] = example
     }
     return examples
-  } 
+  }
 }
 
 /*
   * Class to add the examples for an API request
   */
 class RequestExamplesProcessor extends BaseExamplesProcessor {
-
-  // Traverse all the types in the model to find a type that is 
+  // Traverse all the types in the model to find a type that is
   // of type 'request' and has the same name and namespace as the request.
   getRequestDefinition (model: model.Model, request: model.TypeName): model.Request {
     for (const type of model.types) {
@@ -174,32 +171,34 @@ class RequestExamplesProcessor extends BaseExamplesProcessor {
 
   // Given the spec location, return the request examples folder, if it exists.
   getExamplesRequestSubfolder (examplesSubfolder: string): string | undefined {
-    const subFolder =  path.join(examplesSubfolder, "request") 
-    if (this.isDirectory(subFolder)) 
+    const subFolder = path.join(examplesSubfolder, 'request')
+    if (this.isDirectory(subFolder)) {
       return subFolder
+    }
     return undefined
   }
 
   // Find all the request examples for this request and add them to the model.
   addExamples (request: model.TypeName): void {
     const requestDefinition = this.getRequestDefinition(this.model, request)
     const examplesFolder = this.getExamplesFolder(requestDefinition.specLocation)
-    if (!examplesFolder) 
+    if (examplesFolder === undefined) {
       return
-     // Get the request examples subfolder.
+    }
+    // Get the request examples subfolder.
     const examplesRequestSubfolder = this.getExamplesRequestSubfolder(examplesFolder)
     // If there is an examples/request folder, add the request examples to the model.
-    if (examplesRequestSubfolder)
+    if (examplesRequestSubfolder !== undefined) {
       requestDefinition.examples = this.getExampleMap(examplesRequestSubfolder)
+    }
   }
 }
 
 /*
   * Class to add the examples for an API response
   */
 class ResponseExamplesProcessor extends BaseExamplesProcessor {
-
-  // Traverse all the types in the model to find a type that is 
+  // Traverse all the types in the model to find a type that is
   // of type 'response' and has the same name and namespace as the response.
   getResponseDefinition (model: model.Model, response: model.TypeName): model.Response {
     for (const type of model.types) {
@@ -209,51 +208,54 @@ class ResponseExamplesProcessor extends BaseExamplesProcessor {
         }
       }
     }
-    throw new Error(`Can't find the request definiton for ${response.namespace}.${response.name}`)
+    throw new Error(`Can't find the response definiton for ${response.namespace}.${response.name}`)
   }
 
   // Given the spec location, return the response example folders if they exists.
   // A response example folder can be of either of these forms:
   //     response
   //     {nnn}_response
   // Where {nnn} is the HTTP response code. If the folder is named 'response',
-  // assume that the response code is 200, otherwise pick up the response code 
+  // assume that the response code is 200, otherwise pick up the response code
   // from the folder name.
-  // Return a map of status code to the folder path.  
+  // Return a map of status code to the folder path.
   getExamplesResponseSubfolderMap (examplesSubfolder: string): Map<string, string> | undefined {
     const subfolders = this.getSubfolders(examplesSubfolder)
     // If we have a "response" subfolder, stop there and return.
-    // We should not have a mix of response and {nnn}_response folders.  
-    if ("response" in subfolders) {
-      const response_subfolder =  path.join(examplesSubfolder, "response") 
-      return new Map([["200", response_subfolder]])
+    // We should not have a mix of response and {nnn}_response folders.
+    if ('response' in subfolders) {
+      const responseSubfolder = path.join(examplesSubfolder, 'response')
+      return new Map([['200', responseSubfolder]])
     }
     // Look for subfolders of the format '{nnn}_response'.
-    const rspSubfolders = subfolders.filter(folder => folder.endsWith("_response"))
+    const rspSubfolders = subfolders.filter(folder => folder.endsWith('_response'))
     const responseTypeMap = new Map<string, string>()
     for (const rspSubfolder of rspSubfolders) {
       const match = rspSubfolder.match(/^([0-9]{3})_response$/)
-      if (!match) 
+      if (match == null) {
         throw new Error(`Unexpected response folder: ${rspSubfolder}`)
+      }
       const statusCode = match[1]
       const responseSubfolder = path.join(examplesSubfolder, rspSubfolder)
-      responseTypeMap.set(statusCode, responseSubfolder)  
+      responseTypeMap.set(statusCode, responseSubfolder)
     }
     return responseTypeMap
   }
 
   // Find all the response examples for this request and add them to the model.
   addExamples (response: model.TypeName): void {
     const responseDefinition = this.getResponseDefinition(this.model, response)
-    const examplesFolder =  this.getExamplesFolder(responseDefinition.specLocation)
-    if (!examplesFolder) 
+    const examplesFolder = this.getExamplesFolder(responseDefinition.specLocation)
+    if (examplesFolder === undefined) {
       return
-     // Get a map of status code to response example subfolder.
+    }
+    // Get a map of status code to response example subfolder.
     const examplesResponseSubfolderMap = this.getExamplesResponseSubfolderMap(examplesFolder)
-    const examples200ResponseSubfolder = examplesResponseSubfolderMap?.get("200")
-    // If there is an examples/response or examples/200_response folder, 
+    const examples200ResponseSubfolder = examplesResponseSubfolderMap?.get('200')
+    // If there is an examples/response or examples/200_response folder,
     // add the response examples to the model.
-    if (examples200ResponseSubfolder)
+    if (examples200ResponseSubfolder !== undefined) {
       responseDefinition.examples = this.getExampleMap(examples200ResponseSubfolder)
+    }
   }
 }