work in progress

rajivramv · Jun 19, 2019 · 5198c95 · 5198c95
1 parent d6d23f6
commit 5198c95
Show file tree

Hide file tree

Showing 22 changed files with 401 additions and 80 deletions.
diff --git a/README.MD b/README.MD
@@ -1,2 +1,17 @@
+# Simple Linter
+This utility lints source code to verify if it conforms to [Google's Style Guide](https://github.com/google/styleguide). It uses [checkstyle](https://checkstyle.org/index.html) and [cpplint](https://github.com/google/styleguide/tree/gh-pages/cpplint) for the linting. Currently implemented languages: Java, C++.
+
+### Dependencies
+1. Node.js >= v10.11.3
+2. Python >= v3.5
+3. Java & JRE
+
 ### Installation
-1. Install java and jre from deb package openjdk-9-jre-headless. Use command `sudo apt-get install openjdk-9-jre-headless`
+1. Install Node.js >= v10.11.3 using [node version manager](https://github.com/nvm-sh/nvm#install--update-script).
+2. Install java and jre from deb package openjdk-9-jre-headless or any other suitable version. Use command `sudo apt-get install openjdk-9-jre-headless`.
+3. [Download](https://www.python.org/downloads/) and install Python >= v3.5.
+4. Clone the repository and run `npm install` inside `api-service` and `app`.
+5. Start the Api service by running `npm run dev` inside `api-service`.
+6. Start the App by running `npm start` inside `app`.
+
+
diff --git a/api-service/package.json b/api-service/package.json
@@ -1,7 +1,7 @@
 {
   "name": "api-service",
   "version": "0.1.0",
-  "description": "Backend for code analyzer",
+  "description": "Backend for code linter",
   "main": "dist",
   "scripts": {
     "build": "tsc",
@@ -11,7 +11,7 @@
   },
   "keywords": [
     "Code",
-    "analyzer",
+    "linter",
     "backend"
   ],
   "author": "Rajiv Ram V <[email protected]>",

diff --git a/...rvice/src/analyzers/cpp/binary-search.cpp → ...service/src/linters/cpp/binary-search.cpp b/...rvice/src/analyzers/cpp/binary-search.cpp → ...service/src/linters/cpp/binary-search.cpp
diff --git a/api-service/src/analyzers/cpp/cpplint/README → api-service/src/linters/cpp/cpplint/README b/api-service/src/analyzers/cpp/cpplint/README → api-service/src/linters/cpp/cpplint/README
diff --git a/...vice/src/analyzers/cpp/cpplint/cpplint.py → ...ervice/src/linters/cpp/cpplint/cpplint.py b/...vice/src/analyzers/cpp/cpplint/cpplint.py → ...ervice/src/linters/cpp/cpplint/cpplint.py
diff --git a/...alyzers/cpp/cpplint/cpplint_test_header.h → ...linters/cpp/cpplint/cpplint_test_header.h b/...alyzers/cpp/cpplint/cpplint_test_header.h → ...linters/cpp/cpplint/cpplint_test_header.h
diff --git a/...analyzers/cpp/cpplint/cpplint_unittest.py → ...c/linters/cpp/cpplint/cpplint_unittest.py b/...analyzers/cpp/cpplint/cpplint_unittest.py → ...c/linters/cpp/cpplint/cpplint_unittest.py
diff --git a/.../cpp/cpplint/nested/cpplint_test_header.h → .../cpp/cpplint/nested/cpplint_test_header.h b/.../cpp/cpplint/nested/cpplint_test_header.h → .../cpp/cpplint/nested/cpplint_test_header.h
diff --git a/api-service/src/analyzers/index.ts → api-service/src/linters/index.ts b/api-service/src/analyzers/index.ts → api-service/src/linters/index.ts
@@ -2,18 +2,18 @@ import { spawn } from "child_process";
 import { writeFile } from "fs";
 import tmp from "tmp";
 
-export interface IAnalyzeRequest {
+export interface ILintRequest {
   code: string;
   lang: string;
 }
 
-export interface IAnalyzeResult {
+export interface ILintResult {
   lang: "cpp" | "java";
   errors: string;
   completed: string;
 }
 
-export const analyze = (job: IAnalyzeRequest): Promise<IAnalyzeResult> => {
+export const lint = (job: ILintRequest): Promise<ILintResult> => {
   return new Promise((resolve, reject) => {
     switch (job.lang) {
       case "cpp":
@@ -73,3 +73,7 @@ export const analyze = (job: IAnalyzeRequest): Promise<IAnalyzeResult> => {
     }
   });
 };
+
+// const detectLanguage = (code: string): Promise<string> => {
+
+// }
diff --git a/...ice/src/analyzers/java/ComplexNumber.java → ...rvice/src/linters/java/ComplexNumber.java b/...ice/src/analyzers/java/ComplexNumber.java → ...rvice/src/linters/java/ComplexNumber.java
diff --git a/...rc/analyzers/java/checkstyle-8.21-all.jar → .../src/linters/java/checkstyle-8.21-all.jar b/...rc/analyzers/java/checkstyle-8.21-all.jar → .../src/linters/java/checkstyle-8.21-all.jar
diff --git a/...vice/src/analyzers/java/google_checks.xml → ...ervice/src/linters/java/google_checks.xml b/...vice/src/analyzers/java/google_checks.xml → ...ervice/src/linters/java/google_checks.xml
diff --git a/api-service/src/routes.ts b/api-service/src/routes.ts
@@ -1,16 +1,16 @@
 import { Context } from "koa";
 import Router from "koa-router";
 
-import { analyze, IAnalyzeRequest } from "./analyzers";
+import { ILintRequest, lint } from "./linters";
 const router = new Router();
 
 router.get("/test", async (ctx: Context) => {
   ctx.body = "Hello World!";
 });
 
-router.post("/analyze", async (ctx: Context) => {
-  const job = ctx.request.body as IAnalyzeRequest;
-  const result = await analyze(job);
+router.post("/lint", async (ctx: Context) => {
+  const job = ctx.request.body as ILintRequest;
+  const result = await lint(job);
   ctx.body = result;
 });
 

diff --git a/app/.env b/app/.env
@@ -0,0 +1,2 @@
+PORT=4000
+REACT_APP_API_URI=http://localhost:3000
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		PORT=4000
		REACT_APP_API_URI=http://localhost:3000