spec: add reg (bokuweb#774)

* spec: add reg

* fix

* fix

* fix

.github/workflows/ci.yml

@@ -65,6 +65,9 @@ jobs:
 
   build-wasm:
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./docx-wasm    
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
@@ -77,7 +80,16 @@ jobs:
       - run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
       - run: rustup target add wasm32-unknown-unknown
       - run: npm install -g pnpm
-      - run: cd docx-wasm && pnpm install && pnpm wasm-pack:node && pnpm wasm-pack:dev && tsc -p tsconfig.node.json && pnpm test
+      - run: pnpm install && pnpm wasm-pack:node && pnpm wasm-pack:dev && tsc -p tsconfig.node.json && pnpm test
+      - name: screenshot
+        run: pnpm screenshot
+      - uses: reg-viz/reg-actions@v2
+        with:
+          github-token: '${{ secrets.GITHUB_TOKEN }}'
+          image-directory-path: 'docx-wasm/export-png/png'
+          threshold-rate: 0.06
+          enable-antialias: true
+          matching-threshold: 0.5
 
   lint:
     name: Clippy

docx-wasm/export-png/.gitignore

@@ -0,0 +1 @@
+png/*.png

docx-wasm/export-png/index.mjs

@@ -0,0 +1,29 @@
+import fs from "fs";
+import cp from "child_process";
+import path from "path";
+import { fileURLToPath } from "node:url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const fileType = "png";
+
+const inputDir = process.env.OUTPUT_DIR ?? process.exit(1);
+const files = fs.readdirSync(inputDir);
+
+for (const file of files) {
+  if (/\.docx$/.test(file)) {
+    console.log(file);
+    const spawn = cp.spawnSync("make", [
+      "run",
+      `INPUT=${path.join(inputDir, file)}`,
+      `OUTPUT=${path.join(
+        __dirname,
+        "png",
+        file.replace(/\.docx$/, `.${fileType}`)
+      )}`,
+    ]);
+    console.log(spawn.stdout.toString());
+    //break;
+  }
+}

docx-wasm/export-png/makefile

@@ -0,0 +1,30 @@
+# docx directory
+OUTPUT_DIR=../../output/js
+
+# For more information for this image, see  https://github.com/yuntara/docx-png-converter
+REPOSITORY_BASE:=yuntara
+IMAGE:=${REPOSITORY_BASE}/docx-png-converter
+
+# PNG dpi
+DENSITY:=150
+
+pull:
+	docker pull ${IMAGE}
+
+run:
+	cat ${INPUT} | docker exec -i docx-png-converter bash /root/run.sh ${DENSITY} > ${OUTPUT}
+
+start:
+	make stop
+	make pull
+	docker run --name docx-png-converter -itd ${IMAGE} /bin/bash 
+
+convert-all: 
+	make start
+	OUTPUT_DIR=${OUTPUT_DIR} node index.mjs
+	make stop
+
+stop:
+	- docker kill docx-png-converter
+	- docker rm docx-png-converter
+

docx-wasm/export-png/tsconfig.json

@@ -0,0 +1,70 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
+    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    // "outDir": "./",                        /* Redirect output structure to the directory. */
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+    // "noUncheckedIndexedAccess": true,      /* Include 'undefined' in index signature results */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
+    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
+  }
+}

docx-wasm/package.json

@@ -10,6 +10,7 @@
     "wasm-pack:web": "wasm-pack build --release --out-dir dist/web/pkg && rm dist/web/pkg/.gitignore",
     "wasm-pack:node": "wasm-pack build --release --out-dir dist/node/pkg --target nodejs  && rm dist/node/pkg/.gitignore",
     "wasm-pack": "run-s wasm-pack:*",
+    "screenshot": "cd export-png && make convert-all",
     "tsc:web": "tsc -p tsconfig.web.json --sourcemap",
     "tsc:node": "tsc -p tsconfig.node.json --sourcemap",
     "tsc": "run-s tsc:*",
@@ -53,4 +54,4 @@
   "module": "dist/web/index.js",
   "types": "dist/web/index.d.ts",
   "dependencies": {}
-}
+}