docworks 0.17.0-next.1 → 0.17.0

package/README.md

@@ -208,6 +208,10 @@ Contributions welcome! We're especially looking for:
 - Documentation platform integrations
 - Journey templates for common use cases
 
+### Development Setup
+
+Pre-commit hooks are automatically installed when you run `pnpm install`. These hooks run linting and formatting checks before each commit to ensure code quality. If you need to bypass them (not recommended), use `git commit --no-verify`.
+
 ## Why DocWorks?
 
 - **Real-world testing** - AI navigates docs like developers do

package/dist/sources/source.d.ts

@@ -1,4 +1,4 @@
-export declare function fetchDocumentation(url: string): Promise<{
+export declare function fetchDocumentation(source: string): Promise<{
     content: string;
     name: string;
 }>;

package/dist/sources/source.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../../src/sources/source.ts"],"names":[],"mappings":"AAAA,wBAAsB,kBAAkB,CACtC,GAAG,EAAE,MAAM,GACV,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CA0B5C"}
+{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../../src/sources/source.ts"],"names":[],"mappings":"AA2DA,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAY5C"}

package/dist/sources/source.js

@@ -1,23 +1,58 @@
-export async function fetchDocumentation(url) {
+import fs from 'fs';
+import path from 'path';
+function isUrl(source) {
     try {
-        // Try to fetch llms.txt
-        const llmsTxtUrl = new URL('/llms.txt', url).href;
-        console.log(`Fetching ${llmsTxtUrl}...`);
-        let response = await fetch(llmsTxtUrl);
+        // Check for protocol
+        if (!source.includes('://')) {
+            return false;
+        }
+        // Try to construct a URL object - will throw if invalid
+        new URL(source);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+async function readFromFile(filePath) {
+    const resolvedPath = path.resolve(filePath);
+    if (!fs.existsSync(resolvedPath)) {
+        throw new Error(`File not found: ${resolvedPath}`);
+    }
+    console.log(`Reading ${resolvedPath}...`);
+    const content = fs.readFileSync(resolvedPath, 'utf-8');
+    const name = `${path.basename(resolvedPath)} from local file`;
+    console.log('✓ Loaded documentation\n');
+    return { content, name };
+}
+async function fetchFromUrl(url) {
+    // Try to fetch llms.txt
+    const llmsTxtUrl = new URL('/llms.txt', url).href;
+    console.log(`Fetching ${llmsTxtUrl}...`);
+    let response = await fetch(llmsTxtUrl);
+    if (!response.ok) {
+        // Maybe they provided the llms.txt URL directly
+        response = await fetch(url);
         if (!response.ok) {
-            // Maybe they provided the llms.txt URL directly
-            response = await fetch(url);
-            if (!response.ok) {
-                throw new Error(`No llms.txt found at ${url}`);
-            }
+            throw new Error(`No llms.txt found at ${url}`);
+        }
+    }
+    const content = await response.text();
+    const name = `llms.txt from ${new URL(url).hostname}`;
+    console.log('✓ Fetched documentation\n');
+    return { content, name };
+}
+export async function fetchDocumentation(source) {
+    try {
+        if (isUrl(source)) {
+            return await fetchFromUrl(source);
+        }
+        else {
+            return await readFromFile(source);
         }
-        const content = await response.text();
-        const name = `llms.txt from ${new URL(url).hostname}`;
-        console.log('✓ Fetched documentation\n');
-        return { content, name };
     }
     catch (error) {
-        throw new Error(`Failed to fetch documentation from ${url}: ${error.message}`);
+        throw new Error(`Failed to fetch documentation from ${source}: ${error.message}`);
     }
 }
 //# sourceMappingURL=source.js.map

package/dist/sources/source.js.map

@@ -1 +1 @@
-{"version":3,"file":"source.js","sourceRoot":"","sources":["../../src/sources/source.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,GAAW;IAEX,IAAI,CAAC;QACH,wBAAwB;QACxB,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,IAAI,CAAA;QAEjD,OAAO,CAAC,GAAG,CAAC,YAAY,UAAU,KAAK,CAAC,CAAA;QACxC,IAAI,QAAQ,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,CAAA;QAEtC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,gDAAgD;YAChD,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAA;YAC3B,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAG,EAAE,CAAC,CAAA;YAChD,CAAC;QACH,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;QACrC,MAAM,IAAI,GAAG,iBAAiB,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAA;QAErD,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAA;QACxC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;IAC1B,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CACb,sCAAsC,GAAG,KAAK,KAAK,CAAC,OAAO,EAAE,CAC9D,CAAA;IACH,CAAC;AACH,CAAC"}
+{"version":3,"file":"source.js","sourceRoot":"","sources":["../../src/sources/source.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAA;AACnB,OAAO,IAAI,MAAM,MAAM,CAAA;AAEvB,SAAS,KAAK,CAAC,MAAc;IAC3B,IAAI,CAAC;QACH,qBAAqB;QACrB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAA;QACd,CAAC;QAED,wDAAwD;QACxD,IAAI,GAAG,CAAC,MAAM,CAAC,CAAA;QACf,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC;AAED,KAAK,UAAU,YAAY,CACzB,QAAgB;IAEhB,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IAE3C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,mBAAmB,YAAY,EAAE,CAAC,CAAA;IACpD,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,WAAW,YAAY,KAAK,CAAC,CAAA;IACzC,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;IACtD,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,kBAAkB,CAAA;IAE7D,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAA;IACvC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;AAC1B,CAAC;AAED,KAAK,UAAU,YAAY,CACzB,GAAW;IAEX,wBAAwB;IACxB,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,IAAI,CAAA;IAEjD,OAAO,CAAC,GAAG,CAAC,YAAY,UAAU,KAAK,CAAC,CAAA;IACxC,IAAI,QAAQ,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,CAAA;IAEtC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,gDAAgD;QAChD,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAA;QAC3B,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAG,EAAE,CAAC,CAAA;QAChD,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;IACrC,MAAM,IAAI,GAAG,iBAAiB,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAA;IAErD,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAA;IACxC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;AAC1B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,MAAc;IAEd,IAAI,CAAC;QACH,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YAClB,OAAO,MAAM,YAAY,CAAC,MAAM,CAAC,CAAA;QACnC,CAAC;aAAM,CAAC;YACN,OAAO,MAAM,YAAY,CAAC,MAAM,CAAC,CAAA;QACnC,CAAC;IACH,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CACb,sCAAsC,MAAM,KAAK,KAAK,CAAC,OAAO,EAAE,CACjE,CAAA;IACH,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docworks",
-  "version": "0.17.0-next.1",
+  "version": "0.17.0",
   "description": "Ensure your docs work for developers and AI",
   "type": "module",
   "main": "dist/index.js",
@@ -9,8 +9,10 @@
   },
   "scripts": {
     "build": "tsc",
+    "build:standalone": "npm run build && npx @vercel/ncc build dist/index.js -o standalone -m",
     "test": "echo \"Error: no test specified\" && exit 1",
     "dev": "tsc --watch",
+    "prepare": "husky",
     "prepublishOnly": "npm run build",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
@@ -29,6 +31,8 @@
     "yaml": "^2.0.0"
   },
   "devDependencies": {
+    "@commitlint/cli": "^20.1.0",
+    "@commitlint/config-conventional": "^20.0.0",
     "@eslint/js": "^9.35.0",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/exec": "^7.1.0",
@@ -41,7 +45,6 @@
     "eslint-config-prettier": "^10.1.8",
     "husky": "^9.1.7",
     "lint-staged": "^16.1.6",
-    "node": "link:@@types/node",
     "prettier": "^3.6.2",
     "semantic-release": "^24.2.7",
     "typescript": "^5.0.0",
@@ -59,7 +62,7 @@
       "eslint --fix",
       "prettier --write"
     ],
-    "*.{json,md,yml,yaml}": [
+    "*.{json,yml,yaml}": [
       "prettier --write"
     ]
   },