Added readable check to src dir (#48)

Also: updated @yao-pkg/pkg

Author: max-leuthaeuser

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@joernio/astgen",
-  "version": "3.35.0",
+  "version": "3.36.0",
   "description": "Generate JS/TS AST in json format with Babel",
   "exports": "./index.js",
   "keywords": [
@@ -41,7 +41,7 @@
     "@types/n-readlines": "^1.0.6",
     "@types/node": "^18.11.9",
     "@types/yargs": "^17.0.33",
-    "@yao-pkg/pkg": "^6.5.1",
+    "@yao-pkg/pkg": "^6.9.0",
     "jest": "^30.0.4",
     "ts-jest": "^29.3.4"
   }

src/AstGenerator.ts

@@ -22,12 +22,12 @@ import * as fs from "node:fs"
  */
 function TWithTry<T>(errMessage: string, arg: string, f: () => O.Option<T>): O.Option<T> {
     try {
-        return f();
+        return f()
     } catch (err) {
         if (err instanceof Error) {
-            console.warn(errMessage, arg, ":", err.message);
+            console.warn(errMessage, arg, ":", err.message)
         }
-        return O.none();
+        return O.none()
     }
 }
 
@@ -42,8 +42,8 @@ function TWithTry<T>(errMessage: string, arg: string, f: () => O.Option<T>): O.O
  */
 function VoidWithTry(errMessage: string, arg: string, f: () => void): void {
     TWithTry(errMessage, arg, () => {
-        f();
-        return O.none();
+        f()
+        return O.none()
     })
 }
 
@@ -58,7 +58,7 @@ function VoidWithTry(errMessage: string, arg: string, f: () => void): void {
  * @see codeToJsAst - The underlying function used for parsing code strings
  */
 function fileToJsAst(file: string): babelParser.ParseResult {
-    return codeToJsAst(fs.readFileSync(file, "utf-8"));
+    return codeToJsAst(fs.readFileSync(file, "utf-8"))
 }
 
 /**
@@ -76,9 +76,9 @@ function fileToJsAst(file: string): babelParser.ParseResult {
  */
 function codeToJsAst(code: string): babelParser.ParseResult {
     try {
-        return babelParser.parse(code, Defaults.BABEL_PARSER_OPTIONS);
+        return babelParser.parse(code, Defaults.BABEL_PARSER_OPTIONS)
     } catch {
-        return babelParser.parse(code, Defaults.SAFE_BABEL_PARSER_OPTIONS);
+        return babelParser.parse(code, Defaults.SAFE_BABEL_PARSER_OPTIONS)
     }
 }
 
@@ -96,9 +96,9 @@ function codeToJsAst(code: string): babelParser.ParseResult {
  * @see codeToJsAst - The underlying function used for parsing the extracted code
  */
 function toVueAst(file: string): babelParser.ParseResult {
-    const code = fs.readFileSync(file, "utf-8");
+    const code = fs.readFileSync(file, "utf-8")
     const cleanedCode = VueCodeCleaner.cleanVueCode(code)
-    return codeToJsAst(cleanedCode);
+    return codeToJsAst(cleanedCode)
 }
 
 /**
@@ -115,9 +115,9 @@ function toVueAst(file: string): babelParser.ParseResult {
  * @see TscUtils - The utility class used for TypeScript type extraction
  */
 function buildTscUtils(files: string[], options: Options): O.Option<TscUtils> {
-    if (!options.tsTypes || files.length === 0) return O.none();
+    if (!options.tsTypes || files.length === 0) return O.none()
     return TWithTry("Retrieving types", "", () => {
-        return O.some(new TscUtils(files));
+        return O.some(new TscUtils(files))
     })
 }
 
@@ -136,12 +136,12 @@ function buildTscUtils(files: string[], options: Options): O.Option<TscUtils> {
  */
 async function createJSAst(options: Options): Promise<void> {
     try {
-        const srcFiles: string[] = await FileUtils.filesWithExtensions(options, Defaults.JS_EXTENSIONS);
-        const tscUtils: O.Option<TscUtils> = buildTscUtils(srcFiles, options);
+        const srcFiles: string[] = await FileUtils.filesWithExtensions(options, Defaults.JS_EXTENSIONS)
+        const tscUtils: O.Option<TscUtils> = buildTscUtils(srcFiles, options)
         for (const file of srcFiles) {
             VoidWithTry("Parsing", file, () => {
-                const ast: babelParser.ParseResult = fileToJsAst(file);
-                writeAstFile(file, ast, options);
+                const ast: babelParser.ParseResult = fileToJsAst(file)
+                writeAstFile(file, ast, options)
                 VoidWithTry("Retrieving types", file, () => {
                     pipe(
                         tscUtils,
@@ -153,7 +153,7 @@ async function createJSAst(options: Options): Promise<void> {
             })
         }
     } catch (err) {
-        console.error(err);
+        console.error(err)
     }
 }
 
@@ -168,10 +168,10 @@ async function createJSAst(options: Options): Promise<void> {
  * @returns A Promise that resolves when all Vue files have been processed.
  */
 async function createVueAst(options: Options): Promise<void> {
-    const srcFiles: string[] = await FileUtils.filesWithExtensions(options, [".vue"]);
+    const srcFiles: string[] = await FileUtils.filesWithExtensions(options, [".vue"])
     for (const file of srcFiles) {
         VoidWithTry("", file, () => {
-            writeAstFile(file, toVueAst(file), options);
+            writeAstFile(file, toVueAst(file), options)
         })
     }
 }
@@ -189,15 +189,15 @@ async function createVueAst(options: Options): Promise<void> {
  */
 function writeAstFile(file: string, ast: babelParser.ParseResult, options: Options): void {
     const relativePath: string = path.relative(options.src, file)
-    const outAstFile: string = path.join(options.output, relativePath + ".json");
+    const outAstFile: string = path.join(options.output, relativePath + ".json")
     const data = {
         fullName: file,
         relativeName: relativePath,
         ast: ast,
-    };
-    fs.mkdirSync(path.dirname(outAstFile), {recursive: true});
-    fs.writeFileSync(outAstFile, JsonUtils.stringifyCircular(data));
-    console.log("Converted AST for", relativePath, "to", outAstFile);
+    }
+    fs.mkdirSync(path.dirname(outAstFile), {recursive: true})
+    fs.writeFileSync(outAstFile, JsonUtils.stringifyCircular(data))
+    console.log("Converted AST for", relativePath, "to", outAstFile)
 }
 
 /**
@@ -212,10 +212,10 @@ function writeAstFile(file: string, ast: babelParser.ParseResult, options: Optio
  */
 function writeTypesFile(file: string, seenTypes: TypeMap, options: Options): void {
     const relativePath: string = path.relative(options.src, file)
-    const outTypeFile: string = path.join(options.output, relativePath + ".typemap");
-    fs.mkdirSync(path.dirname(outTypeFile), {recursive: true});
-    fs.writeFileSync(outTypeFile, JsonUtils.stringify(Object.fromEntries(seenTypes)));
-    console.log("Converted types for", relativePath, "to", outTypeFile);
+    const outTypeFile: string = path.join(options.output, relativePath + ".typemap")
+    fs.mkdirSync(path.dirname(outTypeFile), {recursive: true})
+    fs.writeFileSync(outTypeFile, JsonUtils.stringify(Object.fromEntries(seenTypes)))
+    console.log("Converted types for", relativePath, "to", outTypeFile)
 }
 
 /**
@@ -229,21 +229,15 @@ function writeTypesFile(file: string, seenTypes: TypeMap, options: Options): voi
  * @returns A Promise that resolves when AST generation is complete or the process exits on error.
  */
 async function createXAst(options: Options): Promise<void> {
-    const srcDir: string = options.src;
-    try {
-        fs.accessSync(srcDir, fs.constants.R_OK);
-    } catch (err) {
-        console.error(srcDir, "is invalid");
-        process.exit(1);
-    }
+    const srcDir: string = options.src
     if (
-        fs.existsSync(path.join(srcDir, "package.json")) ||
-        fs.existsSync(path.join(srcDir, "rush.json"))
+        FileUtils.fileExistsAndIsReadable(path.join(srcDir, "package.json")) ||
+        FileUtils.fileExistsAndIsReadable(path.join(srcDir, "rush.json"))
     ) {
-        return await createJSAst(options);
+        return await createJSAst(options)
     }
-    console.error(srcDir, "unknown project type");
-    process.exit(1);
+    console.error("Unknown project type:", srcDir)
+    process.exit(1)
 }
 
 /**
@@ -259,17 +253,23 @@ async function createXAst(options: Options): Promise<void> {
  * @returns A Promise that resolves when the AST generation process is complete.
  */
 export default async function start(options: Options): Promise<void> {
+    const srcDir = options.src
+    if (!FileUtils.fileExistsAndIsReadable(srcDir)) {
+        console.error("Source directory does not exist or is not readable:", srcDir)
+        process.exit(1)
+    }
+
     const type: string = (options.type || "").toLowerCase()
     switch (type) {
         case "nodejs":
         case "js":
         case "javascript":
         case "typescript":
         case "ts":
-            return await createJSAst(options);
+            return await createJSAst(options)
         case "vue":
-            return await createVueAst(options);
+            return await createVueAst(options)
         default:
-            return await createXAst(options);
+            return await createXAst(options)
     }
 }

src/Defaults.ts

@@ -1,5 +1,5 @@
-import babelParser from "@babel/parser";
-import tsc from "typescript";
+import babelParser from "@babel/parser"
+import tsc from "typescript"
 
 export const JS_EXTENSIONS: string[] = [
     ".js",
@@ -31,12 +31,12 @@ export const IGNORE_DIRS: string[] = [
     "www",
     "dist",
     "build",
-];
+]
 
 export const IGNORE_FILE_PATTERN: RegExp =
-    new RegExp("(chunk-vendors|app~|mock|e2e|conf|test|spec|[.-]min|\\.d)\\.(js|jsx|cjs|mjs|xsjs|xsjslib|ts|tsx)$", "i");
+    new RegExp("(chunk-vendors|app~|mock|e2e|conf|test|spec|[.-]min|\\.d)\\.(js|jsx|cjs|mjs|xsjs|xsjslib|ts|tsx)$", "i")
 
-export const MAX_LOC_IN_FILE: number = 50000;
+export const MAX_LOC_IN_FILE: number = 50000
 
 export const BABEL_PARSER_OPTIONS: babelParser.ParserOptions = {
     sourceType: "unambiguous",
@@ -58,7 +58,7 @@ export const BABEL_PARSER_OPTIONS: babelParser.ParserOptions = {
         "jsx",
         "typescript",
     ],
-};
+}
 
 export const SAFE_BABEL_PARSER_OPTIONS: babelParser.ParserOptions = {
     sourceType: "module",
@@ -76,7 +76,7 @@ export const SAFE_BABEL_PARSER_OPTIONS: babelParser.ParserOptions = {
         "dynamicImport",
         "typescript",
     ],
-};
+}
 
 export const DEFAULT_TSC_OPTIONS: tsc.CompilerOptions = {
     target: tsc.ScriptTarget.ES2020,

src/FileUtils.ts

@@ -1,16 +1,16 @@
-import Options from "./Options";
-import * as Defaults from "./Defaults";
+import Options from "./Options"
+import * as Defaults from "./Defaults"
 
-import {readdirpPromise} from 'readdirp';
-import * as fs from "node:fs";
-import nReadlines from "n-readlines";
+import {readdirpPromise} from 'readdirp'
+import * as fs from "node:fs"
+import nReadlines from "n-readlines"
 import * as path from "node:path"
 
 function countFileLines(filePath: string): number {
-    const broadbandLines = new nReadlines(filePath);
-    let lineNumber = 1;
+    const broadbandLines = new nReadlines(filePath)
+    let lineNumber = 1
     while (broadbandLines.next()) {
-        lineNumber++;
+        lineNumber++
     }
     return lineNumber
 }
@@ -43,18 +43,18 @@ function ignoreDirectory(options: Options, dirName: string, fullPath: string): b
 
 function isEmscripten(fileWithDir: string): boolean {
     if (fs.readFileSync(fileWithDir, "utf-8").toString().includes("// EMSCRIPTEN_START_ASM")) {
-        console.warn("Parsing", fileWithDir, ":", "File skipped as it contains EMSCRIPTEN code");
-        return true;
+        console.warn("Parsing", fileWithDir, ":", "File skipped as it contains EMSCRIPTEN code")
+        return true
     }
-    return false;
+    return false
 }
 
 function isTooLarge(fileWithDir: string): boolean {
     if (countFileLines(fileWithDir) > Defaults.MAX_LOC_IN_FILE) {
-        console.warn(fileWithDir, "more than", Defaults.MAX_LOC_IN_FILE, "lines of code");
-        return true;
+        console.warn(fileWithDir, "more than", Defaults.MAX_LOC_IN_FILE, "lines of code")
+        return true
     }
-    return false;
+    return false
 }
 
 function ignoreFile(options: Options, fileName: string, fullPath: string, extensions: string[]): boolean {
@@ -82,7 +82,22 @@ export async function filesWithExtensions(options: Options, extensions: string[]
         fileFilter: (f) => !ignoreFile(options, f.basename, f.fullPath, extensions),
         directoryFilter: (d) => !ignoreDirectory(options, d.basename, d.fullPath),
         lstat: true
-    });
+    })
     // @ts-ignore
-    return files.map(file => file.fullPath);
+    return files.map(file => file.fullPath)
 }
+
+/**
+ * Checks if the folder or file at the given path exists and is readable.
+ *
+ * @param path - The path to the folder or file to check.
+ * @returns True if the folder or file exists and is readable; false otherwise.
+ */
+export function fileExistsAndIsReadable(path: string): boolean {
+    try {
+        fs.accessSync(path, fs.constants.R_OK)
+        return true
+    } catch (err) {
+        return false
+    }
+}

src/JsonUtils.ts

@@ -4,17 +4,17 @@
  * @returns {(key: any, value: any) => any} A replacer function for JSON.stringify.
  */
 const getCircularReplacer = () => {
-    const seen = new WeakSet();
+    const seen = new WeakSet()
     return (_: any, value: any): any => {
         if (typeof value === "object" && value !== null) {
             if (seen.has(value)) {
-                return;
+                return
             }
-            seen.add(value);
+            seen.add(value)
         }
-        return value;
-    };
-};
+        return value
+    }
+}
 
 /**
  * Safely serializes objects with potential circular references to a JSON string.