@powerlines/plugin-automd 0.1.0

package/dist/src/index.cjs

@@ -0,0 +1,7 @@
+'use strict';Object.defineProperty(exports,'__esModule',{value:true});var toArray=require('@stryke/convert/to-array'),isFile=require('@stryke/fs/is-file'),listFiles=require('@stryke/fs/list-files'),append=require('@stryke/path/append'),isType=require('@stryke/path/is-type'),joinPaths=require('@stryke/path/join-paths'),replace=require('@stryke/path/replace'),automd=require('automd'),c12=require('c12'),f=require('defu'),C=require('markdown-toc'),types=require('./types');function _interopDefault(e){return e&&e.__esModule?e:{default:e}}var f__default=/*#__PURE__*/_interopDefault(f);var C__default=/*#__PURE__*/_interopDefault(C);/*****************************************
+*
+*      ⚡ Built by Storm Software
+*
+*****************************************/
+
+var u=Object.defineProperty;var r=(i,o)=>u(i,"name",{value:o,configurable:true});const w=r((i={})=>({name:"automd",async config(){const o=await automd.loadConfig(joinPaths.joinPaths(this.workspaceConfig.workspaceRoot,this.config.projectRoot),i);return (!o.prefix||!Array.isArray(o.prefix))&&(o.prefix=toArray.toArray(o.prefix??[])),o.prefix.includes("automd")||o.prefix.push("automd"),o.prefix.includes("powerlines")||o.prefix.push("powerlines"),{automd:f__default.default(o??{},{configFile:i.configFile,allowIssues:true,dir:this.config.projectRoot,watch:false,input:"README.md",toc:{maxDepth:6,bullets:"-"}})}},async configResolved(){if(this.config.automd.configFile){const{config:o}=await c12.loadConfig({cwd:this.config.automd.dir,configFile:this.config.automd.configFile,defaults:{ignore:["**/node_modules","**/dist","**/.*"],dir:this.config.automd.dir}});this.config.automd=automd.resolveConfig(f__default.default(this.config.automd,{...o,prefix:toArray.toArray(o.prefix??[])}));}this.config.automd.input=(await Promise.all(toArray.toArray(this.config.automd.input).map(async o=>o.includes("*")?listFiles.listFiles(isType.isAbsolutePath(o)?o:append.appendPath(o,this.config.projectRoot),{ignore:this.config.automd.ignore}):isType.isAbsolutePath(o)?o:append.appendPath(o,this.config.projectRoot)))).flat(),this.config.automd.output&&!isType.isAbsolutePath(this.config.automd.output)&&(this.config.automd.output=append.appendPath(this.config.automd.output,this.config.projectRoot)),this.config.automd.generators??={},this.config.automd.toc!==false&&(this.config.automd.generators.toc??={name:"toc",generate:r(o=>{const t=this.config.automd.toc??{};return {contents:C__default.default(o.block.md,{...t,maxdepth:t.maxDepth,firsth1:t.firstH1}).content}},"generate")});},async docs(){await Promise.all(toArray.toArray(this.config.automd.input).map(async o=>{const t=await this.fs.readFile(o);if(t){const n=await automd.transform(t,this.config.automd);if(n.hasIssues&&this.config.automd.allowIssues===false)throw new Error(`AutoMD found issues in file "${o}". Please resolve the issues or set \`allowIssues\` to true in the plugin configuration to ignore them.`);n.hasChanged&&await this.fs.writeFile(append.appendPath(this.config.automd.output?isFile.isDirectory(this.config.automd.output)?replace.replacePath(o,this.config.automd.output):this.config.automd.output:o,this.config.projectRoot),n.contents,{mode:"fs"});}}));}}),"plugin");var K=w;exports.default=K;exports.plugin=w;Object.keys(types).forEach(function(k){if(k!=='default'&&!Object.prototype.hasOwnProperty.call(exports,k))Object.defineProperty(exports,k,{enumerable:true,get:function(){return types[k]}})});

package/dist/src/index.d.cts

@@ -0,0 +1,39 @@
+import { A as AutoMDPluginContext, a as AutoMDPluginOptions, P as Plugin } from '../index-DOPvmpxM.cjs';
+export { c as AutoMDPluginResolvedConfig, b as AutoMDPluginUserConfig } from '../index-DOPvmpxM.cjs';
+export { TOCOptions } from '../types/toc.cjs';
+import 'automd';
+import '@storm-software/build-tools/types';
+import '@storm-software/config-tools/types';
+import '@storm-software/config/types';
+import '@stryke/types/base';
+import '@stryke/types/configuration';
+import '@stryke/types/file';
+import 'vite';
+import '@stryke/env/get-env-paths';
+import '@stryke/types/package-json';
+import 'jiti';
+import 'oxc-parser';
+import 'semver';
+import 'unplugin';
+import '@stryke/types/tsconfig';
+import 'typescript';
+import '@stryke/json/types';
+import 'memfs';
+import 'node:fs';
+import 'unionfs';
+import '@stryke/types/array';
+
+/**
+ * AutoMD Plugin
+ *
+ * @remarks
+ * A Powerlines plugin to use the AutoMD markdown transformer during the prepare task.
+ *
+ * @see https://automd.unjs.io/
+ *
+ * @param options - The plugin options.
+ * @returns A Powerlines plugin instance.
+ */
+declare const plugin: <TContext extends AutoMDPluginContext = AutoMDPluginContext>(options?: AutoMDPluginOptions) => Plugin<TContext>;
+
+export { AutoMDPluginContext, AutoMDPluginOptions, plugin as default, plugin };

package/dist/src/index.d.ts

@@ -0,0 +1,39 @@
+import { A as AutoMDPluginContext, a as AutoMDPluginOptions, P as Plugin } from '../index-4ixdjnnj.js';
+export { c as AutoMDPluginResolvedConfig, b as AutoMDPluginUserConfig } from '../index-4ixdjnnj.js';
+export { TOCOptions } from '../types/toc.js';
+import 'automd';
+import '@storm-software/build-tools/types';
+import '@storm-software/config-tools/types';
+import '@storm-software/config/types';
+import '@stryke/types/base';
+import '@stryke/types/configuration';
+import '@stryke/types/file';
+import 'vite';
+import '@stryke/env/get-env-paths';
+import '@stryke/types/package-json';
+import 'jiti';
+import 'oxc-parser';
+import 'semver';
+import 'unplugin';
+import '@stryke/types/tsconfig';
+import 'typescript';
+import '@stryke/json/types';
+import 'memfs';
+import 'node:fs';
+import 'unionfs';
+import '@stryke/types/array';
+
+/**
+ * AutoMD Plugin
+ *
+ * @remarks
+ * A Powerlines plugin to use the AutoMD markdown transformer during the prepare task.
+ *
+ * @see https://automd.unjs.io/
+ *
+ * @param options - The plugin options.
+ * @returns A Powerlines plugin instance.
+ */
+declare const plugin: <TContext extends AutoMDPluginContext = AutoMDPluginContext>(options?: AutoMDPluginOptions) => Plugin<TContext>;
+
+export { AutoMDPluginContext, AutoMDPluginOptions, plugin as default, plugin };

package/dist/src/index.js

@@ -0,0 +1,7 @@
+import {toArray}from'@stryke/convert/to-array';import {isDirectory}from'@stryke/fs/is-file';import {listFiles}from'@stryke/fs/list-files';import {appendPath}from'@stryke/path/append';import {isAbsolutePath}from'@stryke/path/is-type';import {joinPaths}from'@stryke/path/join-paths';import {replacePath}from'@stryke/path/replace';import {transform,resolveConfig,loadConfig as loadConfig$1}from'automd';import {loadConfig}from'c12';import f from'defu';import C from'markdown-toc';export*from'./types';/*****************************************
+*
+*      ⚡ Built by Storm Software
+*
+*****************************************/
+
+var u=Object.defineProperty;var r=(i,o)=>u(i,"name",{value:o,configurable:true});const w=r((i={})=>({name:"automd",async config(){const o=await loadConfig$1(joinPaths(this.workspaceConfig.workspaceRoot,this.config.projectRoot),i);return (!o.prefix||!Array.isArray(o.prefix))&&(o.prefix=toArray(o.prefix??[])),o.prefix.includes("automd")||o.prefix.push("automd"),o.prefix.includes("powerlines")||o.prefix.push("powerlines"),{automd:f(o??{},{configFile:i.configFile,allowIssues:true,dir:this.config.projectRoot,watch:false,input:"README.md",toc:{maxDepth:6,bullets:"-"}})}},async configResolved(){if(this.config.automd.configFile){const{config:o}=await loadConfig({cwd:this.config.automd.dir,configFile:this.config.automd.configFile,defaults:{ignore:["**/node_modules","**/dist","**/.*"],dir:this.config.automd.dir}});this.config.automd=resolveConfig(f(this.config.automd,{...o,prefix:toArray(o.prefix??[])}));}this.config.automd.input=(await Promise.all(toArray(this.config.automd.input).map(async o=>o.includes("*")?listFiles(isAbsolutePath(o)?o:appendPath(o,this.config.projectRoot),{ignore:this.config.automd.ignore}):isAbsolutePath(o)?o:appendPath(o,this.config.projectRoot)))).flat(),this.config.automd.output&&!isAbsolutePath(this.config.automd.output)&&(this.config.automd.output=appendPath(this.config.automd.output,this.config.projectRoot)),this.config.automd.generators??={},this.config.automd.toc!==false&&(this.config.automd.generators.toc??={name:"toc",generate:r(o=>{const t=this.config.automd.toc??{};return {contents:C(o.block.md,{...t,maxdepth:t.maxDepth,firsth1:t.firstH1}).content}},"generate")});},async docs(){await Promise.all(toArray(this.config.automd.input).map(async o=>{const t=await this.fs.readFile(o);if(t){const n=await transform(t,this.config.automd);if(n.hasIssues&&this.config.automd.allowIssues===false)throw new Error(`AutoMD found issues in file "${o}". Please resolve the issues or set \`allowIssues\` to true in the plugin configuration to ignore them.`);n.hasChanged&&await this.fs.writeFile(appendPath(this.config.automd.output?isDirectory(this.config.automd.output)?replacePath(o,this.config.automd.output):this.config.automd.output:o,this.config.projectRoot),n.contents,{mode:"fs"});}}));}}),"plugin");var L=w;export{L as default,w as plugin};

package/dist/types/index.cjs

@@ -0,0 +1 @@
+'use strict';var plugin=require('./plugin'),toc=require('./toc');Object.keys(plugin).forEach(function(k){if(k!=='default'&&!Object.prototype.hasOwnProperty.call(exports,k))Object.defineProperty(exports,k,{enumerable:true,get:function(){return plugin[k]}})});Object.keys(toc).forEach(function(k){if(k!=='default'&&!Object.prototype.hasOwnProperty.call(exports,k))Object.defineProperty(exports,k,{enumerable:true,get:function(){return toc[k]}})});

package/dist/types/index.d.cts

@@ -0,0 +1,23 @@
+export { A as AutoMDPluginContext, a as AutoMDPluginOptions, c as AutoMDPluginResolvedConfig, b as AutoMDPluginUserConfig } from '../index-DOPvmpxM.cjs';
+export { TOCOptions } from './toc.cjs';
+import 'automd';
+import '@storm-software/build-tools/types';
+import '@storm-software/config-tools/types';
+import '@storm-software/config/types';
+import '@stryke/types/base';
+import '@stryke/types/configuration';
+import '@stryke/types/file';
+import 'vite';
+import '@stryke/env/get-env-paths';
+import '@stryke/types/package-json';
+import 'jiti';
+import 'oxc-parser';
+import 'semver';
+import 'unplugin';
+import '@stryke/types/tsconfig';
+import 'typescript';
+import '@stryke/json/types';
+import 'memfs';
+import 'node:fs';
+import 'unionfs';
+import '@stryke/types/array';

package/dist/types/index.d.ts

@@ -0,0 +1,23 @@
+export { A as AutoMDPluginContext, a as AutoMDPluginOptions, c as AutoMDPluginResolvedConfig, b as AutoMDPluginUserConfig } from '../index-4ixdjnnj.js';
+export { TOCOptions } from './toc.js';
+import 'automd';
+import '@storm-software/build-tools/types';
+import '@storm-software/config-tools/types';
+import '@storm-software/config/types';
+import '@stryke/types/base';
+import '@stryke/types/configuration';
+import '@stryke/types/file';
+import 'vite';
+import '@stryke/env/get-env-paths';
+import '@stryke/types/package-json';
+import 'jiti';
+import 'oxc-parser';
+import 'semver';
+import 'unplugin';
+import '@stryke/types/tsconfig';
+import 'typescript';
+import '@stryke/json/types';
+import 'memfs';
+import 'node:fs';
+import 'unionfs';
+import '@stryke/types/array';

package/dist/types/index.js

@@ -0,0 +1 @@
+export*from'./plugin';export*from'./toc';

package/dist/types/plugin.cjs

@@ -0,0 +1 @@
+'use strict';

package/dist/types/plugin.d.cts

@@ -0,0 +1,23 @@
+import 'automd';
+export { A as AutoMDPluginContext, a as AutoMDPluginOptions, c as AutoMDPluginResolvedConfig, b as AutoMDPluginUserConfig } from '../index-DOPvmpxM.cjs';
+import './toc.cjs';
+import '@storm-software/build-tools/types';
+import '@storm-software/config-tools/types';
+import '@storm-software/config/types';
+import '@stryke/types/base';
+import '@stryke/types/configuration';
+import '@stryke/types/file';
+import 'vite';
+import '@stryke/env/get-env-paths';
+import '@stryke/types/package-json';
+import 'jiti';
+import 'oxc-parser';
+import 'semver';
+import 'unplugin';
+import '@stryke/types/tsconfig';
+import 'typescript';
+import '@stryke/json/types';
+import 'memfs';
+import 'node:fs';
+import 'unionfs';
+import '@stryke/types/array';

package/dist/types/plugin.d.ts

@@ -0,0 +1,23 @@
+import 'automd';
+export { A as AutoMDPluginContext, a as AutoMDPluginOptions, c as AutoMDPluginResolvedConfig, b as AutoMDPluginUserConfig } from '../index-4ixdjnnj.js';
+import './toc.js';
+import '@storm-software/build-tools/types';
+import '@storm-software/config-tools/types';
+import '@storm-software/config/types';
+import '@stryke/types/base';
+import '@stryke/types/configuration';
+import '@stryke/types/file';
+import 'vite';
+import '@stryke/env/get-env-paths';
+import '@stryke/types/package-json';
+import 'jiti';
+import 'oxc-parser';
+import 'semver';
+import 'unplugin';
+import '@stryke/types/tsconfig';
+import 'typescript';
+import '@stryke/json/types';
+import 'memfs';
+import 'node:fs';
+import 'unionfs';
+import '@stryke/types/array';

package/dist/types/toc.cjs

@@ -0,0 +1 @@
+'use strict';

package/dist/types/toc.d.cts

@@ -0,0 +1,32 @@
+interface TOCOptions {
+    /**
+     * A slugify function to generate slugs for the headings.
+     */
+    slugify?: (str: string) => string;
+    /**
+     * The maximum depth of headings to include in the TOC.
+     *
+     * @defaultValue 6
+     */
+    maxDepth?: number;
+    /**
+     * Whether to include the first H1 heading in the TOC.
+     */
+    firstH1?: boolean;
+    /**
+     * The bullet character to use for list items in the TOC.
+     *
+     * @defaultValue "-"
+     */
+    bullets?: string;
+    /**
+     * A prefix to add to each heading in the TOC.
+     */
+    prefix?: string;
+    /**
+     * A filter function to determine which headings to include in the TOC.
+     */
+    filter?: (str: string, level: number) => boolean;
+}
+
+export type { TOCOptions };

package/dist/types/toc.d.ts

@@ -0,0 +1,32 @@
+interface TOCOptions {
+    /**
+     * A slugify function to generate slugs for the headings.
+     */
+    slugify?: (str: string) => string;
+    /**
+     * The maximum depth of headings to include in the TOC.
+     *
+     * @defaultValue 6
+     */
+    maxDepth?: number;
+    /**
+     * Whether to include the first H1 heading in the TOC.
+     */
+    firstH1?: boolean;
+    /**
+     * The bullet character to use for list items in the TOC.
+     *
+     * @defaultValue "-"
+     */
+    bullets?: string;
+    /**
+     * A prefix to add to each heading in the TOC.
+     */
+    prefix?: string;
+    /**
+     * A filter function to determine which headings to include in the TOC.
+     */
+    filter?: (str: string, level: number) => boolean;
+}
+
+export type { TOCOptions };

package/package.json

@@ -0,0 +1,120 @@
+{
+  "name": "@powerlines/plugin-automd",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "A Powerlines plugin to maintain a project's markdown files using AutoMD generators.",
+  "repository": {
+    "type": "github",
+    "url": "https://github.com/storm-software/powerlines.git",
+    "directory": "packages/plugin-automd"
+  },
+  "homepage": "https://stormsoftware.com",
+  "bugs": {
+    "url": "https://stormsoftware.com/support",
+    "email": "support@stormsoftware.com"
+  },
+  "author": {
+    "name": "Storm Software",
+    "email": "contact@stormsoftware.com",
+    "url": "https://stormsoftware.com"
+  },
+  "maintainers": [
+    {
+      "name": "Storm Software",
+      "email": "contact@stormsoftware.com",
+      "url": "https://stormsoftware.com"
+    }
+  ],
+  "contributors": [
+    {
+      "name": "Storm Software",
+      "email": "contact@stormsoftware.com",
+      "url": "https://stormsoftware.com"
+    }
+  ],
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/storm-software"
+  },
+  "license": "Apache-2.0",
+  "private": false,
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      },
+      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.js" }
+    },
+    "./index": {
+      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      },
+      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.js" }
+    },
+    "./plugin": {
+      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      },
+      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.js" }
+    },
+    "./types": {
+      "import": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/types/index.js"
+      },
+      "require": {
+        "types": "./dist/types/index.d.cts",
+        "default": "./dist/types/index.cjs"
+      },
+      "default": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/types/index.js"
+      }
+    },
+    "./types/*": {
+      "import": {
+        "types": "./dist/types/*.d.ts",
+        "default": "./dist/types/*.js"
+      },
+      "require": {
+        "types": "./dist/types/*.d.cts",
+        "default": "./dist/types/*.cjs"
+      },
+      "default": {
+        "types": "./dist/types/*.d.ts",
+        "default": "./dist/types/*.js"
+      }
+    }
+  },
+  "typings": "dist/index.d.ts",
+  "files": ["dist/**/*"],
+  "keywords": ["automd", "powerlines", "storm-software", "powerlines-plugin"],
+  "dependencies": {
+    "@stryke/convert": "^0.6.0",
+    "@stryke/fs": "^0.32.10",
+    "@stryke/path": "^0.18.5",
+    "@stryke/type-checks": "^0.3.10",
+    "@stryke/types": "^0.10.0",
+    "c12": "^3.3.1",
+    "defu": "^6.1.4",
+    "markdown-toc": "^1.2.0",
+    "powerlines": "^0.15.0"
+  },
+  "devDependencies": {
+    "@powerlines/nx": "^0.10.0",
+    "@powerlines/plugin-plugin": "^0.11.8",
+    "@types/node": "^22.19.0",
+    "automd": "^0.4.2"
+  },
+  "publishConfig": { "access": "public" },
+  "gitHead": "b64f9a9d53b6eb8054c361da347f6623a7ba9e45"
+}