Added basic tests (#23)

Author: max-leuthaeuser

jest.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    transform: {'^.+\\.ts?$': 'ts-jest'},
+    testRegex: '/test/.*\\.(test|spec)?\\.(ts|tsx)$',
+    moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node']
+};

.github/workflows/pr.yml

@@ -25,6 +25,11 @@ jobs:
         run: |
           yarn install
           yarn build
+      - name: Test
+        run: |
+          yarn test
+      - name: Create Binaries
+        run: |
           yarn binary
       - name: Rename
         run: |

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@joernio/astgen",
-  "version": "3.19.0",
+  "version": "3.20.0",
   "description": "Generate JS/TS AST in json format with Babel",
   "exports": "./index.js",
   "keywords": [
@@ -20,23 +20,29 @@
     "yargs": "^17.7.2"
   },
   "scripts": {
+    "test": "jest --silent --config=\" jest.config.js\"",
     "build": "tsc --build",
     "binary": "pkg . --options max-old-space-size=8192 --no-bytecode --no-native-build --public --compress GZip --targets node18-linux-x64,node18-linux-arm64,node18-macos-x64,node18-win-x64,node18-macos-arm64"
   },
   "engines": {
     "node": ">=16.0.0"
   },
   "files": [
-    "*.js",
-    "dist/"
+    "dist/**/*.js"
   ],
+  "directories": {
+    "test": "test"
+  },
   "devDependencies": {
-    "@tsconfig/node16": "^16.1.3",
+    "@tsconfig/node18": "^18.2.4",
     "@types/n-readlines": "^1.0.6",
-    "@types/node": "^16.1.3",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^18.2.4",
     "@types/yargs": "^17.0.33",
     "cross-env": "^7.0.3",
+    "jest": "^29.7.0",
     "pkg": "^5.8.1",
+    "ts-jest": "^29.2.5",
     "typescript": "^5.5.3"
   }
 }

src/FileUtils.ts

@@ -1,4 +1,4 @@
-import * as Defaults from "./Defaults.js";
+import * as Defaults from "./Defaults";
 
 import {readdirpPromise} from 'readdirp';
 import * as fs from "node:fs";

src/TscUtils.ts

@@ -1,4 +1,4 @@
-import * as Defaults from "./Defaults.js";
+import * as Defaults from "./Defaults";
 
 import tsc from "typescript";
 

src/astgen.ts

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 
-import start from "./index.js"
-import Options from "./Options.js"
+import start from "./index"
+import Options from "./Options"
 
-import path from "path"
+import * as path from "node:path"
 import yargs from "yargs"
 import {hideBin} from "yargs/helpers"
 

src/index.ts

@@ -1,14 +1,14 @@
-import Options from "./Options.js"
-import * as Defaults from "./Defaults.js"
-import * as FileUtils from "./FileUtils.js"
-import * as JsonUtils from "./JsonUtils.js"
-import * as VueCodeCleaner from "./VueCodeCleaner.js"
-import * as TscUtils from "./TscUtils.js"
+import Options from "./Options"
+import * as Defaults from "./Defaults"
+import * as FileUtils from "./FileUtils"
+import * as JsonUtils from "./JsonUtils"
+import * as VueCodeCleaner from "./VueCodeCleaner"
+import * as TscUtils from "./TscUtils"
 
 import * as babelParser from "@babel/parser"
 import * as babelTypes from "@babel/types"
 import tsc, {SourceFile} from "typescript"
-import path from "node:path"
+import * as path from "node:path"
 import * as fs from "node:fs"
 
 /**

test/astgen.test.ts

@@ -0,0 +1,27 @@
+import * as path from "node:path"
+import * as os from "node:os"
+import * as fs from "node:fs"
+import start from "../src/index"
+
+describe('astgen basic functionality', () => {
+    it('should parse simple js file correctly', async () => {
+        const tmpDir: string = fs.mkdtempSync(path.join(os.tmpdir(), "astgen-tests"));
+        const testFile = path.join(tmpDir, "main.js");
+        fs.writeFileSync(testFile, "console.log(\"Hello, world!\");");
+
+        await start({
+            src: tmpDir,
+            type: "js",
+            output: path.join(tmpDir, "ast_out"),
+            recurse: true,
+            tsTypes: true
+        });
+        const resultAst = fs.readFileSync(path.join(tmpDir, "ast_out", "main.js.json")).toString();
+        expect(resultAst).toContain("\"fullName\":\"" + testFile.replaceAll("\\", "\\\\") + "\"");
+        expect(resultAst).toContain("\"relativeName\":\"main.js\"");
+        const resultTypes = fs.readFileSync(path.join(tmpDir, "ast_out", "main.js.typemap")).toString();
+        expect(resultTypes).toEqual("{\"0\":\"Console\",\"8\":\"{ (...data: any[]): void; (message?: any, ...optionalParams: any[]): void; }\",\"12\":\"\\\"Hello, world!\\\"\"}");
+
+        fs.rmSync(tmpDir, {recursive: true});
+    });
+});

tsconfig.json

@@ -1,10 +1,15 @@
 {
-  "extends": "@tsconfig/node16/tsconfig.json",
-  "include": ["src/**/*"],
-  "exclude": ["node_modules"],
+  "extends": "@tsconfig/node18/tsconfig.json",
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules"
+  ],
   "compilerOptions": {
     "sourceMap": true,
-    "outDir": "dist"
+    "outDir": "dist",
+    "rootDir": "./src"
   }
 }