walker -> reader

Author: roguib

DESIGN.md

@@ -11,10 +11,10 @@ Once every file has been parsed, generate a JSON with the information gathered a
 ## High-level implementation
 
 ```ts
-public walker(root: string, filesExploredPath: Array<string>): Array<string>
+public reader(root: string): Array<string>
 ```
 
-The function `walker` will start at the root directory and save those files candidates of having components defined inside of them. Only will consider files with `.ts` extension. Should traverse all the file tree from the root up to the bottom and return the full path to every candidate file.
+The function `reader` will start at the root directory and save those files candidates of having components defined inside of them. Only will consider files with `.ts` extension. Should traverse all the file tree from the root up to the bottom and return the full path to every candidate file, the content of the file and the type of definition that contains that file (component, pipe or directive).
 
 ```ts
 public parser(filePaths: Array<string>): Array<File>

src/index.ts

@@ -1,11 +1,12 @@
 const path = require("path");
 const argv = process.argv;
-import * as walker from "./walker";
+import * as reader from "./reader";
 import * as parser from "./parser";
 import * as generator from "./generator";
 import { File } from "./shared/IFile";
 import logger from "./shared/logger";
 import { ICLIConfig } from "./shared/ICLIConfig";
+import { FileType } from "./shared/constants";
 
 let config: ICLIConfig = {
   workingDir: null,
@@ -65,7 +66,7 @@ export const run = async (args: string[]) => {
 
   process.env.ROOT_PROJECT_PATH = config.workingDir || path.posix.resolve();
 
-  let candidateFilePaths: Array<string> = walker.walker(process.env.ROOT_PROJECT_PATH as string, []);
+  let candidateFilePaths: Array<{ type: FileType; filePath: string; fileData: string }> = reader.reader(process.env.ROOT_PROJECT_PATH as string);
   let fileData: Array<File> = parser.parser(candidateFilePaths);
   generator.generator(fileData, config.outputDir as string);
 };

src/reader.ts

@@ -0,0 +1,49 @@
+import { Dirent } from "fs";
+import { FileType } from "./shared/constants";
+import logger from "./shared/logger";
+
+const fs = require("fs");
+const path = require("path");
+
+export const reader = (root: string): Array<{ type: FileType; filePath: string; fileData: string }> => {
+  let pendingDir: Array<string> = [root],
+    result: Array<{ type: FileType; filePath: string; fileData: string }> = [];
+
+  while (pendingDir.length > 0) {
+    let currentDir = pendingDir.shift();
+
+    if (currentDir == null) break;
+
+    const files: Dirent[] = fs.readdirSync(currentDir, {
+      encoding: "utf8",
+      withFileTypes: true,
+    });
+
+    for (let file of files) {
+      if (file.isFile() && file.name.endsWith(".ts")) {
+        logger.log("Candidate file to contain component definition:", file.name);
+        const filePath = path.join(currentDir, file.name);
+        const fileData: string = fs.readFileSync(filePath, {
+          encoding: "utf8",
+          flag: "r",
+        });
+
+        let type: FileType = "CLASS";
+        if (fileData?.match(/@Component/g)?.length || 0 > 0) {
+          type = "COMPONENT";
+        }
+
+        // In the future we will add FileType PIPE & FileType DIRECTIVE
+
+        result.push({
+          type,
+          filePath,
+          fileData,
+        });
+      } else if (file.isDirectory() && file.name != "node_modules" && file.name != ".git") {
+        pendingDir.push(path.join(currentDir, file.name));
+      }
+    }
+  }
+  return result;
+};

src/walker.ts

@@ -0,0 +1,5 @@
+import { Input } from "@angular/core";
+
+export class BaseComponent {
+  @Input() baseInput: "type1" | "type2" | "type3";
+}

tests/fixtures/ts-files/foo.ts

@@ -0,0 +1,17 @@
+import * as reader from "../src/reader";
+const path = require("path");
+
+test("Inspects /tests/fixtures/ts-files with reader function", () => {
+  expect(reader.reader(path.join(path.posix.resolve(), "tests/fixtures/ts-files"))).toStrictEqual([
+    {
+      type: "COMPONENT",
+      filePath: path.join(path.posix.resolve(), "/tests/fixtures/ts-files/foo.ts"),
+      fileData:
+        'import { Input } from "@angular/core";\r\n' +
+        "\r\n" +
+        "export class BaseComponent {\r\n" +
+        '  @Input() baseInput: "type1" | "type2" | "type3";\r\n' +
+        "}\r\n",
+    },
+  ]);
+});