Merging release v1.1.5 to master

Merging changes for release v1.1.5 to master

# New Features and enhancements

- Code view feature for viewing files from repo details file explorer (#51)
- Minor UI tweaks and fallback views 

# Bug fixes

- gitconvex app crash issue when started from the globally installed npm module (#87)

Author: neel1996

API/addRepoApi.js

@@ -45,7 +45,7 @@ async function addRepoHandler(
         throw new Error("Invalid clone URL string!");
       }
 
-      if (repoName.match(/[^a-zA-Z0-9-_.\\s]/gi)) {
+      if (repoName.match(/[^a-zA-Z0-9-_.\s]/gi)) {
         throw new Error("Invalid repo name string!");
       }
 

API/codeFileViewApi.js

@@ -0,0 +1,54 @@
+const fs = require("fs");
+const path = require("path");
+const { getRepoPath } = require("../global/fetchGitRepoPath");
+const { gitFileBasedCommit } = require("../git/gitFileBasedCommit");
+const { isText } = require("istextorbinary");
+const { LangLine } = require("@itassistors/langline");
+
+async function codeFileViewApi(repoId, fileName) {
+  const repoPath = await getRepoPath(repoId);
+  const targetFile = path.join(repoPath, fileName);
+  const langData = await new LangLine().withFile(targetFile);
+  let fileContent = [];
+
+  if (isText(targetFile)) {
+    const commit = await gitFileBasedCommit(repoPath, targetFile);
+
+    let fileData = await fs.promises
+      .readFile(targetFile)
+      .then((res) => {
+        return res.toString();
+      })
+      .catch((err) => {
+        console.log(err);
+        return "";
+      });
+
+    if (langData && langData.name) {
+      if (fileData) {
+        fileContent = fileData.split("\n");
+        return {
+          codeFileDetails: {
+            language: langData.name,
+            fileData: fileContent,
+            fileCommit: commit,
+            prism: langData.prismIndicator
+              ? langData.prismIndicator
+              : "markdown",
+          },
+        };
+      }
+    } else {
+      return {
+        codeFileDetails: {
+          language: "Invalid",
+          fileData: fileContent,
+          fileCommit: commit,
+          prism: "markdown",
+        },
+      };
+    }
+  }
+}
+
+module.exports.codeFileViewApi = codeFileViewApi;

DOCUMENTATION.md

@@ -86,14 +86,15 @@ or use `pm2` by downloading it from npm - `npm i -g pm2` and start the module by
 - Remote repo URL and host
 - Files and folders tracked by git
 ```
-The repo detail view also provides features for performing the following git operations,
+The repo detail view also provides features for performing the following operations,
 ```
 - Adding a new branch
 - Pulling changes from remote
 - Fetching changes from remote
 - Adding a new remote repo
-- Directory navigator
-- Loading commit logs on demand
+- Directory navigator to lookup all files and folders within the repo
+- Code view for valid files from the file explorer view
+- Loading commit logs dynamically
 ```
 
 ![repo-card-details](https://user-images.githubusercontent.com/65342122/89164057-30deb800-d594-11ea-94d6-d3a330260044.png)

README.md

@@ -18,9 +18,9 @@
 
 > Use any of the below options to get gitconvex for your system
 
-[![gitconvex npm package](https://img.shields.io/static/v1?label=gitconvex&message=v1.1.4&color=red&style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@itassistors/gitconvex)
-[![github release](https://img.shields.io/static/v1?label=gitconvex&message=v1.1.4&color=green&style=for-the-badge&logo=github)](https://github.com/neel1996/gitconvex-package/releases)
-[![docker image](https://img.shields.io/static/v1?label=gitconvex&message=v1.1.4&color=blue&style=for-the-badge&logo=docker)](https://hub.docker.com/repository/docker/itassistors/gitconvex)
+[![gitconvex npm package](https://img.shields.io/static/v1?label=gitconvex&message=v1.1.5&color=red&style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@itassistors/gitconvex)
+[![github release](https://img.shields.io/static/v1?label=gitconvex&message=v1.1.5&color=green&style=for-the-badge&logo=github)](https://github.com/neel1996/gitconvex-package/releases)
+[![docker image](https://img.shields.io/static/v1?label=gitconvex&message=v1.1.5&color=blue&style=for-the-badge&logo=docker)](https://hub.docker.com/repository/docker/itassistors/gitconvex)
 [![License](https://img.shields.io/static/v1?label=LICENSE&message=Apache-2.0&color=yellow&style=for-the-badge)](LICENSE)
 
 - **Option - 1** Cloning repo from **github**
@@ -88,6 +88,30 @@ $ npm start
 | <b>[Node js](https://nodejs.org/en/)</b> | <b>Tested on v12.0+ |
 |--|--|
 | <b>[Git](https://git-scm.com/)</b> | <b>Tested on v2.20+</b> |
+    
+> **Important note for windows users**
+
+If you are a windows user, then make sure that `git` is accessible from the command line without using git bash.
+
+- Open command prompt or powershell and enter `git --version` and press enter. If it displays the following output, then it is fine
+
+```
+C:\> git --version
+
+git version 2.28.0.windows.1
+```
+
+If this output is not displayed and if the command throws the following error, then it shows that `git` is not added to the 'path' environment variable and it will not be accessible directly from the command line,
+
+```
+C:\> git --version
+
+'git' is not recognized as an internal or external command,
+operable program or batch file.
+```
+
+This can be fixed by adding `git` to the PATH environment variable in windows. The process of setting this up is available [here](https://stackoverflow.com/questions/26620312/git-installing-git-in-path-with-github-client-for-windows#answer-53706956:~:text=comment-,27,Here%20is%20the%20magic)
+
 
 # Detailed documentation
 
@@ -97,3 +121,4 @@ Refer the detailed [Documentation](DOCUMENTATION.md) for how to setup and use th
 
 See [LICENSE ](LICENSE) info for more
 
+

build/asset-manifest.json

@@ -1,12 +1,12 @@
 {
   "files": {
-    "main.css": "/static/css/main.bece8f5e.chunk.css",
-    "main.js": "/static/js/main.a07d6054.chunk.js",
-    "main.js.map": "/static/js/main.a07d6054.chunk.js.map",
-    "runtime-main.js": "/static/js/runtime-main.f623be64.js",
-    "runtime-main.js.map": "/static/js/runtime-main.f623be64.js.map",
-    "static/js/2.a04ba513.chunk.js": "/static/js/2.a04ba513.chunk.js",
-    "static/js/2.a04ba513.chunk.js.map": "/static/js/2.a04ba513.chunk.js.map",
+    "main.css": "/static/css/main.4982453a.chunk.css",
+    "main.js": "/static/js/main.7c0b6200.chunk.js",
+    "main.js.map": "/static/js/main.7c0b6200.chunk.js.map",
+    "runtime-main.js": "/static/js/runtime-main.704666b2.js",
+    "runtime-main.js.map": "/static/js/runtime-main.704666b2.js.map",
+    "static/js/2.72df468b.chunk.js": "/static/js/2.72df468b.chunk.js",
+    "static/js/2.72df468b.chunk.js.map": "/static/js/2.72df468b.chunk.js.map",
     "static/js/3.305dce55.chunk.js": "/static/js/3.305dce55.chunk.js",
     "static/js/3.305dce55.chunk.js.map": "/static/js/3.305dce55.chunk.js.map",
     "static/js/4.3916cb29.chunk.js": "/static/js/4.3916cb29.chunk.js",
@@ -143,10 +143,10 @@
     "static/js/69.2e484cc6.chunk.js.map": "/static/js/69.2e484cc6.chunk.js.map",
     "static/js/70.af220eff.chunk.js": "/static/js/70.af220eff.chunk.js",
     "static/js/70.af220eff.chunk.js.map": "/static/js/70.af220eff.chunk.js.map",
-    "static/js/71.41508ee1.chunk.js": "/static/js/71.41508ee1.chunk.js",
-    "static/js/71.41508ee1.chunk.js.map": "/static/js/71.41508ee1.chunk.js.map",
-    "static/js/72.bc359e5d.chunk.js": "/static/js/72.bc359e5d.chunk.js",
-    "static/js/72.bc359e5d.chunk.js.map": "/static/js/72.bc359e5d.chunk.js.map",
+    "static/js/71.21b9d286.chunk.js": "/static/js/71.21b9d286.chunk.js",
+    "static/js/71.21b9d286.chunk.js.map": "/static/js/71.21b9d286.chunk.js.map",
+    "static/js/72.1b668638.chunk.js": "/static/js/72.1b668638.chunk.js",
+    "static/js/72.1b668638.chunk.js.map": "/static/js/72.1b668638.chunk.js.map",
     "static/js/73.fa3c90b5.chunk.js": "/static/js/73.fa3c90b5.chunk.js",
     "static/js/73.fa3c90b5.chunk.js.map": "/static/js/73.fa3c90b5.chunk.js.map",
     "static/js/74.a0094cb4.chunk.js": "/static/js/74.a0094cb4.chunk.js",
@@ -916,17 +916,17 @@
     "static/js/456.5871dfd5.chunk.js": "/static/js/456.5871dfd5.chunk.js",
     "static/js/456.5871dfd5.chunk.js.map": "/static/js/456.5871dfd5.chunk.js.map",
     "index.html": "/index.html",
-    "precache-manifest.126caf2e5cd7b0982a7e6735e8116539.js": "/precache-manifest.126caf2e5cd7b0982a7e6735e8116539.js",
+    "precache-manifest.59a427ac95ff5e64a44e736349d76f47.js": "/precache-manifest.59a427ac95ff5e64a44e736349d76f47.js",
     "service-worker.js": "/service-worker.js",
-    "static/css/main.bece8f5e.chunk.css.map": "/static/css/main.bece8f5e.chunk.css.map",
-    "static/js/2.a04ba513.chunk.js.LICENSE.txt": "/static/js/2.a04ba513.chunk.js.LICENSE.txt",
-    "static/js/71.41508ee1.chunk.js.LICENSE.txt": "/static/js/71.41508ee1.chunk.js.LICENSE.txt",
+    "static/css/main.4982453a.chunk.css.map": "/static/css/main.4982453a.chunk.css.map",
+    "static/js/2.72df468b.chunk.js.LICENSE.txt": "/static/js/2.72df468b.chunk.js.LICENSE.txt",
+    "static/js/71.21b9d286.chunk.js.LICENSE.txt": "/static/js/71.21b9d286.chunk.js.LICENSE.txt",
     "static/media/SplashScreen.css": "/static/media/gitconvex.e136c267.png"
   },
   "entrypoints": [
-    "static/js/runtime-main.f623be64.js",
-    "static/js/2.a04ba513.chunk.js",
-    "static/css/main.bece8f5e.chunk.css",
-    "static/js/main.a07d6054.chunk.js"
+    "static/js/runtime-main.704666b2.js",
+    "static/js/2.72df468b.chunk.js",
+    "static/css/main.4982453a.chunk.css",
+    "static/js/main.7c0b6200.chunk.js"
   ]
 }