Add typescript support (#219)

* Add typescript support

* Make jekyll work on docker-compose on windows

Author: nanomad

.github/workflows/pages.yml

@@ -30,6 +30,14 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      - name: Install Node deps
+        run: npm ci
+      - name: Compile typescript
+        run: npm run build
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:

.gitignore

@@ -4,4 +4,6 @@ _site/
 .jekyll-cache/
 .jekyll-metadata
 Gemfile.lock
-assets/js/zzzz-search-data.json
+assets/js/zzzz-search-data.json
+node_modules/
+assets/js/generated

README.md

@@ -13,4 +13,14 @@ if you want to contribute there is something to be done:
 - theoretical information on GPON
 - absent stick information
 - quick start
-- absent and new ont
+- absent and new ont
+
+##  How to build
+This website uses typescript, so remember to:
+
+- Install node (20)
+- Run npm ci to install all relevant typescript packages
+- Run npm run build to transpile ts to js
+
+Alternatively, you can just run:
+`docker-compose up -d typescript` which will build all the required typescript files for you

_config.docker.yml

@@ -0,0 +1 @@
+url: "http://localhost:4000"

_ont_xgs/ont-hisense-ltf7267-bha+.md

@@ -330,7 +330,7 @@ Reboot ONT to apply the change
     </div>
 </form>
 
-<script type="text/javascript" src="/assets/js/LTF7267-BHA-ploam.js"></script>
+<script type="text/javascript" src="/assets/js/generated/LTF7267-BHA-ploam.js"></script>
 <script type="text/javascript">
     var hisensePloamForm = document.getElementById('hisense-ploam');
     var hisenseResult = document.getElementById('ploam-encoded');

assets/js/LTF7267-BHA-ploam.js

@@ -0,0 +1,29 @@
+function hexEncode(str: String): String {
+
+    var result = "";
+    for (let i = 0; i < str.length; i++) {
+        const hex = str.charCodeAt(i).toString(16);
+        result += hex.padStart(2, "0");
+    }
+
+    return result;
+}
+
+function hisensePloam(ascii_ploam: String): String {
+    const hex_ploam = hexEncode(ascii_ploam);
+    const hex_padded_ploam = hex_ploam.padEnd(72, "0");
+    let array: String[] = [];
+    for (let i = 0; i < 9; i++) {
+        const ploam_segment = hex_padded_ploam.slice(i * 8, (i + 1) * 8);
+        let new_ploam_segment = "";
+        for (let j = 4; j > 0; j--) {
+            new_ploam_segment = new_ploam_segment + ploam_segment.slice((j - 1) * 2, j * 2);
+        }
+        if (new_ploam_segment !== "00000000") {
+            array.push("INT             CFG_ID_PON_REGISTRATION_ID" + i + "                                        = 0x" + new_ploam_segment + ";");
+        }
+    }
+    return array.join("\n");
+}
+
+(window as any).hisensePloam = hisensePloam;

assets/ts/LTF7267-BHA-ploam.ts

@@ -1,10 +1,25 @@
-version: "3"
+version: "3.3"
 
 services:
+  typescript:
+    image: node:20
+    command: sh -c "cd /mnt && npm ci && npm run build"
+    restart: on-failure
+    volumes:
+      - ./tsup.config.ts:/mnt/tsup.config.ts
+      - ./package.json:/mnt/package.json
+      - ./package-lock.json:/mnt/package-lock.json
+      - ./assets:/mnt/assets
   site:
-    command: jekyll serve --verbose --incremental --force_polling
     image: jekyll/jekyll:latest 
+    command: jekyll serve --verbose --incremental --force_polling --config  _config.yml,_config.docker.yml
+    environment:
+      - JEKYLL_ENV=docker
     volumes:
       - .:/srv/jekyll
     ports:
       - 4000:4000
+    depends_on:
+      typescript:
+        condition: service_completed_successfully
+