docs: Switch to tracking on a file-basis instead of LoC (#743)

* docs: Switch to tracking on a file-basis instead of LoC * docs: re-gen the app
2026-08-21 23:00:45 -04:00 · 2021-08-09 19:41:25 -04:00
parent 6ff1dbdab3
commit 0007a890cf
19 changed files with 106 additions and 42 deletions
@@ -22,9 +22,7 @@ jobs:

      # just do a sed for now
      - name: Update Line Count
-        run: |
-          chmod +x ./.github/workflows/scripts/line-count.sh
-          ./.github/workflows/scripts/line-count.sh
+        run: python ./scripts/update-file-progress.py

      - name: Update Site
        run: |
@@ -1,5 +0,0 @@
-#!/bin/bash
-
-LINE_COUNT=$(find ./goal_src -name '*.gc' | xargs wc -l | tail -1 | awk -F'[^0-9]+' '{ print $2 }')
-
-sed -i "s/.*value.*/      \"value\": ${LINE_COUNT},/g" ./docs/gh-pages-proj/src/config/progress.json
@@ -1,8 +1,11 @@
 {
  "jak1": {
-    "locPercentage": {
-      "value": 117836,
-      "label": "Lines of Code"
+    "fileProgress": {
+      "src_files_total": 514,
+      "src_files_finished": 49,
+      "src_files_started": 178,
+      "data_files_total": 584,
+      "data_files_started": 4
    }
  }
 }
@@ -58,13 +58,33 @@
          <v-col cols="10">
            <v-subheader>Decompilation</v-subheader>
            <v-progress-linear
-              color="teal"
+              color="green"
              buffer-value="0"
-              :value="jak1BlackLabelStatus.decompDone"
+              :value="jak1BlackLabelStatus.srcFilesFinishedValue"
              stream
              height="25"
            >
-            {{jak1BlackLabelStatus.decompLabel}} - {{jak1BlackLabelStatus.decompDone}}%
+            Source Files Finished - {{ jak1BlackLabelStatus.srcFilesFinished }} / {{ jak1BlackLabelStatus.srcFilesTotal }}
+            </v-progress-linear>
+            <br>
+            <v-progress-linear
+              color="yellow"
+              buffer-value="0"
+              :value="jak1BlackLabelStatus.srcFilesStartedValue"
+              stream
+              height="25"
+            >
+            Source Files Started - {{ jak1BlackLabelStatus.srcFilesStarted }} / {{ jak1BlackLabelStatus.srcFilesTotal }}
+            </v-progress-linear>
+            <br>
+            <v-progress-linear
+              color="teal"
+              buffer-value="0"
+              :value="jak1BlackLabelStatus.dataFilesStartedValue"
+              stream
+              height="25"
+            >
+            Data Files Started - {{ jak1BlackLabelStatus.dataFilesStarted }} / {{ jak1BlackLabelStatus.dataFilesTotal }}
            </v-progress-linear>
          </v-col>
        </v-row>
@@ -129,8 +149,14 @@ export default {
    return {
      recentPRs: [],
      jak1BlackLabelStatus: {
-        decompDone: (projectProgress.jak1.locPercentage.value / 750000.0) * 100.0,
-        decompLabel: projectProgress.jak1.locPercentage.label
+        srcFilesTotal: projectProgress.jak1.fileProgress.src_files_total,
+        srcFilesFinished: projectProgress.jak1.fileProgress.src_files_finished,
+        srcFilesFinishedValue: projectProgress.jak1.fileProgress.src_files_finished / projectProgress.jak1.fileProgress.src_files_total * 100,
+        srcFilesStarted: projectProgress.jak1.fileProgress.src_files_started,
+        srcFilesStartedValue: projectProgress.jak1.fileProgress.src_files_started / projectProgress.jak1.fileProgress.src_files_total * 100,
+        dataFilesTotal: projectProgress.jak1.fileProgress.data_files_total,
+        dataFilesStarted: projectProgress.jak1.fileProgress.data_files_started,
+        dataFilesStartedValue: projectProgress.jak1.fileProgress.data_files_started / projectProgress.jak1.fileProgress.data_files_total * 100,
      }
    };
  },
@@ -1 +1 @@
-<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" href="/jak-project/favicon.png"><title>OpenGOAL Tooling</title><link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:100,300,400,500,700,900"><link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@mdi/font@latest/css/materialdesignicons.min.css"><link href="/jak-project/css/about.8d0e9591.css" rel="prefetch"><link href="/jak-project/js/about.80aba5c3.js" rel="prefetch"><link href="/jak-project/css/chunk-vendors.b018c88a.css" rel="preload" as="style"><link href="/jak-project/js/app.78d57e62.js" rel="preload" as="script"><link href="/jak-project/js/chunk-vendors.874e560a.js" rel="preload" as="script"><link href="/jak-project/css/chunk-vendors.b018c88a.css" rel="stylesheet"></head><body><noscript><strong>We're sorry but docs-and-tooling doesn't work properly without JavaScript enabled. Please enable it to continue.</strong></noscript><div id="app"></div><script src="/jak-project/js/chunk-vendors.874e560a.js"></script><script src="/jak-project/js/app.78d57e62.js"></script></body></html>
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" href="/jak-project/favicon.png"><title>OpenGOAL Tooling</title><link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:100,300,400,500,700,900"><link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@mdi/font@latest/css/materialdesignicons.min.css"><link href="/jak-project/css/about.cc2b1403.css" rel="prefetch"><link href="/jak-project/js/about.ecf9859e.js" rel="prefetch"><link href="/jak-project/css/chunk-vendors.a37b1574.css" rel="preload" as="style"><link href="/jak-project/js/app.fa6e2fe7.js" rel="preload" as="script"><link href="/jak-project/js/chunk-vendors.e35c37d1.js" rel="preload" as="script"><link href="/jak-project/css/chunk-vendors.a37b1574.css" rel="stylesheet"></head><body><noscript><strong>We're sorry but docs-and-tooling doesn't work properly without JavaScript enabled. Please enable it to continue.</strong></noscript><div id="app"></div><script src="/jak-project/js/chunk-vendors.e35c37d1.js"></script><script src="/jak-project/js/app.fa6e2fe7.js"></script></body></html>
@@ -1,2 +0,0 @@
-(function(e){function t(t){for(var n,o,i=t[0],c=t[1],l=t[2],s=0,p=[];s<i.length;s++)o=i[s],Object.prototype.hasOwnProperty.call(a,o)&&a[o]&&p.push(a[o][0]),a[o]=0;for(n in c)Object.prototype.hasOwnProperty.call(c,n)&&(e[n]=c[n]);f&&f(t);while(p.length)p.shift()();return u.push.apply(u,l||[]),r()}function r(){for(var e,t=0;t<u.length;t++){for(var r=u[t],n=!0,o=1;o<r.length;o++){var i=r[o];0!==a[i]&&(n=!1)}n&&(u.splice(t--,1),e=c(c.s=r[0]))}return e}var n={},o={app:0},a={app:0},u=[];function i(e){return c.p+"js/"+({about:"about"}[e]||e)+"."+{about:"80aba5c3"}[e]+".js"}function c(t){if(n[t])return n[t].exports;var r=n[t]={i:t,l:!1,exports:{}};return e[t].call(r.exports,r,r.exports,c),r.l=!0,r.exports}c.e=function(e){var t=[],r={about:1};o[e]?t.push(o[e]):0!==o[e]&&r[e]&&t.push(o[e]=new Promise((function(t,r){for(var n="css/"+({about:"about"}[e]||e)+"."+{about:"8d0e9591"}[e]+".css",a=c.p+n,u=document.getElementsByTagName("link"),i=0;i<u.length;i++){var l=u[i],s=l.getAttribute("data-href")||l.getAttribute("href");if("stylesheet"===l.rel&&(s===n||s===a))return t()}var p=document.getElementsByTagName("style");for(i=0;i<p.length;i++){l=p[i],s=l.getAttribute("data-href");if(s===n||s===a)return t()}var f=document.createElement("link");f.rel="stylesheet",f.type="text/css",f.onload=t,f.onerror=function(t){var n=t&&t.target&&t.target.src||a,u=new Error("Loading CSS chunk "+e+" failed.\n("+n+")");u.code="CSS_CHUNK_LOAD_FAILED",u.request=n,delete o[e],f.parentNode.removeChild(f),r(u)},f.href=a;var d=document.getElementsByTagName("head")[0];d.appendChild(f)})).then((function(){o[e]=0})));var n=a[e];if(0!==n)if(n)t.push(n[2]);else{var u=new Promise((function(t,r){n=a[e]=[t,r]}));t.push(n[2]=u);var l,s=document.createElement("script");s.charset="utf-8",s.timeout=120,c.nc&&s.setAttribute("nonce",c.nc),s.src=i(e);var p=new Error;l=function(t){s.onerror=s.onload=null,clearTimeout(f);var r=a[e];if(0!==r){if(r){var n=t&&("load"===t.type?"missing":t.type),o=t&&t.target&&t.target.src;p.message="Loading chunk "+e+" failed.\n("+n+": "+o+")",p.name="ChunkLoadError",p.type=n,p.request=o,r[1](p)}a[e]=void 0}};var f=setTimeout((function(){l({type:"timeout",target:s})}),12e4);s.onerror=s.onload=l,document.head.appendChild(s)}return Promise.all(t)},c.m=e,c.c=n,c.d=function(e,t,r){c.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:r})},c.r=function(e){"undefined"!==typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},c.t=function(e,t){if(1&t&&(e=c(e)),8&t)return e;if(4&t&&"object"===typeof e&&e&&e.__esModule)return e;var r=Object.create(null);if(c.r(r),Object.defineProperty(r,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var n in e)c.d(r,n,function(t){return e[t]}.bind(null,n));return r},c.n=function(e){var t=e&&e.__esModule?function(){return e["default"]}:function(){return e};return c.d(t,"a",t),t},c.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},c.p="/jak-project/",c.oe=function(e){throw console.error(e),e};var l=window["webpackJsonp"]=window["webpackJsonp"]||[],s=l.push.bind(l);l.push=t,l=l.slice();for(var p=0;p<l.length;p++)t(l[p]);var f=s;u.push([0,"chunk-vendors"]),r()})({0:function(e,t,r){e.exports=r("56d7")},"56d7":function(e,t,r){"use strict";r.r(t);r("e260"),r("e6cf"),r("cca6"),r("a79d");var n=r("2b0e"),o=function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("v-app",[r("v-main",[r("router-view")],1)],1)},a=[],u={name:"App",components:{},data:function(){return{}}},i=u,c=r("2877"),l=r("6544"),s=r.n(l),p=r("7496"),f=r("f6c4"),d=Object(c["a"])(i,o,a,!1,null,null,null),h=d.exports;s()(d,{VApp:p["a"],VMain:f["a"]});var m=r("f309");n["a"].use(m["a"]);var v=new m["a"]({theme:{dark:!0}}),b=(r("d3b7"),r("3ca3"),r("ddb0"),r("8c4f"));n["a"].use(b["a"]);var g=[{path:"/",name:"Home",component:function(){return r.e("about").then(r.bind(null,"bb51"))}}],y=new b["a"]({mode:"history",base:"/jak-project/",routes:g}),w=y;n["a"].config.productionTip=!1,new n["a"]({vuetify:v,router:w,render:function(e){return e(h)}}).$mount("#app")}});
-//# sourceMappingURL=app.78d57e62.js.map
@@ -0,0 +1,44 @@
+import glob
+
+src_files = glob.glob("./goal_src/**/*.g[cs]", recursive=True)
+data_files = glob.glob("./goal_src/**/*.gd", recursive=True)
+
+# Find how many of each have been started
+
+src_files_started = 0
+src_files_finished = 0
+data_files_started = 0
+
+for f in src_files:
+  with open(f, "r") as temp_file:
+    lines = temp_file.readlines()
+    line_count = len(lines)
+    if line_count > 7:
+      # Check to see if there are any TODOs
+      if any("TODO" in string for string in lines):
+        src_files_finished = src_files_finished + 1
+      else:
+        src_files_started = src_files_started + 1
+
+for f in data_files:
+  with open(f, "r") as temp_file:
+    line_count = len(temp_file.readlines())
+    if line_count > 7:
+      data_files_started = data_files_started + 1
+
+import json
+with open('./docs/gh-pages-proj/src/config/progress.json', 'r+', encoding='utf-8') as f:
+  data = {
+    'jak1': {
+      'fileProgress': {
+        'src_files_total': len(src_files),
+        'src_files_finished': src_files_finished,
+        'src_files_started': src_files_started,
+        'data_files_total': len(data_files),
+        'data_files_started': data_files_started
+      }
+    }
+  }
+  f.seek(0)
+  json.dump(data, f, ensure_ascii=False, indent=2)
+  f.truncate()