Lint and format

Author: gnikit

README.md

@@ -164,7 +164,7 @@ If the formatter is not present in the `PATH` its location can be input with
 
 ```json
 {
-    "fortran.formattting.path": "/custom-path-to-formatter-binary",
+  "fortran.formattting.path": "/custom-path-to-formatter-binary"
 }
 ```
 

src/extension.ts

@@ -31,7 +31,7 @@ export function activate(context: vscode.ExtensionContext) {
   }
 
   if (extensionConfig.get('formatter') !== 'Disabled') {
-    let disposable: vscode.Disposable = vscode.languages.registerDocumentFormattingEditProvider(
+    const disposable: vscode.Disposable = vscode.languages.registerDocumentFormattingEditProvider(
       FORTRAN_DOCUMENT_SELECTOR,
       new FortranFormattingProvider(loggingService)
     );

src/features/formatting-provider.ts

@@ -10,95 +10,100 @@ import { FORMATTERS } from '../lib/tools';
 import { LoggingService } from '../services/logging-service';
 import { EXTENSION_ID, promptForMissingTool } from '../lib/helper';
 
+export class FortranFormattingProvider implements vscode.DocumentFormattingEditProvider {
+  constructor(private logger: LoggingService) {}
 
-export class FortranFormattingProvider
-  implements vscode.DocumentFormattingEditProvider {
-
-  constructor(private logger: LoggingService) { }
-
-  public provideDocumentFormattingEdits(document: vscode.TextDocument, options: vscode.FormattingOptions, token: vscode.CancellationToken): vscode.ProviderResult<vscode.TextEdit[]> {
-
-    let formatterName: string = this.getFormatter();
+  public provideDocumentFormattingEdits(
+    document: vscode.TextDocument,
+    options: vscode.FormattingOptions,
+    token: vscode.CancellationToken
+  ): vscode.ProviderResult<vscode.TextEdit[]> {
+    const formatterName: string = this.getFormatter();
 
     if (formatterName === 'fprettify') {
       this.doFormatFprettify(document);
-    }
-    else if (formatterName === 'findent') {
+    } else if (formatterName === 'findent') {
       this.doFormatFindent(document);
-    }
-    else {
-      this.logger.logError('Cannot format document with formatter set to Disabled')
+    } else {
+      this.logger.logError('Cannot format document with formatter set to Disabled');
     }
 
-    return
+    return;
   }
 
   /**
    * Use `fprettify` to format a Fortran file.
-   * 
+   *
    * @param document vscode.TextDocument document to operate on
    */
   private doFormatFprettify(document: vscode.TextDocument) {
-
     // fprettify can only do FortranFreeFrom
     if (document.languageId !== 'FortranFreeForm') {
       this.logger.logError(`fprettify can only format FortranFreeForm, change
                             to findent for FortranFixedForm formatting`);
-      return
+      return;
     }
 
-    const formatterName: string = 'fprettify';
-    let formatterPath: string = this.getFormatterPath();
+    const formatterName = 'fprettify';
+    const formatterPath: string = this.getFormatterPath();
     // If no formatter path is present check that formatter is present in $PATH
     if (!formatterPath) {
       if (!which.sync(formatterName, { nothrow: true })) {
         this.logger.logWarning(`Formatter: ${formatterName} not detected in your system.
                                 Attempting to install now.`);
-        let msg = `Installing ${formatterName} through pip with --user option`;
+        const msg = `Installing ${formatterName} through pip with --user option`;
         promptForMissingTool(formatterName, msg, 'Python');
       }
     }
-    let formatter: string = path.join(formatterPath, formatterName);
+    const formatter: string = path.join(formatterPath, formatterName);
 
-    let args: string[] = [document.fileName, ...this.getFormatterArgs()];
+    const args: string[] = [document.fileName, ...this.getFormatterArgs()];
     // args.push('--silent'); // TODO: pass?
 
     // Get current file (name rel to path), run extension can be in a shell??
-    let process = cp.spawn(formatter, args);
+    const process = cp.spawn(formatter, args);
 
     // if the findent then capture the output from that and parse it back to the file
-    process.stdout.on('data', (data) => { this.logger.logInfo(`formatter stdout: ${data}`) });
-    process.stderr.on('data', (data) => { this.logger.logError(`formatter stderr: ${data}`) });
-    process.on('close', (code: number) => { if (code !== 0) this.logger.logInfo(`formatter exited with code: ${code}`) });
-    process.on('error', (code) => { this.logger.logInfo(`formatter exited with code: ${code}`) });
-
+    process.stdout.on('data', data => {
+      this.logger.logInfo(`formatter stdout: ${data}`);
+    });
+    process.stderr.on('data', data => {
+      this.logger.logError(`formatter stderr: ${data}`);
+    });
+    process.on('close', (code: number) => {
+      if (code !== 0) this.logger.logInfo(`formatter exited with code: ${code}`);
+    });
+    process.on('error', code => {
+      this.logger.logInfo(`formatter exited with code: ${code}`);
+    });
   }
 
   /**
    * Use `findent` to format a Fortran file.
    * Creates a temporary file where the output is placed and then deleted
-   * 
+   *
    * @param document vscode.TextDocument document to operate on
    */
   private doFormatFindent(document: vscode.TextDocument) {
-
-    const formatterName: string = 'findent';
-    let formatterPath: string = this.getFormatterPath();
+    const formatterName = 'findent';
+    const formatterPath: string = this.getFormatterPath();
     // If no formatter path is present check that formatter is present in $PATH
     if (!formatterPath) {
       if (!which.sync(formatterName, { nothrow: true })) {
         this.logger.logWarning(`Formatter: ${formatterName} not detected in your system.
                                 Attempting to install now.`);
-        let msg = `Installing ${formatterName} through pip with --user option`;
+        const msg = `Installing ${formatterName} through pip with --user option`;
         promptForMissingTool(formatterName, msg, 'Python');
       }
     }
     let formatter: string = path.join(formatterPath, formatterName);
 
     // Annoyingly findent only outputs to a file and not to a stream so
     // let us go and create a temporary file
-    let out = document.uri.path + '.findent.tmp';
-    let args: string = ['< ' + document.fileName + ' >', out, ...this.getFormatterArgs()].join(' ');
+    const out = document.uri.path + '.findent.tmp';
+    const args: string = ['< ' + document.fileName + ' >', out, ...this.getFormatterArgs()].join(
+      ' '
+    );
     formatter = formatter + ' ' + args;
 
     // @note It is wise to have all IO operations being synchronous we don't
@@ -108,52 +113,50 @@ export class FortranFormattingProvider
     cp.execSync(formatter, { stdio: 'inherit' });
     fs.copyFileSync(out, document.fileName);
     fs.unlinkSync(out);
-
   }
 
   /**
    * Get the formatter type
    * Currently supporting: `findent` and `fprettify`
-   * 
+   *
    * Formatters are defined in FORMATTERS (./lib/tools.ts)
-   * 
+   *
    * @returns {string} formatter name or `Disabled`
    */
   private getFormatter(): string {
-
-    let config = vscode.workspace.getConfiguration(EXTENSION_ID)
-    const formatter: string = config.get('formatting.formatter', 'Disabled')
+    const config = vscode.workspace.getConfiguration(EXTENSION_ID);
+    const formatter: string = config.get('formatting.formatter', 'Disabled');
 
     if (!FORMATTERS.includes(formatter)) {
-      this.logger.logError(`Unsupported formatter: ${formatter}`)
+      this.logger.logError(`Unsupported formatter: ${formatter}`);
     }
-    return formatter
+    return formatter;
   }
 
   /**
    * Read in any custom arguments for the formatter
-   * 
+   *
    * @returns {string[]} list of additional arguments
    */
   private getFormatterArgs(): string[] {
-    let config = vscode.workspace.getConfiguration(EXTENSION_ID)
-    const args: string[] = config.get('formatting.args', [])
+    const config = vscode.workspace.getConfiguration(EXTENSION_ID);
+    const args: string[] = config.get('formatting.args', []);
 
-    return args
+    return args;
   }
 
   /**
    * Installation directory for formatter (if not in PATH)
-   * 
+   *
    * @returns {string} path of formatter
    */
   private getFormatterPath(): string {
-    let config = vscode.workspace.getConfiguration(EXTENSION_ID)
-    const formatterPath: string = config.get('formatting.path', '')
+    const config = vscode.workspace.getConfiguration(EXTENSION_ID);
+    const formatterPath: string = config.get('formatting.path', '');
     if (formatterPath !== '') {
-      this.logger.logInfo(`Formatter located in: ${formatterPath}`)
+      this.logger.logInfo(`Formatter located in: ${formatterPath}`);
     }
 
-    return formatterPath
+    return formatterPath;
   }
 }