git-truck 0.5.0

package/.eslintrc.json

@@ -0,0 +1,20 @@
+{
+  "env": {
+      "browser": false,
+      "es2021": true
+  },
+  "extends": [
+      "@remix-run/eslint-config",
+      "eslint:recommended",
+      "plugin:@typescript-eslint/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+      "ecmaVersion": "latest",
+      "sourceType": "module"
+  },
+  "plugins": [
+      "@typescript-eslint"
+  ]
+}
+

package/.github/workflows/test-and-build.yml

@@ -0,0 +1,39 @@
+# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Test and build
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test-and-build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x, 17.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: '0'
+
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+
+    - run: npm ci
+    - run: npm test
+    - run: npm run build
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v2
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

package/.truckignore

@@ -0,0 +1 @@
+package-lock.json

package/.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "esbenp.prettier-vscode",
+    "styled-components.vscode-styled-components",
+    "Orta.vscode-jest"
+  ]
+}

package/.vscode/launch.json

@@ -0,0 +1,24 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Launch Parser on git-visual",
+            "program": "${workspaceFolder}/parser/dist/index.js",
+            "request": "launch",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "type": "pwa-node"
+        },
+        {
+            "type": "pwa-chrome",
+            "request": "launch",
+            "name": "Launch visualization in chrome",
+            "url": "http://localhost:3000",
+            "webRoot": "${workspaceFolder}"
+        }
+    ]
+}

package/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "editor.formatOnSave": false,
+  "typescript.tsserver.experimental.enableProjectDiagnostics": false,
+  "githubIssues.issueBranchTitle": "${issueNumber}/${sanitizedIssueTitle}",
+  "editor.defaultFormatter": "esbenp.prettier-vscode"
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 git-visual
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,60 @@
+# Git Truck 🚛
+
+_Visualizing a Git repository_
+
+Get an overview over your git repo. See your folder-structure, which users have contributed most to which files, and more.
+
+## [Prerequisites](#prerequisites)
+
+This projected is tested to work with:
+
+- Node.js 16.13
+- npm 6.14
+- git 2.35
+
+## [Usage](#usage)
+
+1. Install dependencies with `npm install`
+2. Build the project with `npm run build`
+3. Install the tool globally by running `npm install -g .` in the root of the project
+3. Then run the app in production mode:
+
+**Note:** If the above fails, try running `sudo npm install -g .` instead.
+
+```sh
+git-truck [--path <path>] [--branch <name>] [--out <path>] [--log <path>]
+```
+
+#### [Arguments](#arguments)
+
+|    arg     |   default value    |                               description                               |
+| :--------: | :----------------: | :---------------------------------------------------------------------: |
+|  `--path`  | current directory  |                         path to git repository                          |
+| `--branch` | checked out branch |                               branch name                               |
+|  `--out`   |    ./data.json     |                        output path for data file                        |
+|  `--log`   |        null        | output log level. See [here](./app/parser/src/log.server.ts) for values |
+
+## [Uninstall](#uninstall)
+Uninstall the tool by running `npm uninstall -g git-truck` or `sudo npm uninstall -g git-truck`
+
+## [Development](#development)
+
+In the root of the project, run the following from your terminal:
+
+```sh
+npm run dev -- <args>
+```
+
+_or using yarn:_ `yarn dev <args>`
+
+For arguments, see [Arguments](#arguments).
+
+This starts the app in development mode, rebuilding assets on file changes.
+
+## Clean up
+
+To clean up build artefacts, etc. run:
+
+```
+npm run clean
+```

package/app/README.md

@@ -0,0 +1,46 @@
+# Getting Started with Create React App
+
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm start`
+
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.\
+You will also see any lint errors in the console.
+
+### `npm test`
+
+Launches the test runner in the interactive watch mode.\
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.\
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.\
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `npm run eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).

package/app/entry.client.tsx

@@ -0,0 +1,4 @@
+import { hydrate } from "react-dom";
+import { RemixBrowser } from "remix";
+
+hydrate(<RemixBrowser />, document);

package/app/entry.server.tsx

@@ -0,0 +1,27 @@
+import { renderToString } from "react-dom/server";
+import { RemixServer } from "remix";
+import type { EntryContext } from "remix";
+import { ServerStyleSheet } from "styled-components";
+
+export default function handleRequest(
+  request: Request,
+  responseStatusCode: number,
+  responseHeaders: Headers,
+  remixContext: EntryContext
+) {
+  const sheet = new ServerStyleSheet();
+  let markup = renderToString(
+    sheet.collectStyles(
+      <RemixServer context={remixContext} url={request.url} />
+    )
+  );
+
+  const styles = sheet.getStyleTags()
+  markup = markup.replace("__STYLES__", styles)
+  responseHeaders.set("Content-Type", "text/html");
+
+  return new Response("<!DOCTYPE html>" + markup, {
+    status: responseStatusCode,
+    headers: responseHeaders,
+  });
+}

package/app/parser/.eslintignore

@@ -0,0 +1,3 @@
+dist
+node_modules
+.github

package/app/parser/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+    "env": {
+        "browser": false,
+        "es2021": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ]
+}

package/app/parser/src/TruckIgnore.server.ts

@@ -0,0 +1,20 @@
+import { readFileSync } from "fs"
+import { compile } from "gitignore-parser"
+import { log } from "./log.server"
+
+export default class TruckIgnore {
+  private truckignore
+  constructor(path: string) {
+    try {
+      const file = readFileSync(path + "/.truckignore", "utf-8")
+      this.truckignore = compile(file)
+    } catch (e) {
+      log.warn("No .truckignore found")
+    }
+  }
+
+  public isAccepted(fileName: string) {
+    if (!this.truckignore) return true
+    return this.truckignore.accepts(fileName)
+  }
+}

package/app/parser/src/constants.ts

@@ -0,0 +1 @@
+export const emptyGitCommitHash = "4b825dc642cb6eb9a060e54bf8d69288fbee4904"

package/app/parser/src/hydrate.server.ts

@@ -0,0 +1,199 @@
+import { emptyGitCommitHash } from "./constants"
+import isBinaryPath from "is-binary-path"
+import { join } from "path"
+import { log } from "./log.server"
+import {
+  GitBlobObject,
+  GitCommitObject,
+  GitCommitObjectLight,
+  HydratedGitBlobObject,
+  HydratedGitCommitObject,
+  HydratedGitTreeObject,
+  PersonWithTime,
+} from "./model"
+import { parseCommitLight } from "./parse.server"
+import { gitDiffNumStatParsed, lookupFileInTree } from "./util"
+import { Queue } from "./queue"
+
+const renamedFiles = new Map<string, string>()
+
+export async function hydrateData(
+  repo: string,
+  commit: GitCommitObject
+): Promise<HydratedGitCommitObject> {
+  const data = commit as HydratedGitCommitObject
+
+  initially_mut(data)
+
+  const { hash: first } = data
+
+  await bfs(first, repo, data)
+
+  finally_mut(data)
+
+  return data
+}
+
+function initially_mut(data: HydratedGitCommitObject) {
+  data.minNoCommits = Number.MAX_VALUE
+  data.maxNoCommits = Number.MIN_VALUE
+  data.oldestLatestChangeEpoch = Number.MAX_VALUE
+  data.newestLatestChangeEpoch = Number.MIN_VALUE
+
+  addAuthorsField_mut(data.tree)
+}
+
+function addAuthorsField_mut(tree: HydratedGitTreeObject) {
+  for (const child of tree.children) {
+    if (child.type === "blob") {
+      child.authors = {}
+    } else {
+      addAuthorsField_mut(child)
+    }
+  }
+}
+
+async function bfs(first: string, repo: string, data: HydratedGitCommitObject) {
+  const expandedHashes = new Set<string>()
+  const queue = new Queue<string>()
+
+  queue.enqueue(first)
+
+  while (!queue.isEmpty()) {
+    const currHash = queue.dequeue()
+
+    if (expandedHashes.has(currHash)) continue
+
+    expandedHashes.add(currHash)
+
+    // don't compare the empty commit to it's parent
+    if (currHash == emptyGitCommitHash) continue
+
+    const currCommit = await parseCommitLight(repo, currHash)
+
+    const parentsOfCurr = parents(currCommit)
+
+    for (const parentHash of parentsOfCurr) {
+      switch (parentsOfCurr.size) {
+        case 2: // curr is a merge commit
+          queue.enqueue(parentHash)
+          break
+        case 1: // curr is a linear commit
+          diffAndUpdate_mut(data, currCommit, parentHash, repo)
+          queue.enqueue(parentHash)
+          break
+        default:
+          // curr is the root commit
+          diffAndUpdate_mut(data, currCommit, emptyGitCommitHash, repo)
+          break
+      }
+    }
+  }
+}
+
+function parents(obj: GitCommitObject | GitCommitObjectLight): Set<string> {
+  const parents = new Set<string>()
+
+  if (obj.parent !== null) parents.add(obj.parent)
+  if (obj.parent2 !== null) parents.add(obj.parent2)
+
+  return parents
+}
+
+async function diffAndUpdate_mut(
+  data: HydratedGitCommitObject,
+  currCommit: GitCommitObjectLight,
+  parentHash: string,
+  repo: string
+) {
+  const { author } = currCommit
+
+  const currHash = currCommit.hash
+
+  log.debug(`comparing [${currHash}] -> [${parentHash}]`)
+
+  const fileChanges = await gitDiffNumStatParsed(
+    repo,
+    parentHash,
+    currHash,
+    renamedFiles
+  )
+
+  for (const fileChange of fileChanges) {
+    const { pos, neg, file } = fileChange
+
+    const blob = await lookupFileInTree(data.tree, file)
+
+    if (file === "dev/null") continue
+    if (blob) {
+      updateBlob_mut(blob, data, author, currCommit, pos, neg)
+    }
+  }
+}
+
+function isBinaryFile(blob: GitBlobObject) {
+  return isBinaryPath(join(blob.path, blob.name))
+}
+
+function updateBlob_mut(
+  blob: GitBlobObject,
+  data: HydratedGitCommitObject,
+  author: PersonWithTime,
+  currCommit: GitCommitObjectLight,
+  pos: number,
+  neg: number
+) {
+  const noCommits = 1 + ((blob as HydratedGitBlobObject).noCommits ?? 0)
+
+  if (noCommits < data.minNoCommits) data.minNoCommits = noCommits
+  if (noCommits > data.maxNoCommits) data.maxNoCommits = noCommits
+
+  const isBinary = isBinaryFile(blob)
+
+  const hydratedBlob = {
+    ...blob,
+    authors: (blob as HydratedGitBlobObject).authors ?? {},
+    noLines: isBinary ? 0 : blob.content?.split("\n").length,
+    noCommits: noCommits,
+    isBinary: isBinary,
+  } as HydratedGitBlobObject
+
+  if (!isBinary) {
+    const current = hydratedBlob.authors?.[author.name] ?? 0
+
+    const newValue = current + pos + neg
+    if (newValue > 0) {
+      for (const coauthor of currCommit.coauthors) {
+        hydratedBlob.authors[coauthor.name] = newValue
+      }
+      hydratedBlob.authors[author.name] = newValue
+    }
+  }
+
+  if (!hydratedBlob.lastChangeEpoch) {
+    const epoch = currCommit.author.timestamp
+    hydratedBlob.lastChangeEpoch = epoch
+
+    if (epoch > data.newestLatestChangeEpoch)
+      data.newestLatestChangeEpoch = epoch
+
+    if (epoch < data.oldestLatestChangeEpoch)
+      data.oldestLatestChangeEpoch = epoch
+  }
+
+  Object.assign(blob, hydratedBlob)
+}
+
+function finally_mut(data: HydratedGitCommitObject) {
+  discardContentField_mut(data.tree)
+}
+
+function discardContentField_mut(tree: HydratedGitTreeObject) {
+  for (const child of tree.children) {
+    if (child.type === "blob") {
+      child.content = undefined
+    } else {
+      discardContentField_mut(child)
+    }
+  }
+}

package/app/parser/src/index.ts

@@ -0,0 +1,5 @@
+import "dotenv/config"
+import { parse } from "./parse.server"
+
+const args = process.argv.slice(2)
+parse(args)

package/app/parser/src/log.server.ts

@@ -0,0 +1,97 @@
+export enum LOG_LEVEL {
+  SILENT,
+  ERROR,
+  WARN,
+  INFO,
+  DEBUG,
+}
+export enum LOG_LEVEL_LABEL {
+  SILENT = "",
+  ERROR = "ERR",
+  WARN = "WRN",
+  INFO = "NFO",
+  DEBUG = "DBG",
+}
+
+const stringToLevelMap: Record<string, LOG_LEVEL> = {
+  SILENT: LOG_LEVEL.SILENT,
+  ERROR: LOG_LEVEL.ERROR,
+  WARN: LOG_LEVEL.WARN,
+  INFO: LOG_LEVEL.INFO,
+  DEBUG: LOG_LEVEL.DEBUG,
+}
+
+const { ERROR, WARN, INFO, DEBUG } = LOG_LEVEL_LABEL
+
+function setIntialLogLevel() {
+  if (typeof process.env.LOG_LEVEL === "string")
+    return stringToLevelMap[process.env.LOG_LEVEL.toUpperCase()]
+  if (typeof process.env.LOG_LEVEL === "number") return process.env.LOG_LEVEL
+  return null
+}
+
+let logLevel = setIntialLogLevel()
+
+export const getLogLevel = () => logLevel
+
+export function setLogLevel(level: string) {
+  const newLevel = stringToLevelMap[level.trim().toUpperCase()]
+  if(typeof newLevel === "undefined") {
+    throw new Error(`Invalid log level: ${level}`)
+  }
+  logLevel = newLevel
+}
+
+export function error(message: Error | unknown) {
+  if (logLevel === null) return
+  if (logLevel >= LOG_LEVEL.ERROR) {
+    const messageString =
+      message instanceof Error
+        ? `${prefix(ERROR)}${message.message}\n${message.stack}`
+        : `${prefix(ERROR)}${message}`
+    console.error(messageString)
+  }
+}
+
+export function warn(message: unknown) {
+  if (logLevel === null) return
+  if (logLevel >= LOG_LEVEL.WARN) {
+    const messageString = `${prefix(WARN)}${message}`
+    console.warn(messageString)
+  }
+}
+
+export function info(message: unknown) {
+  if (logLevel === null) return
+  if (logLevel >= LOG_LEVEL.INFO) {
+    const messageString = `${prefix(INFO)}${message}`
+    console.info(messageString)
+  }
+}
+
+export function debug(message: unknown) {
+  if (logLevel === null) return
+  if (logLevel >= LOG_LEVEL.DEBUG) {
+    const messageString = `${prefix(DEBUG)}${message}`
+    console.debug(messageString)
+  }
+}
+
+export function raw(message: unknown) {
+  if (logLevel === null) return
+  if (logLevel >= LOG_LEVEL.INFO) {
+    console.info(message)
+  }
+}
+
+function prefix(label: LOG_LEVEL_LABEL): string {
+  return `[${label}] `
+}
+
+export const log = {
+  error,
+  warn,
+  info,
+  debug,
+  raw,
+}