new 2 version

goerwin · Jul 17, 2024 · d656b9e · d656b9e
1 parent b4090ed
commit d656b9e
Show file tree

Hide file tree

Showing 18 changed files with 826 additions and 181 deletions.
diff --git a/.directoryvalidator.json b/.directoryvalidator.json
@@ -3,9 +3,10 @@
     ".gitignore",
     ".directoryvalidator.json",
     "package-lock.json",
-    ".DS_Store"
+    ".DS_Store",
+    "**/.DS_Store"
   ],
-  "ignoreDirs": ["node_modules", "dist", ".git", ".github"],
+  "ignoreDirs": ["node_modules", "dist", ".git", ".github", "**/temp42"],
   "commonRules": {
     "rule_indexfile": {
       "type": "file",
@@ -15,33 +16,17 @@
   "rules": [
     {
       "type": "file",
-      "name": "package.json"
-    },
-    {
-      "type": "file",
-      "name": "LICENSE"
-    },
-    {
-      "type": "file",
-      "name": "tsconfig.json"
-    },
-    {
-      "type": "file",
-      "name": "jest.*.js"
-    },
-    {
-      "type": "file",
-      "name": "*.md"
-    },
-    {
-      "type": "file",
-      "name": ".prettier*"
+      "name": "testfile.json"
     },
     {
       "type": "directory",
-      "name": "src",
-      "isOptional": true,
-      "rules": []
+      "name": "temp2",
+      "rules": [
+        {
+          "type": "directory",
+          "name": "temp3"
+        }
+      ]
     }
   ]
 }
diff --git a/biome.json b/biome.json
@@ -0,0 +1,28 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.8.2/schema.json",
+  "organizeImports": {
+    "enabled": true
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space"
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "complexity": {
+        "noForEach": "off"
+      },
+      "correctness": {
+        "noUnusedImports": "error",
+        "noUnusedVariables": "error"
+      }
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single"
+    }
+  }
+}
diff --git a/package.json b/package.json
@@ -7,10 +7,11 @@
     "directory-validator": "dist/index.js"
   },
   "scripts": {
+    "dev": "npx tsx src/index.ts",
     "build": "npm run clean && tsc && cp src/resources/* dist/resources",
     "clean": "rm -rf dist",
     "prettier": "prettier -c .",
-    "test": "npm run prettier && jest"
+    "test": "jest"
   },
   "author": "Erwin Gaitan O <[email protected]>",
   "license": "MIT",

diff --git a/src/_tests/program/index.test.ts b/src/_tests/program/index.test.ts
@@ -1,4 +1,4 @@
-import * as path from 'path';
+import path from 'node:path';
 import * as errors from '../../errors';
 import * as program from '../../program';
 

diff --git a/src/_tests/validator/directory.ts b/src/_tests/validator/directory.ts
@@ -1,4 +1,4 @@
-import * as types from '../../types';
+import type * as types from '../../types';
 import * as validator from '../../validator';
 
 export function run() {
@@ -61,7 +61,7 @@ export function run() {
       ];
 
       expect(() => validator.run(files, configObject)).toThrowError(
-        `${JSON.stringify(configObject[0])}, deep: 1, rule did not passed`
+        `${JSON.stringify(configObject[0])}, deep: 1, rule did not passed`,
       );
     });
 
@@ -158,7 +158,7 @@ export function run() {
       ];
 
       expect(() => validator.run(files, configObject)).toThrowError(
-        '}, deep: 2, rule did not passed'
+        '}, deep: 2, rule did not passed',
       );
     });
 
@@ -172,7 +172,7 @@ export function run() {
       ];
 
       expect(() => validator.run(files, configObject)).toThrowError(
-        `${JSON.stringify(configObject[0])}, deep: 1, rule did not passed`
+        `${JSON.stringify(configObject[0])}, deep: 1, rule did not passed`,
       );
     });
 
@@ -233,7 +233,7 @@ export function run() {
     });
 
     describe('EmptyDirs:', () => {
-      it('should validate empty dir has no rules', () => {
+      it('should validate empty dir with no rules', () => {
         const files: string[] = [];
         const emptyDirs = ['src'];
 
@@ -245,7 +245,29 @@ export function run() {
         ];
 
         expect(() =>
-          validator.run(files, configObject, emptyDirs)
+          validator.run(files, configObject, emptyDirs),
+        ).not.toThrow();
+      });
+
+      it('should validate nested empty dir with no rules', () => {
+        const files: string[] = [];
+        const emptyDirs = ['src/lol'];
+        const configObject: types.Rules = [
+          {
+            name: 'src',
+            type: 'directory',
+            rules: [
+              {
+                name: 'lol',
+                type: 'directory',
+                rules: [],
+              },
+            ],
+          },
+        ];
+
+        expect(() =>
+          validator.run(files, configObject, emptyDirs),
         ).not.toThrow();
       });
 
@@ -262,9 +284,9 @@ export function run() {
         ];
 
         expect(() =>
-          validator.run(files, configObject, emptyDirs)
+          validator.run(files, configObject, emptyDirs),
         ).toThrowError(
-          `${JSON.stringify(configObject[0])}, deep: 1, rule did not passed`
+          `${JSON.stringify(configObject[0])}, deep: 1, rule did not passed`,
         );
       });
 
@@ -280,7 +302,7 @@ export function run() {
         ];
 
         expect(() =>
-          validator.run(files, configObject, emptyDirs)
+          validator.run(files, configObject, emptyDirs),
         ).toThrowError('src, was not validated');
       });
     });

diff --git a/src/_tests/validator/fileDirectory.ts b/src/_tests/validator/fileDirectory.ts
@@ -132,7 +132,7 @@ export function run() {
       ];
 
       expect(() => validator.run(files, configObject)).toThrowError(
-        `${JSON.stringify(configObject[2])}, deep: 1, rule did not passed`
+        `${JSON.stringify(configObject[2])}, deep: 1, rule did not passed`,
       );
     });
 
@@ -155,7 +155,7 @@ export function run() {
       ];
 
       expect(() => validator.run(files, configObject)).toThrowError(
-        `${files[3]}, was not validated`
+        `${files[3]}, was not validated`,
       );
     });
 
@@ -211,7 +211,7 @@ export function run() {
       ];
 
       expect(() => validator.run(files, configObject)).toThrowError(
-        `${files[4]}, was not validated`
+        `${files[4]}, was not validated`,
       );
     });
 
@@ -244,8 +244,8 @@ export function run() {
 
         expect(() => validator.run(files, configObject)).toThrowError(
           `${JSON.stringify(
-            (configObject[0] as types.DirectoryRule).rules![2]
-          )}, deep: 2, rule did not passed`
+            (configObject[0] as types.DirectoryRule).rules![2],
+          )}, deep: 2, rule did not passed`,
         );
       });
 
@@ -273,8 +273,8 @@ export function run() {
 
         expect(() => validator.run(files, configObject)).toThrowError(
           `${JSON.stringify(
-            (configObject[0] as types.DirectoryRule).rules![0]
-          )}, deep: 2, rule did not passed`
+            (configObject[0] as types.DirectoryRule).rules![0],
+          )}, deep: 2, rule did not passed`,
         );
       });
 
@@ -305,8 +305,8 @@ export function run() {
 
         expect(() => validator.run(files, configObject)).toThrowError(
           `${JSON.stringify(
-            (configObject[0] as types.DirectoryRule).rules![0]
-          )}, deep: 2, rule did not passed`
+            (configObject[0] as types.DirectoryRule).rules![0],
+          )}, deep: 2, rule did not passed`,
         );
       });
     });
@@ -357,7 +357,7 @@ export function run() {
         ];
 
         expect(() => validator.run(files, configObject)).toThrowError(
-          'srrcNice/index.js, was not validated'
+          'srrcNice/index.js, was not validated',
         );
       });
     });
@@ -393,7 +393,7 @@ export function run() {
         ];
 
         expect(() => validator.run(files, configObject)).toThrowError(
-          'SRC/index.js, was not validated'
+          'SRC/index.js, was not validated',
         );
       });
     });

diff --git a/src/helpers/file.ts b/src/helpers/file.ts
@@ -0,0 +1,56 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+type File = {
+  type: 'file';
+  fullPath: string;
+  path: string;
+};
+
+type Directory = {
+  type: 'dir';
+  fullPath: string;
+  path: string;
+  isEmpty: boolean;
+};
+
+export function getFilesAndDirectories(
+  dirPath: string,
+  options: {
+    recursive: boolean;
+    _initialPath?: string;
+    ignoreFilesAndDirectories?: string[];
+  } = { recursive: true },
+): (File | Directory)[] {
+  const items = fs.readdirSync(dirPath);
+  options._initialPath = options._initialPath || dirPath;
+  const lPath = path.relative(options._initialPath, dirPath);
+
+  if (options.ignoreFilesAndDirectories?.includes(lPath)) return [];
+
+  const result: (File | Directory)[] = [
+    {
+      type: 'dir',
+      fullPath: dirPath,
+      path: lPath,
+      isEmpty: items.length === 0,
+    },
+  ];
+
+  for (const item of items) {
+    const fullPath = path.join(dirPath, item);
+    const itemStat = fs.statSync(fullPath);
+    const localPath = path.relative(options._initialPath, fullPath);
+
+    if (itemStat.isDirectory()) {
+      if (!options.recursive)
+        result.push({ type: 'dir', fullPath, path: localPath, isEmpty: false });
+      else result.push(...getFilesAndDirectories(fullPath, options));
+    } else {
+      if (options.ignoreFilesAndDirectories?.includes(localPath)) continue;
+      result.push({ type: 'file', fullPath, path: localPath });
+    }
+  }
+
+  return result;
+}