feat: add go quality rules

Author: Mikadows

src/code-quality/code-quality.service.ts

@@ -2,12 +2,15 @@ import { Injectable } from '@nestjs/common';
 import { QualityDTO } from './dto/quality.dto';
 import { CPPQualityVisitor } from './languages/cpp/cpp.vistor';
 import { PythonVisitor } from './languages/python/python.visitor';
+import { GoQualityVisitor } from './languages/golang/go.visitor';
 
 @Injectable()
 export class CodeQualityService {
   public run(source: string, language: string): QualityDTO {
     const cppVisitor = new CPPQualityVisitor();
     const pyVisitor = new PythonVisitor();
+    const goVisitor = new GoQualityVisitor();
+
     const ret = {
       score: 100,
     };
@@ -17,6 +20,8 @@ export class CodeQualityService {
         return cppVisitor.run(source);
       case 'py':
         return pyVisitor.run(source);
+      case 'go':
+        return goVisitor.run(source);
       default:
         return ret;
     }

src/code-quality/languages/golang/generated/GoParser.ts

@@ -14,12 +14,6 @@ import { VocabularyImpl } from 'antlr4ts/VocabularyImpl';
 import * as Utils from 'antlr4ts/misc/Utils';
 import { GoParserVisitor } from './GoParserVisitor';
 import { Parser } from 'antlr4ts/Parser';
-// import { NotNull } from 'antlr4ts/Decorators';
-// import { Override } from 'antlr4ts/Decorators';
-// import { Parser } from 'antlr4ts/Parser';
-// import { ParseTreeListener } from 'antlr4ts/tree/ParseTreeListener';
-// import { ParseTreeVisitor } from 'antlr4ts/tree/ParseTreeVisitor';
-// import { RuleVersion } from "antlr4ts/RuleVersion";
 
 export class GoParser extends Parser {
   public static readonly BREAK = 1;

src/code-quality/languages/golang/go.visitor.ts

@@ -1,34 +1,76 @@
 import { AbstractParseTreeVisitor } from 'antlr4ts/tree/AbstractParseTreeVisitor';
-import { CharStreams, CommonTokenStream } from 'antlr4ts';
 import { GoParserVisitor } from './generated/GoParserVisitor';
 import { QualityDTO } from '../../dto/quality.dto';
-import { GoLexer } from './generated/GoLexer';
-import { FunctionDeclContext, GoParser } from './generated/GoParser';
+import { CommonQualityFunction } from '../common/CommonQualityFunction';
 
-export class GoQualityVistor
+export class GoQualityVisitor
   extends AbstractParseTreeVisitor<void>
   implements GoParserVisitor<void>
 {
   private codeQuality: QualityDTO;
 
   run(source: string): QualityDTO {
-    const inputStream = CharStreams.fromString(source);
-    const lexer = new GoLexer(inputStream);
-    const tokenStream = new CommonTokenStream(lexer);
-    const parser = new GoParser(tokenStream);
-
     this.codeQuality = {
       score: 100,
     };
 
-    const context = parser.functionDecl();
-    this.visit(context);
+    const lines = source.split('\n');
+
+    this.qualityEvalFunctionName(lines);
+
+    this.qualityEvalFunctionBody(lines);
 
     return this.codeQuality;
   }
 
-  visitFunctionDecl(context: FunctionDeclContext): void {
-    context.IDENTIFIER();
+  /**
+   * Applying quality rules on function name
+   * @param lines
+   * @private
+   */
+  private qualityEvalFunctionName(lines: string[]): void {
+    // Applying rules on function name
+    lines
+      .filter((line) => line.startsWith('func'))
+      .map((line) => line.substring(5, line.indexOf('(')).trim())
+      // If function name name is greater than 25 character => quality -1
+      .map((functionName) => {
+        if (functionName.length > 25) {
+          this.codeQuality.score -= 1;
+        }
+        return functionName;
+      })
+      // If function name is not written is snake case => quality -3
+      .map((functionName) => {
+        if (!CommonQualityFunction.isSnakeCase(functionName)) {
+          this.codeQuality.score -= 3;
+        }
+        return functionName;
+      });
+  }
+
+  /**
+   * Applying quality rules on function body
+   * @param lines
+   * @private
+   */
+  private qualityEvalFunctionBody(lines: string[]): void {
+    let counter = 0;
+    let isInFunction = false;
+    lines.forEach((line) => {
+      if (line.startsWith('func') && line.endsWith('{')) {
+        isInFunction = true;
+      } else if (isInFunction) {
+        counter += 1;
+      }
+      if (line.trim().endsWith('}')) {
+        if (counter > 30) {
+          this.codeQuality.score -= 5;
+        }
+        isInFunction = false;
+        counter = 0;
+      }
+    });
   }
 
   // eslint-disable-next-line @typescript-eslint/no-empty-function

src/submissions/submissions.controller.ts

@@ -55,6 +55,9 @@ export class SubmissionsController {
       case 'cpp':
         qualityScore = this.qualityService.run(createSubmissionDTO.code, 'cpp');
         break;
+      case 'go':
+        qualityScore = this.qualityService.run(createSubmissionDTO.code, 'go');
+        break;
       default:
         lintScore = { score: 0 };
         qualityScore = { score: 0 };