@breadstone-infrastructure/vite 0.0.216 → 0.0.217

package/index.d.ts

@@ -3,6 +3,8 @@ export type { IStaticContentPluginOptions } from './plugins/static-content/inter
 export { staticContentPlugin } from './plugins/static-content/StaticContentPlugin.js';
 export type { ILiveReloadPluginOptions } from './plugins/live-reload/interfaces/ILiveReloadPluginOptions.js';
 export { liveReloadPlugin } from './plugins/live-reload/LiveReloadPlugin.js';
+export type { ILlmsPluginOptions } from './plugins/llms/interfaces/ILlmsPluginOptions.js';
+export { llmsPlugin } from './plugins/llms/llmsPlugin.js';
 export { VIRTUAL_MODULE_KEY as LOCALIZATOR_VIRTUAL_MODULE_KEY } from './plugins/localizator/LocalizatorPlugin.js';
 export type { ILocalizatorPluginOptions } from './plugins/localizator/interfaces/ILocalizatorPluginOptions.js';
 export { localizatorPlugin } from './plugins/localizator/LocalizatorPlugin.js';

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,IAAI,iCAAiC,EAAE,MAAM,iDAAiD,CAAC;AAC1H,YAAY,EAAE,2BAA2B,EAAE,MAAM,oEAAoE,CAAC;AACtH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iDAAiD,CAAC;AAEtF,YAAY,EAAE,wBAAwB,EAAE,MAAM,8DAA8D,CAAC;AAC7G,OAAO,EAAE,gBAAgB,EAAE,MAAM,2CAA2C,CAAC;AAE7E,OAAO,EAAE,kBAAkB,IAAI,8BAA8B,EAAE,MAAM,4CAA4C,CAAC;AAClH,YAAY,EAAE,yBAAyB,EAAE,MAAM,+DAA+D,CAAC;AAC/G,OAAO,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AAE/E,OAAO,EAAE,GAAG,IAAI,YAAY,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,kBAAkB,IAAI,6BAA6B,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAC/H,YAAY,EAAE,uBAAuB,EAAE,MAAM,4DAA4D,CAAC;AAC1G,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AACxE,YAAY,EAAE,eAAe,EAAE,MAAM,+CAA+C,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,IAAI,iCAAiC,EAAE,MAAM,iDAAiD,CAAC;AAC1H,YAAY,EAAE,2BAA2B,EAAE,MAAM,oEAAoE,CAAC;AACtH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iDAAiD,CAAC;AAEtF,YAAY,EAAE,wBAAwB,EAAE,MAAM,8DAA8D,CAAC;AAC7G,OAAO,EAAE,gBAAgB,EAAE,MAAM,2CAA2C,CAAC;AAE7E,YAAY,EAAE,kBAAkB,EAAE,MAAM,iDAAiD,CAAC;AAC1F,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D,OAAO,EAAE,kBAAkB,IAAI,8BAA8B,EAAE,MAAM,4CAA4C,CAAC;AAClH,YAAY,EAAE,yBAAyB,EAAE,MAAM,+DAA+D,CAAC;AAC/G,OAAO,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AAE/E,OAAO,EAAE,GAAG,IAAI,YAAY,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,kBAAkB,IAAI,6BAA6B,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAC/H,YAAY,EAAE,uBAAuB,EAAE,MAAM,4DAA4D,CAAC;AAC1G,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AACxE,YAAY,EAAE,eAAe,EAAE,MAAM,+CAA+C,CAAC"}

package/index.js

@@ -1,6 +1,7 @@
 export { VIRTUAL_MODULE_KEY as STATIC_CONTENT_VIRTUAL_MODULE_KEY } from './plugins/static-content/StaticContentPlugin.js';
 export { staticContentPlugin } from './plugins/static-content/StaticContentPlugin.js';
 export { liveReloadPlugin } from './plugins/live-reload/LiveReloadPlugin.js';
+export { llmsPlugin } from './plugins/llms/llmsPlugin.js';
 export { VIRTUAL_MODULE_KEY as LOCALIZATOR_VIRTUAL_MODULE_KEY } from './plugins/localizator/LocalizatorPlugin.js';
 export { localizatorPlugin } from './plugins/localizator/LocalizatorPlugin.js';
 export { run as envExportRun } from './plugins/env-export/envExport.js';

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,IAAI,iCAAiC,EAAE,MAAM,iDAAiD,CAAC;AAE1H,OAAO,EAAE,mBAAmB,EAAE,MAAM,iDAAiD,CAAC;AAGtF,OAAO,EAAE,gBAAgB,EAAE,MAAM,2CAA2C,CAAC;AAE7E,OAAO,EAAE,kBAAkB,IAAI,8BAA8B,EAAE,MAAM,4CAA4C,CAAC;AAElH,OAAO,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AAE/E,OAAO,EAAE,GAAG,IAAI,YAAY,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,kBAAkB,IAAI,6BAA6B,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAE/H,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AAGxE,uCAAuC;AACvC,0CAA0C;AAC1C,sCAAsC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,IAAI,iCAAiC,EAAE,MAAM,iDAAiD,CAAC;AAE1H,OAAO,EAAE,mBAAmB,EAAE,MAAM,iDAAiD,CAAC;AAGtF,OAAO,EAAE,gBAAgB,EAAE,MAAM,2CAA2C,CAAC;AAG7E,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D,OAAO,EAAE,kBAAkB,IAAI,8BAA8B,EAAE,MAAM,4CAA4C,CAAC;AAElH,OAAO,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AAE/E,OAAO,EAAE,GAAG,IAAI,YAAY,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,kBAAkB,IAAI,6BAA6B,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAE/H,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AAGxE,uCAAuC;AACvC,0CAA0C;AAC1C,sCAAsC"}

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@breadstone-infrastructure/vite",
     "description": "Vite configuration and plugins",
-    "version": "0.0.216",
+    "version": "0.0.217",
     "license": "MIT",
     "author": "andre.wehlert <awehlert@breadstone.de> (https://www.breadstone.de)",
     "repository": {
@@ -12,8 +12,8 @@
     "module": "./index.js",
     "types": "./index.d.ts",
     "dependencies": {
-        "@breadstone-infrastructure/utilities": "^0.0.216",
-        "@breadstone-tools/localizator-core": "^0.0.216",
+        "@breadstone-infrastructure/utilities": "^0.0.217",
+        "@breadstone-tools/localizator-core": "^0.0.217",
         "gray-matter": "^4.0.3"
     },
     "peerDependencies": {

package/plugins/llms/interfaces/ILlmsPluginOptions.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Options for the LLMS Vite plugin.
+ *
+ * @public
+ */
+export interface ILlmsPluginOptions {
+    /**
+     * Output directory for the generated `llms.txt` file.
+     */
+    dist: string;
+    /**
+     * Directory that contains the markdown files to list.
+     */
+    directory: string;
+    /**
+     * Header content placed at the top of `llms.txt`.
+     * This is where project description, installation instructions,
+     * architecture details, etc. should be defined.
+     */
+    header?: string;
+    /**
+     * Optional header text before the file list.
+     * Example: "## Component Documentation Files"
+     */
+    fileListHeader?: string;
+    /**
+     * Footer content placed at the end of `llms.txt`.
+     * Example: "If a capability is not described, it does not exist."
+     */
+    footer?: string;
+    /**
+     * Whether to format file entries as markdown links.
+     * If true: `- [file.md](llms/file.md)`
+     * If false: `- file.md`
+     *
+     * @default false
+     */
+    useMarkdownLinks?: boolean;
+    /**
+     * Prefix for markdown links.
+     * Only used when `useMarkdownLinks` is true.
+     *
+     * @default 'llms'
+     */
+    linkPrefix?: string;
+}
+//# sourceMappingURL=ILlmsPluginOptions.d.ts.map

package/plugins/llms/interfaces/ILlmsPluginOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ILlmsPluginOptions.d.ts","sourceRoot":"","sources":["../../../../src/plugins/llms/interfaces/ILlmsPluginOptions.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAE/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB"}

package/plugins/llms/interfaces/ILlmsPluginOptions.js

@@ -0,0 +1,3 @@
+// plugins/interfaces/ILlmsPluginOptions.ts
+export {};
+//# sourceMappingURL=ILlmsPluginOptions.js.map

package/plugins/llms/interfaces/ILlmsPluginOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ILlmsPluginOptions.js","sourceRoot":"","sources":["../../../../src/plugins/llms/interfaces/ILlmsPluginOptions.ts"],"names":[],"mappings":"AAAA,2CAA2C"}

package/plugins/llms/llmsPlugin.d.ts

@@ -0,0 +1,15 @@
+import { type Plugin } from 'vite';
+import type { ILlmsPluginOptions } from './interfaces/ILlmsPluginOptions.js';
+/**
+ * Vite plugin that generates a `llms.txt` file based on markdown files
+ * contained in a given directory.
+ *
+ * The plugin scans the specified directory for markdown files and generates
+ * a consolidated llms.txt file with configurable header, footer, and file list format.
+ *
+ * @public
+ * @param options - Plugin configuration
+ * @returns Vite-compatible plugin
+ */
+export declare const llmsPlugin: (options: ILlmsPluginOptions) => Plugin;
+//# sourceMappingURL=llmsPlugin.d.ts.map

package/plugins/llms/llmsPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"llmsPlugin.d.ts","sourceRoot":"","sources":["../../../src/plugins/llms/llmsPlugin.ts"],"names":[],"mappings":"AAIA,OAAO,EAAgB,KAAK,MAAM,EAAE,MAAM,MAAM,CAAC;AAGjD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AAI7E;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,GAAI,SAAS,kBAAkB,KAAG,MA0ExD,CAAC"}

package/plugins/llms/llmsPlugin.js

@@ -0,0 +1,78 @@
+// plugins/llmsPlugin.ts
+// #region Imports
+import { createLogger } from 'vite';
+import path from 'path';
+import { readdir, stat, writeFile } from 'node:fs/promises';
+// #endregion
+/**
+ * Vite plugin that generates a `llms.txt` file based on markdown files
+ * contained in a given directory.
+ *
+ * The plugin scans the specified directory for markdown files and generates
+ * a consolidated llms.txt file with configurable header, footer, and file list format.
+ *
+ * @public
+ * @param options - Plugin configuration
+ * @returns Vite-compatible plugin
+ */
+export const llmsPlugin = (options) => {
+    const logger = createLogger(undefined, { console: console });
+    return {
+        name: 'vite-plugin-llms',
+        apply: 'build',
+        async closeBundle() {
+            const llmsDirectory = path.resolve(options.directory);
+            const distDirectory = path.resolve(options.dist);
+            // Ensure directory exists
+            try {
+                const directoryStat = await stat(llmsDirectory);
+                if (!directoryStat.isDirectory()) {
+                    logger.warn(`[vite-plugin-llms]: Path is not a directory: ${llmsDirectory}`);
+                    return;
+                }
+            }
+            catch {
+                // Directory does not exist → nothing to do
+                logger.warn(`[vite-plugin-llms]: Directory does not exist: ${llmsDirectory}`);
+                return;
+            }
+            // Read markdown files
+            const files = await readdir(llmsDirectory);
+            const markdownFiles = files
+                .filter((file) => file.endsWith('.md'))
+                .sort();
+            // Build llms.txt content
+            const lines = [];
+            // Add header content
+            if (options.header) {
+                lines.push(options.header.trim());
+                lines.push('');
+            }
+            // Add file list header
+            if (options.fileListHeader) {
+                lines.push(options.fileListHeader.trim());
+                lines.push('');
+            }
+            // Add file list
+            const linkPrefix = options.linkPrefix ?? 'llms';
+            for (const file of markdownFiles) {
+                if (options.useMarkdownLinks) {
+                    lines.push(`- [${file}](${linkPrefix}/${file})`);
+                }
+                else {
+                    lines.push(`- ${file}`);
+                }
+            }
+            // Add footer content
+            if (options.footer) {
+                lines.push('');
+                lines.push(options.footer.trim());
+            }
+            const output = lines.join('\n');
+            // Write llms.txt
+            logger.info(`[vite-plugin-llms]: Writing llms.txt with ${markdownFiles.length} files`);
+            await writeFile(path.join(distDirectory, 'llms.txt'), output, 'utf-8');
+        }
+    };
+};
+//# sourceMappingURL=llmsPlugin.js.map

package/plugins/llms/llmsPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"llmsPlugin.js","sourceRoot":"","sources":["../../../src/plugins/llms/llmsPlugin.ts"],"names":[],"mappings":"AAAA,wBAAwB;AAExB,kBAAkB;AAElB,OAAO,EAAE,YAAY,EAAe,MAAM,MAAM,CAAC;AACjD,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAG5D,aAAa;AAEb;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,OAA2B,EAAU,EAAE;IAC9D,MAAM,MAAM,GAAG,YAAY,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAE7D,OAAO;QACH,IAAI,EAAE,kBAAkB;QACxB,KAAK,EAAE,OAAO;QACd,KAAK,CAAC,WAAW;YACb,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YACtD,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAEjD,0BAA0B;YAC1B,IAAI,CAAC;gBACD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC;gBAEhD,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,CAAC;oBAC/B,MAAM,CAAC,IAAI,CAAC,gDAAgD,aAAa,EAAE,CAAC,CAAC;oBAC7E,OAAO;gBACX,CAAC;YACL,CAAC;YAAC,MAAM,CAAC;gBACL,2CAA2C;gBAC3C,MAAM,CAAC,IAAI,CAAC,iDAAiD,aAAa,EAAE,CAAC,CAAC;gBAC9E,OAAO;YACX,CAAC;YAED,sBAAsB;YACtB,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,CAAC;YAE3C,MAAM,aAAa,GAAG,KAAK;iBACtB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;iBACtC,IAAI,EAAE,CAAC;YAEZ,yBAAyB;YACzB,MAAM,KAAK,GAAkB,EAAE,CAAC;YAEhC,qBAAqB;YACrB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACjB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;gBAClC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACnB,CAAC;YAED,uBAAuB;YACvB,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;gBACzB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC1C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACnB,CAAC;YAED,gBAAgB;YAChB,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,MAAM,CAAC;YAEhD,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE,CAAC;gBAC/B,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;oBAC3B,KAAK,CAAC,IAAI,CAAC,MAAM,IAAI,KAAK,UAAU,IAAI,IAAI,GAAG,CAAC,CAAC;gBACrD,CAAC;qBAAM,CAAC;oBACJ,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;gBAC5B,CAAC;YACL,CAAC;YAED,qBAAqB;YACrB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACjB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YACtC,CAAC;YAED,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEhC,iBAAiB;YACjB,MAAM,CAAC,IAAI,CAAC,6CAA6C,aAAa,CAAC,MAAM,QAAQ,CAAC,CAAC;YACvF,MAAM,SAAS,CACX,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,EACpC,MAAM,EACN,OAAO,CACV,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC,CAAC"}