Merge pull request #3 from hawkeyexl/tests

Refactor and enhance template validation with comprehensive tests

Author: hawkeyexl

.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    types: [ opened, synchronize ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
+        
+    - name: Install dependencies
+      run: npm ci
+      
+    - name: Run tests
+      run: npm test

.husky/pre-commit

@@ -0,0 +1 @@
+npm test

test/artifacts/package_test.js renamed to artifacts/package_test.js

@@ -1,4 +1,4 @@
-import { lintDocument } from '../../index.js';
+import { lintDocument } from '../src/index.js';
 
 const result = await lintDocument({
   file: './test/artifacts/sample_markdown.md',

test/artifacts/sample_asciidoc.adoc renamed to artifacts/sample_asciidoc.adoc

@@ -3,12 +3,13 @@
   "version": "0.0.3",
   "description": "A tool to validate Markdown and AsciiDoc structure against a specified template",
   "bin": {
-    "doc-structure-lint": "index.js"
+    "doc-structure-lint": "src/index.js"
   },
-  "main": "index.js",
+  "main": "src/index.js",
   "scripts": {
-    "start": "node index.js",
-    "test": "mocha 'src/**/*.test.js' 'test/**/*.test.js'"
+    "start": "node src/index.js",
+    "test": "mocha 'src/**/*.test.js'",
+    "prepare": "husky"
   },
   "author": "Manny Silva",
   "license": "MIT",
@@ -25,6 +26,7 @@
   },
   "devDependencies": {
     "chai": "^5.1.2",
+    "husky": "^9.1.7",
     "mocha": "^11.0.1",
     "sinon": "^19.0.2"
   },

test/artifacts/sample_markdown.json renamed to artifacts/sample_markdown.json

@@ -0,0 +1,114 @@
+import { expect } from "chai";
+import { exec } from "child_process";
+import fs from "fs";
+import path from "path";
+import os from "os";
+import { promisify } from "util";
+
+const execAsync = promisify(exec);
+
+describe("CLI functionality", () => {
+    let tempDir;
+    let templateFile;
+    let documentFile;
+
+    beforeEach(() => {
+        tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'cli-test-'));
+        templateFile = path.join(tempDir, 'templates.yaml');
+        documentFile = path.join(tempDir, 'test-document.md');
+    });
+
+    afterEach(() => {
+        fs.rmSync(tempDir, { recursive: true, force: true });
+    });
+
+    it("should validate document successfully via npx command", async () => {
+        const template = `
+templates:
+  test-template:
+    sections:
+      intro:
+        heading:
+          const: "Introduction"
+        required: true`;
+
+        const document = "# Introduction\nSome content here.";
+
+        fs.writeFileSync(templateFile, template);
+        fs.writeFileSync(documentFile, document);
+
+        const { stdout, stderr } = await execAsync(
+            `npx . --file="${documentFile}" --template-path="${templateFile}" --template="test-template"`
+        );
+
+        expect(stdout).to.include("Validation successful");
+    }).timeout(5000);
+
+    it("should report validation errors via npx command", async () => {
+        const template = `
+templates:
+  test-template:
+    sections:
+      intro:
+        heading:
+          const: "Expected Heading"
+        required: true`;
+
+        const document = "# Wrong Heading\nSome content here.";
+
+        fs.writeFileSync(templateFile, template);
+        fs.writeFileSync(documentFile, document);
+
+        try {
+            await execAsync(
+                `npx . --file="${documentFile}" --template-path="${templateFile}" --template="test-template"`
+            );
+            expect.fail("Should have thrown an error");
+        } catch (error) {
+            expect(error.stdout).to.include("Expected title");
+        }
+    }).timeout(5000);
+
+    it("should show help message with --help flag", async () => {
+        const { stdout } = await execAsync("npx . --help");
+        
+        expect(stdout).to.include("Options:");
+        expect(stdout).to.include("--file");
+        expect(stdout).to.include("--template-path");
+        expect(stdout).to.include("--template");
+    }).timeout(5000);
+
+    it("should fail with meaningful error for missing arguments", async () => {
+        try {
+            await execAsync("npx .");
+            expect.fail("Should have thrown an error");
+        } catch (error) {
+            expect(error.stderr).to.include("Options");
+        }
+    }).timeout(5000);
+
+    it("should handle invalid template path gracefully", async () => {
+        try {
+            await execAsync(
+                `npx . --file="${documentFile}" --template-path="non-existent.yaml" --template="test-template"`
+            );
+            expect.fail("Should have thrown an error");
+        } catch (error) {
+            expect(error.stderr).to.include("Template file not found");
+            expect(error.code).to.equal(1);
+        }
+    }).timeout(5000);
+
+    it("should handle malformed template file", async () => {
+        fs.writeFileSync(templateFile, "invalid: yaml: content:");
+        try {
+            await execAsync(
+                `npx . --file="${documentFile}" --template-path="${templateFile}" --template="test-template"`
+            );
+            expect.fail("Should have thrown an error");
+        } catch (error) {
+            expect(error.stderr).to.include("Failed to load and validate templates");
+            expect(error.code).to.equal(1);
+        }
+    }).timeout(5000);
+});