wip: convert recordFrames into Typescript; stubbed out renderFrames

sillsdev · Dec 14, 2020 · e39eb19 · e39eb19
1 parent 4ddd299
commit e39eb19
Show file tree

Hide file tree

Showing 9 changed files with 137 additions and 31 deletions.
diff --git a/.gitignore b/.gitignore
@@ -29,3 +29,6 @@ binaries/ffmpeg
 binaries/ffprobe
 
 .eslintcache
+
+# incrementally move to typescript.  Here are ignored JS files that are compiled
+/public/cli/lib/rendering/**/*.js
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -29,5 +29,6 @@
     "tempy",
     "usfm",
     "webm"
-  ]
+  ],
+  "typescript.tsdk": "node_modules\\typescript\\lib"
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -16,6 +16,9 @@
     "@babel/plugin-proposal-decorators": "^7.10.5",
     "@blueprintjs/core": "^3.30.0",
     "@blueprintjs/select": "^3.13.5",
+    "@types/node": "^14.14.13",
+    "@types/react": "^17.0.0",
+    "@types/react-dom": "^17.0.0",
     "async": "^3.2.0",
     "chalk": "^2.4.2",
     "chromium": "^2.1.2",
@@ -54,9 +57,8 @@
     "cli": "node public/cli/index.js",
     "electron-dev": "concurrently \"cross-env BROWSER=none npm run start\" \"wait-on http://localhost:3000 && electron . --inspect 9229\"",
     "start": "ffbinaries ffmpeg ffprobe -o=binaries && rescripts start",
-    "build": "ffbinaries ffmpeg ffprobe -o=binaries && rescripts build",
-    "test": "ava --watch",
-    "eject": "react-scripts eject",
+    "build": "tsc && ffbinaries ffmpeg ffprobe -o=binaries && rescripts build",
+    "test": "tsc && ava",
     "postinstall": "electron-builder install-app-deps",
     "preelectron-pack-mac": "npm run build",
     "preelectron-pack-win": "npm run build",
@@ -89,8 +91,10 @@
     ]
   },
   "devDependencies": {
+    "@ava/typescript": "^1.1.1",
     "@rescripts/cli": "^0.0.13",
     "@rescripts/rescript-env": "^0.0.11",
+    "@tsconfig/node12": "^1.0.7",
     "ava": "^3.13.0",
     "babel-eslint": "^10.1.0",
     "concurrently": "^5.2.0",

diff --git a/...ic/cli/lib/rendering/recordFrames.spec.js → ...ic/cli/lib/rendering/recordFrames.spec.ts b/...ic/cli/lib/rendering/recordFrames.spec.js → ...ic/cli/lib/rendering/recordFrames.spec.ts
@@ -1,24 +1,21 @@
-const test = require('ava');
-const tempy = require('tempy');
-const { promises: fs } = require('fs');
-const { record } = require('./recordFrames');
+import test from 'ava';
+import tempy from 'tempy';
+import fs from 'fs';
+import { record } from './recordFrames';
 
 test('recordFrames: render 5 mock frames', async (t) => {
   let htmlContent = createMockHtml();
   const numberOfFrames = 5;
   await tempy.directory.task(async (outputLocation) => {
-    let files = await fs.readdir(outputLocation);
+    let files = fs.readdirSync(outputLocation);
     t.is(files.length, 0);
     await record(htmlContent, numberOfFrames, outputLocation);
-    files = await fs.readdir(outputLocation);
+    files = fs.readdirSync(outputLocation);
     t.is(files.length, numberOfFrames);
   });
 });
 
-/**
- * @returns {string}
- */
-function createMockHtml() {
+function createMockHtml(): string {
   return `
   <html>
   <script>

diff --git a/public/cli/lib/rendering/recordFrames.js → public/cli/lib/rendering/recordFrames.ts b/public/cli/lib/rendering/recordFrames.js → public/cli/lib/rendering/recordFrames.ts
@@ -2,20 +2,17 @@ const puppeteer = require('puppeteer-core');
 const chromium = require('chromium');
 const path = require('path');
 
-/**
- *
- * @param {string} htmlContent
- * @param {number} numberOfFrames
- * @param {string} outputLocation
- * @param {boolean} logEachFrame
- * @param {Function} notifyEvent TODO: I don't know what object or function this is yet
- */
-module.exports.record = async function (
-  htmlContent,
-  numberOfFrames,
-  outputLocation,
+interface NotifyEvent {
+  emit(state: string, options: object): void;
+}
+declare function renderNextFrame(): void;
+
+export async function record(
+  htmlContent: string,
+  numberOfFrames: number,
+  outputLocation: string,
   logEachFrame = false,
-  notifyEvent = false
+  notifyEvent: NotifyEvent | null = null
 ) {
   // chromium.path may or may provide a path in an asar archive.  If it does
   // it is unusable, and we'll attempt to swap it out for the un-archived version
@@ -51,4 +48,4 @@ module.exports.record = async function (
       notifyEvent.emit('rendered', { curr: i, total: numberOfFrames });
     }
   }
-};
+}
diff --git a/public/cli/lib/rendering/renderFrames.spec.ts b/public/cli/lib/rendering/renderFrames.spec.ts
@@ -0,0 +1,18 @@
+import test from 'ava';
+import tempy from 'tempy';
+import fs from 'fs';
+
+test('renderFrames hello world', async (t) => {
+  /*
+  let htmlContent = createMockHtml();
+  const numberOfFrames = 5;
+  await tempy.directory.task(async (outputLocation) => {
+    let files = fs.readdirSync(outputLocation);
+    t.is(files.length, 0);
+    await record(htmlContent, numberOfFrames, outputLocation);
+    files = fs.readdirSync(outputLocation);
+    t.is(files.length, numberOfFrames);
+  });
+  */
+  t.pass();
+});
diff --git a/public/cli/lib/rendering/renderFrames.ts b/public/cli/lib/rendering/renderFrames.ts
@@ -0,0 +1,16 @@
+import { record } from './recordFrames';
+
+export async function render(outputLocation: string) {
+  // collect UI options
+
+  // load caption/frames object
+  let captions = {};
+
+  // create HTMLcontent
+  const htmlContent = getHtml(captions);
+
+  // run record
+  //await record(htmlContent, numberOfFrames, outputLocation, notifyEvent);
+}
+
+function getHtml(captions: object) {}
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,10 @@
+{
+  "extends": "@tsconfig/node12/tsconfig.json",
+
+  "compilerOptions": {
+    "preserveConstEnums": true
+  },
+
+  "include": ["public/cli/lib/rendering/**/*.ts"],
+  "exclude": ["node_modules"]
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -29,5 +29,6 @@ @@
         "tempy",
         "usfm",
         "webm"
-      ]
+      ],
+      "typescript.tsdk": "node_modules\\typescript\\lib"
     }