Merge pull request #108 from docsbydoxdox/hotfix/tests

neogeek · web-flow · commit ecf409452826 · 2022-01-27T22:29:03.000-05:00
[hotfix] Added more utility tests
diff --git a/package.json b/package.json
@@ -15,7 +15,7 @@
     "./packages/doxdox"
   ],
   "scripts": {
-    "test": "npm run test --workspaces --if-present",
+    "test": "DEBUG=true npm run test --workspaces --if-present",
     "build": "npm run build --workspaces --if-present",
     "prettier-check": "npx prettier@2 --check \"packages/**/*.ts\"",
     "prettier-fix": "npx prettier@2 --write \"packages/**/*.ts\"",
diff --git a/packages/doxdox-cli/tsconfig.json b/packages/doxdox-cli/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "esnext",
-    "module": "ES2020",
+    "module": "es2020",
     "esModuleInterop": true,
     "moduleResolution": "node",
     "resolveJsonModule": true,
diff --git a/packages/doxdox-core/src/utils.test.ts b/packages/doxdox-core/src/utils.test.ts
@@ -6,11 +6,15 @@ import { join } from 'path';
 
 import {
     findFileInPath,
-    getRootDirPath,
+    findParentNodeModules,
     getIgnoreConfigInPath,
+    getProjectPackage,
+    getRootDirPath,
+    isDirectory,
+    isFile,
     parseIgnoreConfig,
-    slugify,
-    getProjectPackage
+    sanitizePath,
+    slugify
 } from './utils';
 
 describe('utils', () => {
@@ -38,6 +42,21 @@ describe('utils', () => {
         });
     });
 
+    describe('findParentNodeModules', () => {
+        it('find node_modules with input directory', async () => {
+            assert.equal(
+                await findParentNodeModules('./'),
+                join(process.cwd(), '../../node_modules')
+            );
+        });
+        it('fail to find node_modules with input directory with depth of 1', async () => {
+            assert.notEqual(
+                await findParentNodeModules('./', 1),
+                join(process.cwd(), '../../node_modules')
+            );
+        });
+    });
+
     describe('getIgnoreConfigInPath', () => {
         it('find ignore config with input directory', async () => {
             assert.deepEqual(await getIgnoreConfigInPath('./'), [
@@ -67,6 +86,54 @@ describe('utils', () => {
         });
     });
 
+    describe('getProjectPackage', () => {
+        it('gets contents from project package', async () => {
+            const { name, description, version, exports } = JSON.parse(
+                await fs.readFile('./package.json', 'utf8')
+            );
+
+            assert.deepEqual(await getProjectPackage('./'), {
+                name,
+                description,
+                version,
+                exports
+            });
+        });
+        it('file to get contents from folder without package file', async () => {
+            assert.deepEqual(await getProjectPackage('./src/'), {});
+        });
+    });
+
+    describe('getRootDirPath', () => {
+        it('get dir path', () => {
+            assert.equal(getRootDirPath(), join(process.cwd(), './src'));
+        });
+    });
+
+    describe('isDirectory', () => {
+        it('return true with directory input', async () => {
+            assert.equal(await isDirectory('./'), true);
+        });
+        it('return false with file input', async () => {
+            assert.equal(await isDirectory('./package.json'), false);
+        });
+        it('return false with invalid input', async () => {
+            assert.equal(await isDirectory('./invalid.txt'), false);
+        });
+    });
+
+    describe('isFile', () => {
+        it('return true with file input', async () => {
+            assert.equal(await isFile('./package.json'), true);
+        });
+        it('return false with directory input', async () => {
+            assert.equal(await isFile('./'), false);
+        });
+        it('return false with invalid input', async () => {
+            assert.equal(await isFile('./invalid.txt'), false);
+        });
+    });
+
     describe('parseIgnoreConfig', () => {
         it('parse ignore config', () => {
             assert.deepEqual(
@@ -101,9 +168,14 @@ describe('utils', () => {
         });
     });
 
-    describe('getRootDirPath', () => {
-        it('get dir path', () => {
-            assert.equal(getRootDirPath(), join(process.cwd(), './src'));
+    describe('sanitizePath', () => {
+        it('sanitize path', () => {
+            assert.equal(
+                sanitizePath(
+                    'file:///Users/scottdoxey/git/github/doxdox/packages/doxdox-cli/dist/src/index.js'
+                ),
+                '/Users/scottdoxey/git/github/doxdox/packages/doxdox-cli/dist/src/index.js'
+            );
         });
     });
 
@@ -112,22 +184,4 @@ describe('utils', () => {
             assert.equal(slugify('./src/utils.ts'), 'src-utils-ts');
         });
     });
-
-    describe('getProjectPackage', () => {
-        it('gets contents from project package', async () => {
-            const { name, description, version, exports } = JSON.parse(
-                await fs.readFile('./package.json', 'utf8')
-            );
-
-            assert.deepEqual(await getProjectPackage('./'), {
-                name,
-                description,
-                version,
-                exports
-            });
-        });
-        it('file to get contents from folder without package file', async () => {
-            assert.deepEqual(await getProjectPackage('./src/'), {});
-        });
-    });
 });
diff --git a/packages/doxdox-core/tsconfig.json b/packages/doxdox-core/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "esnext",
-    "module": "ES2020",
+    "module": "es2020",
     "esModuleInterop": true,
     "moduleResolution": "node",
     "declaration": true,
diff --git a/packages/doxdox-parser-jsdoc/tsconfig.json b/packages/doxdox-parser-jsdoc/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "esnext",
-    "module": "ES2020",
+    "module": "es2020",
     "esModuleInterop": true,
     "moduleResolution": "node",
     "declaration": true,
diff --git a/packages/doxdox-parser-template/tsconfig.json b/packages/doxdox-parser-template/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "esnext",
-    "module": "ES2020",
+    "module": "es2020",
     "esModuleInterop": true,
     "moduleResolution": "node",
     "declaration": true,
diff --git a/packages/doxdox-renderer-bootstrap/tsconfig.json b/packages/doxdox-renderer-bootstrap/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "esnext",
-    "module": "ES2020",
+    "module": "es2020",
     "esModuleInterop": true,
     "moduleResolution": "node",
     "declaration": true,
diff --git a/packages/doxdox-renderer-dash/tsconfig.json b/packages/doxdox-renderer-dash/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "esnext",
-    "module": "ES2020",
+    "module": "es2020",
     "esModuleInterop": true,
     "moduleResolution": "node",
     "declaration": true,
diff --git a/packages/doxdox-renderer-github-wiki/tsconfig.json b/packages/doxdox-renderer-github-wiki/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "esnext",
-    "module": "ES2020",
+    "module": "es2020",
     "esModuleInterop": true,
     "moduleResolution": "node",
     "declaration": true,
diff --git a/packages/doxdox-renderer-json/tsconfig.json b/packages/doxdox-renderer-json/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "esnext",
-    "module": "ES2020",
+    "module": "es2020",
     "esModuleInterop": true,
     "moduleResolution": "node",
     "declaration": true,
diff --git a/packages/doxdox-renderer-markdown/tsconfig.json b/packages/doxdox-renderer-markdown/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "esnext",
-    "module": "ES2020",
+    "module": "es2020",
     "esModuleInterop": true,
     "moduleResolution": "node",
     "declaration": true,
diff --git a/packages/doxdox-renderer-template/tsconfig.json b/packages/doxdox-renderer-template/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "esnext",
-    "module": "ES2020",
+    "module": "es2020",
     "esModuleInterop": true,
     "moduleResolution": "node",
     "declaration": true,
diff --git a/packages/doxdox/tsconfig.json b/packages/doxdox/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "esnext",
-    "module": "ES2020",
+    "module": "es2020",
     "esModuleInterop": true,
     "moduleResolution": "node",
     "declaration": true,

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"compilerOptions": {`
`3`	`3`	`"target": "esnext",`
`4`		`- "module": "ES2020",`
	`4`	`+ "module": "es2020",`
`5`	`5`	`"esModuleInterop": true,`
`6`	`6`	`"moduleResolution": "node",`
`7`	`7`	`"resolveJsonModule": true,`