@facetlayer/docs-tool 0.1.0

package/README.md

@@ -0,0 +1,80 @@
+# @facetlayer/doc-files-helper
+
+Helper library for CLI tools to share their doc files.
+
+When an app uses this library, they'll typically have these commands:
+
+ `<app> list-docs` - List all the doc files with descriptions.
+ `<app> get-doc <name>` - Get the contents for a single doc file.
+
+The `list-docs` and `get-doc` commands will browse through all the doc files that the
+tool owns. These are typically stored in ./docs.
+
+Each doc file should be Markdown and implement frontmatter with `name` and `description`
+(same format that Claude Agent Skills uses). The name & description are shared when
+doing `list-docs`.
+
+## Installation
+
+```bash
+pnpm add @facetlayer/doc-files-helper
+```
+
+## Example
+
+### Listing Docs
+
+```typescript
+import { DocFilesHelper } from '@facetlayer/doc-files-helper';
+
+const helper = new DocFilesHelper({ dirs: ['./docs'] });
+const docs = helper.listDocs();
+// Returns: [{ name: 'my-doc', description: '...', filename: 'my-doc.md' }, ...]
+```
+
+### Getting a Doc
+
+```typescript
+import { DocFilesHelper } from '@facetlayer/doc-files-helper';
+
+const helper = new DocFilesHelper({ dirs: ['./docs'] });
+const doc = helper.getDoc('my-doc');
+// Returns: { name, description, filename, content, rawContent, fullPath }
+```
+
+## Frontmatter Format
+
+Doc files should have YAML frontmatter at the start:
+
+```markdown
+---
+name: doc-name
+description: Brief description of the doc
+---
+
+# Doc Content
+
+Your markdown content here.
+```
+
+## API
+
+### `DocFilesHelper`
+
+Helper class for working with doc files.
+
+#### Constructor Options
+
+```typescript
+interface DocFilesHelperOptions {
+  dirs?: string[];   // List of directories to search for .md files
+  files?: string[];  // List of specific files to include
+}
+```
+
+#### Methods
+
+- `listDocs(): DocInfo[]` - Lists all `.md` files with their frontmatter metadata.
+- `getDoc(name: string): DocContent` - Gets a specific doc file by name (without `.md` extension). Throws if not found.
+- `printDocFileList(): void` - Prints a formatted list of all doc files to stdout.
+- `printDocFileContents(name: string): void` - Prints the raw contents of a specific doc file to stdout.

package/dist/__tests__/cli.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=cli.test.d.ts.map

package/dist/__tests__/cli.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/cli.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.test.d.ts.map

package/dist/__tests__/index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/index.test.ts"],"names":[],"mappings":""}

package/dist/browseLocalLibrary.d.ts

@@ -0,0 +1,12 @@
+import { DocFilesHelper } from './index.ts';
+export interface LocalLibraryDocs {
+    libraryPath: string;
+    helper: DocFilesHelper;
+    hasDocsFolder: boolean;
+}
+/**
+ * Create a DocFilesHelper for browsing docs in a local directory.
+ * Looks for .md files in the target directory and also in a ./docs subdirectory if it exists.
+ */
+export declare function browseLocalLibrary(targetPath: string): LocalLibraryDocs;
+//# sourceMappingURL=browseLocalLibrary.d.ts.map

package/dist/browseLocalLibrary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browseLocalLibrary.d.ts","sourceRoot":"","sources":["../src/browseLocalLibrary.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,cAAc,CAAC;IACvB,aAAa,EAAE,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,gBAAgB,CAoBvE"}

package/dist/browseNpmLibrary.d.ts

@@ -0,0 +1,39 @@
+import { DocFilesHelper } from './index.ts';
+export interface LibraryLocation {
+    libraryPath: string;
+    libraryName: string;
+    matchType: 'exact' | 'partial';
+}
+export interface NpmLibraryDocs {
+    libraryName: string;
+    libraryPath: string;
+    helper: DocFilesHelper;
+    hasReadme: boolean;
+    hasDocsFolder: boolean;
+}
+/**
+ * Find a library by name in node_modules directories.
+ */
+export declare function findLibraryInNodeModules(libraryName: string, startDir?: string): LibraryLocation | null;
+/**
+ * Get the installation directory for libraries that aren't found in node_modules
+ */
+export declare function getInstallationDirectory(): string;
+/**
+ * Find a library, installing it if necessary
+ */
+export declare function findLibrary(libraryName: string, options?: {
+    skipInstall?: boolean;
+}): Promise<LibraryLocation | null>;
+/**
+ * Create a DocFilesHelper for a library's documentation
+ */
+export declare function getLibraryDocs(libraryPath: string, libraryName: string): NpmLibraryDocs;
+/**
+ * Browse an NPM library's documentation.
+ * First checks local node_modules, then installs from npm if not found.
+ */
+export declare function browseNpmLibrary(libraryName: string, options?: {
+    skipInstall?: boolean;
+}): Promise<NpmLibraryDocs | null>;
+//# sourceMappingURL=browseNpmLibrary.d.ts.map

package/dist/browseNpmLibrary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browseNpmLibrary.d.ts","sourceRoot":"","sources":["../src/browseNpmLibrary.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,OAAO,GAAG,SAAS,CAAC;CAChC;AAED,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,cAAc,CAAC;IACvB,SAAS,EAAE,OAAO,CAAC;IACnB,aAAa,EAAE,OAAO,CAAC;CACxB;AAuGD;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,eAAe,GAAG,IAAI,CAiCvG;AAED;;GAEG;AACH,wBAAgB,wBAAwB,IAAI,MAAM,CASjD;AA6GD;;GAEG;AACH,wBAAsB,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAAE,WAAW,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC,CAiC3H;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,cAAc,CA+BvF;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAAE,WAAW,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAQ/H"}

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}