markdown-magic 4.0.0 → 4.0.1

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "markdown-magic",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "Automatically update markdown files with content from external sources",
-  "main": "index.js",
+  "main": "src/index.js",
   "bin": {
     "markdown": "./cli.js",
     "md-magic": "./cli.js",
@@ -14,7 +14,8 @@
     "package.json",
     "package-lock.json",
     "src",
-    "cli.js"
+    "cli.js",
+    "types"
   ],
   "author": "David Wells",
   "license": "MIT",
@@ -39,9 +40,9 @@
     "smart-glob": "^1.0.2",
     "string-width": "^4.2.3",
     "sync-request": "^6.1.0",
+    "comment-block-parser": "1.0.7",
     "comment-block-transformer": "0.1.1",
-    "comment-block-replacer": "0.1.0",
-    "comment-block-parser": "1.0.7"
+    "comment-block-replacer": "0.1.0"
   },
   "devDependencies": {
     "ansi-styles": "^4.2.1",
@@ -60,8 +61,8 @@
     "docs": "node examples/generate-readme.js",
     "test": "uvu . '.test.([mc]js|[jt]sx?)$'",
     "cli": "node ./cli.js --path 'README.md' --config ./markdown.config.js",
-    "release:patch": "pnpm publish --version patch && git push origin && git push origin --tags",
-    "release:minor": "pnpm publish --version minor && git push origin && git push origin --tags",
-    "release:major": "pnpm publish --version major && git push origin && git push origin --tags"
+    "release:patch": "pnpm version patch --git-tag-version && pnpm publish",
+    "release:minor": "pnpm version minor --git-tag-version && pnpm publish",
+    "release:major": "pnpm version major --git-tag-version && pnpm publish"
   }
 }

package/types/_tests/config.d.ts

@@ -0,0 +1,4 @@
+export const FIXTURE_DIR: string;
+export const MARKDOWN_FIXTURE_DIR: string;
+export const OUTPUT_DIR: string;
+//# sourceMappingURL=config.d.ts.map

package/types/_tests/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../_tests/config.js"],"names":[],"mappings":"AACA,iCAAoD;AACpD,0CAAyD;AACzD,gCAAmD"}

package/types/_tests/errors.test.d.ts

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

package/types/_tests/errors.test.d.ts.map

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

package/types/_tests/fixtures/js/simple.d.ts

@@ -0,0 +1,8 @@
+/**
+ * comment inside
+ */
+/****************
+ comment inside
+******************/
+declare var x: string;
+//# sourceMappingURL=simple.d.ts.map

package/types/_tests/fixtures/js/simple.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple.d.ts","sourceRoot":"","sources":["../../../../_tests/fixtures/js/simple.js"],"names":[],"mappings":"AAqBA;;GAEG;AAIH;;mBAEmB;AAGnB,sBAAa"}

package/types/_tests/fixtures/local-code-file-lines.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=local-code-file-lines.d.ts.map

package/types/_tests/fixtures/local-code-file-lines.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-code-file-lines.d.ts","sourceRoot":"","sources":["../../../_tests/fixtures/local-code-file-lines.js"],"names":[],"mappings":""}

package/types/_tests/fixtures/local-code-file.d.ts

@@ -0,0 +1,2 @@
+export function run(): void;
+//# sourceMappingURL=local-code-file.d.ts.map

package/types/_tests/fixtures/local-code-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-code-file.d.ts","sourceRoot":"","sources":["../../../_tests/fixtures/local-code-file.js"],"names":[],"mappings":"AAYqB,4BAGpB"}

package/types/_tests/fixtures/local-code-id.d.ts

@@ -0,0 +1,3 @@
+declare function _exports(filePath: any, config: any): Promise<void>;
+export = _exports;
+//# sourceMappingURL=local-code-id.d.ts.map

package/types/_tests/fixtures/local-code-id.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-code-id.d.ts","sourceRoot":"","sources":["../../../_tests/fixtures/local-code-id.js"],"names":[],"mappings":"AAUiB,qEAyBhB"}

package/types/_tests/transforms-toc.test.d.ts

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

package/types/_tests/transforms-toc.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transforms-toc.test.d.ts","sourceRoot":"","sources":["../../_tests/transforms-toc.test.js"],"names":[],"mappings":""}

package/types/_tests/transforms.test.d.ts

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

package/types/_tests/transforms.test.d.ts.map

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

package/types/_tests/utils/diff.d.ts

@@ -0,0 +1,3 @@
+declare function _exports(actual: any, expected: any): any;
+export = _exports;
+//# sourceMappingURL=diff.d.ts.map

package/types/_tests/utils/diff.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"diff.d.ts","sourceRoot":"","sources":["../../../_tests/utils/diff.js"],"names":[],"mappings":"AA8HiB,2DAShB"}

package/types/cli.d.ts

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

package/types/cli.d.ts.map

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

package/types/src/argparse/argparse.d.ts

@@ -0,0 +1,33 @@
+export function uxParse(_rawArgv?: any[], opts?: {}): {
+    leadingCommands: string[];
+    extraParse: {};
+    mriOptionsOriginal: mri.Argv<{
+        [x: string]: any;
+    }>;
+    globGroups: any[];
+    rawArgv?: undefined;
+    mriOptionsClean?: undefined;
+    mriDiff?: undefined;
+    yargsParsed?: undefined;
+    mergedOptions?: undefined;
+} | {
+    rawArgv: string;
+    leadingCommands: string[];
+    globGroups: any[];
+    extraParse: {};
+    mriOptionsOriginal: mri.Argv<{
+        [x: string]: any;
+    }>;
+    mriOptionsClean: {
+        [x: string]: any;
+    } & {
+        _: string[];
+    };
+    mriDiff: boolean;
+    yargsParsed: string;
+    mergedOptions: {
+        _: string[];
+    };
+};
+import mri = require("mri");
+//# sourceMappingURL=argparse.d.ts.map

package/types/src/argparse/argparse.d.ts.map

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

package/types/src/argparse/argparse.test.d.ts

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

package/types/src/argparse/argparse.test.d.ts.map

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

package/types/src/argparse/index.d.ts

@@ -0,0 +1,3 @@
+export { uxParse };
+import { uxParse } from "./argparse";
+//# sourceMappingURL=index.d.ts.map

package/types/src/argparse/index.d.ts.map

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

package/types/src/argparse/splitOutsideQuotes.d.ts

@@ -0,0 +1,2 @@
+export function splitOutsideQuotes(str: any): any[];
+//# sourceMappingURL=splitOutsideQuotes.d.ts.map

package/types/src/argparse/splitOutsideQuotes.d.ts.map

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

package/types/src/argparse/splitOutsideQuotes.test.d.ts

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

package/types/src/argparse/splitOutsideQuotes.test.d.ts.map

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

package/types/src/cli-run.d.ts

@@ -0,0 +1,4 @@
+import { getGlobGroupsFromArgs } from "./globparse";
+export function runCli(options: {}, rawArgv: any): Promise<import("./").MarkdownMagicResult>;
+export { getGlobGroupsFromArgs };
+//# sourceMappingURL=cli-run.d.ts.map

package/types/src/cli-run.d.ts.map

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

package/types/src/cli-run.test.d.ts

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

package/types/src/cli-run.test.d.ts.map

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

package/types/src/defaults.d.ts

@@ -0,0 +1,5 @@
+export const SYNTAX: "md";
+export const OPEN_WORD: "doc-gen";
+export const CLOSE_WORD: "end-doc-gen";
+export const DEFAULT_GLOB_PATTERN: "**/**.md";
+//# sourceMappingURL=defaults.d.ts.map

package/types/src/defaults.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../../src/defaults.js"],"names":[],"mappings":"AACA,qBAAe,IAAI,CAAA;AACnB,wBAAkB,SAAS,CAAA;AAC3B,yBAAmB,aAAa,CAAA;AAChC,mCAA6B,UAAU,CAAA"}

package/types/src/globparse.d.ts

@@ -0,0 +1,18 @@
+export function getGlobGroupsFromArgs(args: any, opts?: {}): {
+    globGroups: {
+        key: any;
+        rawKey: any;
+        values: any;
+    }[];
+    otherOpts: any[];
+};
+export function isArrayLike(str: any): boolean;
+export function stringLooksLikeFile(value: any): boolean;
+export function getValue(val: any): any;
+export function trimLeadingDashes(value: any): any;
+export function removeNodeModules(value?: string): boolean;
+export function coerceStringToRegex(str: any): any;
+export function convertToArray(str?: string): any;
+export function addValue(value: any, currentCollection: any): any;
+export function customIsGlob(arg: any): any;
+//# sourceMappingURL=globparse.d.ts.map

package/types/src/globparse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"globparse.d.ts","sourceRoot":"","sources":["../../src/globparse.js"],"names":[],"mappings":"AA6EA;;;;;;;EA8EC;AA5ID,+CAGC;AAED,yDAOC;AAED,wCAEC;AAED,mDAEC;AAED,2DAKC;AAED,mDAOC;AAED,kDAGC;AAED,kEASC;AAED,4CAMC"}

package/types/src/globparse.test.d.ts

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

package/types/src/globparse.test.d.ts.map

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

package/types/src/index.d.ts

@@ -0,0 +1,189 @@
+/**
+ * Allowed file syntaxes
+ */
+export type SyntaxType = "md" | "js" | "yml" | "yaml";
+/**
+ * Path to file, files or Glob string or Glob Array
+ */
+export type FilePathsOrGlobs = string | Array<string>;
+export type ProcessFileOptions = import("comment-block-replacer").ProcessFileOptions;
+/**
+ * Configuration for markdown magic
+ *
+ * Below is the main config for `markdown-magic`
+ */
+export type MarkdownMagicOptions = {
+    /**
+     * - Files to process.
+     */
+    files?: FilePathsOrGlobs;
+    /**
+     * - Custom commands to transform block contents, see transforms & custom transforms sections below.
+     */
+    transforms?: any;
+    /**
+     * - Output configuration
+     */
+    output?: OutputConfig;
+    /**
+     * - Syntax to parse
+     */
+    syntax?: SyntaxType;
+    /**
+     * - Opening match word
+     */
+    open?: string;
+    /**
+     * - Closing match word. If not defined will be same as opening word.
+     */
+    close?: string;
+    /**
+     * - Current working directory. Default process.cwd()
+     */
+    cwd?: string;
+    /**
+     * - Flatten files that are output
+     */
+    outputFlatten?: boolean;
+    /**
+     * - Use git glob for LARGE file directories
+     */
+    useGitGlob?: boolean;
+    /**
+     * - See planned execution of matched blocks
+     */
+    dryRun?: boolean;
+    /**
+     * - See debug details
+     */
+    debug?: boolean;
+    /**
+     * - Silence all console output
+     */
+    silent?: boolean;
+    /**
+     * - Apply transforms to source file. Default is true.
+     */
+    applyTransformsToSource?: boolean;
+    /**
+     * - Fail if transform functions are missing. Default skip blocks.
+     */
+    failOnMissingTransforms?: boolean;
+    /**
+     * - Fail if remote file is missing.
+     */
+    failOnMissingRemote?: boolean;
+};
+/**
+ * Optional output configuration
+ */
+export type OutputConfig = {
+    /**
+     * - Change output path of new content. Default behavior is replacing the original file
+     */
+    directory?: string;
+    /**
+     * - Remove comments from output. Default is false.
+     */
+    removeComments?: boolean;
+    /**
+     * - Custom function for altering output paths
+     */
+    pathFormatter?: Function;
+    /**
+     * - Apply transforms to source file. Default is true. This is for when outputDir is set.
+     */
+    applyTransformsToSource?: boolean;
+};
+/**
+ * Result of markdown processing
+ */
+export type MarkdownMagicResult = {
+    /**
+     * - Any errors encountered.
+     */
+    errors: any[];
+    /**
+     * - Modified files
+     */
+    filesChanged: Array<string>;
+    /**
+     * - md data
+     */
+    results: any[];
+};
+/**
+ * Allowed file syntaxes
+ * @typedef {'md' | 'js' | 'yml' | 'yaml'} SyntaxType
+ */
+/**
+ * Path to file, files or Glob string or Glob Array
+ * @typedef {string|Array<string>} FilePathsOrGlobs
+ */
+/**
+ * @typedef {import('comment-block-replacer').ProcessFileOptions} ProcessFileOptions
+ */
+/**
+ * Configuration for markdown magic
+ *
+ * Below is the main config for `markdown-magic`
+ *
+ * @typedef {object} MarkdownMagicOptions
+ * @property {FilePathsOrGlobs} [files] - Files to process.
+ * @property {Object} [transforms = defaultTransforms] - Custom commands to transform block contents, see transforms & custom transforms sections below.
+ * @property {OutputConfig} [output] - Output configuration
+ * @property {SyntaxType} [syntax = 'md'] - Syntax to parse
+ * @property {string} [open = 'doc-gen'] - Opening match word
+ * @property {string} [close = 'end-doc-gen'] - Closing match word. If not defined will be same as opening word.
+ * @property {string} [cwd = process.cwd() ] - Current working directory. Default process.cwd()
+ * @property {boolean} [outputFlatten] - Flatten files that are output
+ * @property {boolean} [useGitGlob] - Use git glob for LARGE file directories
+ * @property {boolean} [dryRun = false] - See planned execution of matched blocks
+ * @property {boolean} [debug = false] - See debug details
+ * @property {boolean} [silent = false] - Silence all console output
+ * @property {boolean} [applyTransformsToSource = true] - Apply transforms to source file. Default is true.
+ * @property {boolean} [failOnMissingTransforms = false] - Fail if transform functions are missing. Default skip blocks.
+ * @property {boolean} [failOnMissingRemote = true] - Fail if remote file is missing.
+ */
+/**
+ * Optional output configuration
+ * @typedef  {object}   OutputConfig
+ * @property {string}   [directory] - Change output path of new content. Default behavior is replacing the original file
+ * @property {boolean}  [removeComments = false] - Remove comments from output. Default is false.
+ * @property {function} [pathFormatter] - Custom function for altering output paths
+ * @property {boolean}  [applyTransformsToSource = false] - Apply transforms to source file. Default is true. This is for when outputDir is set.
+ */
+/**
+ * Result of markdown processing
+ *
+ * @typedef {object} MarkdownMagicResult
+ * @property {Array} errors - Any errors encountered.
+ * @property {Array<string>} filesChanged - Modified files
+ * @property {Array} results - md data
+ */
+/**
+ * ### API
+ *
+ * Markdown Magic Instance
+ *
+ * ```js
+ * markdownMagic(globOrOpts, options)
+ * ```
+ *
+ * @param {FilePathsOrGlobs|MarkdownMagicOptions} globOrOpts - Files to process or config.
+ * @param {MarkdownMagicOptions} [options] - Markdown magic config
+ * @returns {Promise<MarkdownMagicResult>}
+ * @example
+  markdownMagic(['**.**.md'], options).then((result) => {
+    console.log(`Processing complete`, result)
+  })
+ */
+export function markdownMagic(globOrOpts?: FilePathsOrGlobs | MarkdownMagicOptions, options?: MarkdownMagicOptions): Promise<MarkdownMagicResult>;
+import { blockTransformer } from "comment-block-transformer";
+import { processFile } from "comment-block-replacer";
+export namespace stringUtils {
+    export { stringBreak };
+}
+import stringBreak = require("./utils/string-break");
+export { parseMarkdown, blockTransformer, processFile };
+//# sourceMappingURL=index.d.ts.map

package/types/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":";;;yBAkDa,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,MAAM;;;;+BAK5B,MAAM,GAAC,KAAK,CAAC,MAAM,CAAC;iCAIpB,OAAO,wBAAwB,EAAE,kBAAkB;;;;;;;;;;YASlD,gBAAgB;;;;;;;;aAEhB,YAAY;;;;aACZ,UAAU;;;;WACV,MAAM;;;;YACN,MAAM;;;;UACN,MAAM;;;;oBACN,OAAO;;;;iBACP,OAAO;;;;aACP,OAAO;;;;YACP,OAAO;;;;aACP,OAAO;;;;8BACP,OAAO;;;;8BACP,OAAO;;;;0BACP,OAAO;;;;;;;;;gBAMP,MAAM;;;;qBACN,OAAO;;;;;;;;8BAEP,OAAO;;;;;;;;;;;;;kBAQP,KAAK,CAAC,MAAM,CAAC;;;;;;AAnD3B;;;GAGG;AAEH;;;GAGG;AAEH;;GAEG;AAEH;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH;;;;;;;GAOG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,2CARW,gBAAgB,GAAC,oBAAoB,YACrC,oBAAoB,GAClB,OAAO,CAAC,mBAAmB,CAAC,CA2lBxC"}

package/types/src/index.test.d.ts

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

package/types/src/index.test.d.ts.map

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

package/types/src/process-contents.d.ts

@@ -0,0 +1,3 @@
+import { blockTransformer } from "comment-block-transformer";
+export { blockTransformer as processContents };
+//# sourceMappingURL=process-contents.d.ts.map

package/types/src/process-contents.d.ts.map

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

package/types/src/transforms/code/index.d.ts

@@ -0,0 +1,35 @@
+declare namespace _exports {
+    export { CodeTransformOptions };
+}
+declare function _exports(api: any): Promise<any>;
+export = _exports;
+/**
+ * Options for specifying source code to include in documentation.
+ */
+type CodeTransformOptions = {
+    /**
+     * - The relative path to the code to include, or the URL where the raw code lives.
+     */
+    src: string;
+    /**
+     * - The syntax of the code. If not specified, it will be inferred by fileType.
+     */
+    syntax?: string;
+    /**
+     * - The header comment to add to the code snippet. Useful for pointing to relative source directory or adding live doc links.
+     */
+    header?: string;
+    /**
+     * - A range of lines of code to include from the file. The line range should be defined like "lines=22-44".
+     */
+    lines?: string;
+    /**
+     * - A section of code to include from the file. Defined like "section=SECTION_NAME". The code should have "// SECTION_NAME" surrounding the block of text.
+     */
+    section?: string;
+    /**
+     * - Remove multi-line comments that start with `//` from the code.
+     */
+    trimDeadCode?: boolean;
+};
+//# sourceMappingURL=index.d.ts.map

package/types/src/transforms/code/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/transforms/code/index.js"],"names":[],"mappings":";;;AA+CiB,kDA8JhB;;;;;;;;;SAxLa,MAAM;;;;aACN,MAAM;;;;aACN,MAAM;;;;YACN,MAAM;;;;cACN,MAAM;;;;mBACN,OAAO"}

package/types/src/transforms/code/resolve-github-file.d.ts

@@ -0,0 +1,24 @@
+export function isGithubLink(str?: string): boolean;
+export function isGithubRawLink(str?: string): boolean;
+export function getGitHubFileContentsRaw(options: any): Promise<any>;
+export function resolveGithubDetails(repoFilePath: any): {
+    repoOwner: any;
+    repoName: any;
+    filePath: any;
+};
+/**
+ * Resolves the contents of a file from a GitHub repository.
+ *
+ * @param {Object}  options - The options for resolving the GitHub contents.
+ * @param {string}  options.repoFilePath - The file path in the GitHub repository.
+ * @param {string}  [options.accessToken] - The access token for authenticating with GitHub (optional).
+ * @param {boolean} [options.debug = false] - Whether to enable debug logging (optional).
+ * @returns {Promise<string>} - A promise that resolves to the contents of the file.
+ * @throws {Error} - If the GitHub link is invalid or if the file fetch fails.
+ */
+export function resolveGithubContents({ repoFilePath, accessToken, debug }: {
+    repoFilePath: string;
+    accessToken?: string;
+    debug?: boolean;
+}): Promise<string>;
+//# sourceMappingURL=resolve-github-file.d.ts.map

package/types/src/transforms/code/resolve-github-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve-github-file.d.ts","sourceRoot":"","sources":["../../../../src/transforms/code/resolve-github-file.js"],"names":[],"mappings":"AASA,oDAEC;AAMD,uDAEC;AAoOD,qEA8CC;AA3QD;;;;EA8BC;AAED;;;;;;;;;GASG;AACH,4EANG;IAAyB,YAAY,EAA7B,MAAM;IACY,WAAW,GAA7B,MAAM;IACY,KAAK,GAAvB,OAAO;CACf,GAAU,OAAO,CAAC,MAAM,CAAC,CAwD3B"}

package/types/src/transforms/code/resolve-github-file.test.d.ts

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

package/types/src/transforms/code/resolve-github-file.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve-github-file.test.d.ts","sourceRoot":"","sources":["../../../../src/transforms/code/resolve-github-file.test.js"],"names":[],"mappings":""}

package/types/src/transforms/file.d.ts

@@ -0,0 +1,3 @@
+declare function _exports(api: any): any;
+export = _exports;
+//# sourceMappingURL=file.d.ts.map

package/types/src/transforms/file.d.ts.map

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

package/types/src/transforms/fileTree.d.ts

@@ -0,0 +1,35 @@
+declare namespace _exports {
+    export { FileTreeTransformOptions };
+}
+declare function _exports(api: any): string;
+export = _exports;
+/**
+ * Options for configuring the file tree table of contents.
+ */
+type FileTreeTransformOptions = {
+    /**
+     * - The directory path to generate the file tree for. Default is `.` (current directory).
+     */
+    src?: string;
+    /**
+     * - Maximum depth to traverse in the directory tree. Default is `3`.
+     */
+    maxDepth?: number;
+    /**
+     * - Whether to include files in the tree or just directories. Default is `true`.
+     */
+    includeFiles?: boolean;
+    /**
+     * - Array of glob patterns to exclude from the tree.
+     */
+    exclude?: string[];
+    /**
+     * - Whether to show file sizes. Default is `false`.
+     */
+    showSize?: boolean;
+    /**
+     * - Output format: "tree" or "list". Default is `"tree"`.
+     */
+    format?: string;
+};
+//# sourceMappingURL=fileTree.d.ts.map

package/types/src/transforms/fileTree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileTree.d.ts","sourceRoot":"","sources":["../../../src/transforms/fileTree.js"],"names":[],"mappings":";;;AAyBiB,qCAFJ,MAAM,CAoClB;;;;;;;;;UArDa,MAAM;;;;eACN,MAAM;;;;mBACN,OAAO;;;;cACP,MAAM,EAAE;;;;eACR,OAAO;;;;aACP,MAAM"}

package/types/src/transforms/index.d.ts

@@ -0,0 +1,9 @@
+import toc = require("./toc");
+import sectionToc = require("./sectionToc");
+import code = require("./code");
+import file = require("./file");
+import remoteContent = require("./remote");
+import fileTree = require("./fileTree");
+import install = require("./install");
+export { toc as TOC, sectionToc, code as CODE, file as FILE, remoteContent as REMOTE, fileTree, install };
+//# sourceMappingURL=index.d.ts.map

package/types/src/transforms/index.d.ts.map

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

package/types/src/transforms/install.d.ts

@@ -0,0 +1,25 @@
+export = install;
+/**
+ * ### > INSTALL
+ *
+ * Generate installation instructions in a markdown table format
+ *
+ * **Options:**
+ * - `packageName` (optional): The name of the package to install. If not provided, will try to read from package.json
+ *
+ * **Example:**
+ * ```md
+ * <!-- doc-gen INSTALL packageName=my-package -->
+ * Installation instructions will be generated here
+ * <!-- end-doc-gen -->
+ * ```
+ *
+ * Default `matchWord` is `doc-gen`
+ *
+ * ---
+ * @param {string} content The current content of the comment block
+ * @param {object} options The options passed in from the comment declaration
+ * @return {string} Updated content to place in the content block
+ */
+declare function install(api: any): string;
+//# sourceMappingURL=install.d.ts.map

package/types/src/transforms/install.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../../../src/transforms/install.js"],"names":[],"mappings":";AAGA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,oCAFY,MAAM,CAqDjB"}