@p-buddy/parkdown 0.0.1 → 0.0.3

package/src/utils.ts

@@ -1,184 +0,0 @@
-import { unified, type Plugin } from 'unified';
-import remarkParse from 'remark-parse';
-import { visit } from 'unist-util-visit';
-import hash from 'stable-hash';
-
-export type AstRoot = typeof remarkParse extends Plugin<any, any, infer Root>
-/**/ ? Root
-/**/ : never;
-
-export type MarkdownNode = AstRoot["children"][number];
-export type NodeType = MarkdownNode["type"];
-export type SpecificNode<T extends NodeType> = MarkdownNode & { type: T };
-
-type RequiredDeep<T> = {
-  [P in keyof T]-?: T[P] extends object | undefined ? RequiredDeep<T[P]> : T[P];
-};
-
-export type HasPosition = RequiredDeep<Pick<MarkdownNode, "position">>;
-export type Position = HasPosition['position'];
-export type Point = Position['start' | 'end'];
-
-export const nodeSort = (a: HasPosition, b: HasPosition) => a.position.start.offset - b.position.start.offset;
-
-nodeSort.reverse = (a: HasPosition, b: HasPosition) => nodeSort(b, a);
-
-export const hasPosition = <T extends MarkdownNode>(node: T): node is T & HasPosition =>
-  node.position !== undefined && node.position.start.offset !== undefined && node.position.end.offset !== undefined;
-
-const processor = unified().use(remarkParse);
-
-export const parse = {
-  md: (markdown: string) => processor.parse(markdown) satisfies AstRoot
-} as const;
-
-export const getAllPositionNodes = <T extends NodeType>(ast: AstRoot, type?: T) => {
-  type Node = SpecificNode<T> & HasPosition & { parentID: string; siblingIndex: number; siblingCount: number };
-  const nodes: Node[] = [];
-  visit(ast, (node, siblingIndex, parent) => {
-    if (node.type === "root") return;
-    else if (type && node.type !== type) return;
-    else if (hasPosition(node)) {
-      const parentID = hash(parent);
-      const siblingCount = (parent?.children.length ?? 0) - 1;
-      nodes.push({ ...node, parentID, siblingIndex, siblingCount } as Node);
-    }
-  });
-  return nodes;
-}
-
-export type PositionNode<T extends NodeType> = ReturnType<typeof getAllPositionNodes<T>>[number];
-
-export type Link = PositionNode<"link">;
-export type Html = PositionNode<"html">;
-
-export const linkHasNoText = (node: Link) => node.children.length === 0;
-
-export const extractContent = (markdown: string, ...nodes: HasPosition[]) => {
-  if (nodes.length === 0) throw new Error("No nodes to extract content from");
-  nodes.sort(nodeSort);
-  const head = nodes.at(0)!;
-  const tail = nodes.at(-1)!;
-  return markdown.slice(head.position.start.offset, tail.position.end.offset);
-}
-
-export const replaceWithContent = (markdown: string, content: string, ...nodes: HasPosition[]) => {
-  if (nodes.length === 0) throw new Error("No nodes to replace content from");
-  nodes.sort(nodeSort);
-  const head = nodes.at(0)!;
-  const tail = nodes.at(-1)!;
-  return markdown.slice(0, head.position.start.offset) + content + markdown.slice(tail.position.end.offset);
-}
-
-export const getContentInBetween = (markdown: string, a: HasPosition, b: HasPosition) => {
-  const head = Math.min(a.position.end.offset, b.position.end.offset);
-  const tail = Math.max(a.position.start.offset, b.position.start.offset);
-  return markdown.slice(head, tail);
-}
-
-type Join<T extends string[], D extends string> =
-  T extends []
-    /**/ ? ''
-    /**/ : T extends [infer F extends string]
-      /**/ ? F
-      /**/ : T extends [infer F extends string, ...infer R extends string[]]
-        /**/ ? `${F}${D}${Join<R, D>}`
-        /**/ : string;
-
-export const spaced = <T extends string[]>(...args: T) => args.join(" ") as Join<T, " ">;
-export const lined = <T extends string[]>(...args: T) => args.join("\n") as Join<T, "\n">;
-
-export const start = ({ position: { start } }: HasPosition) => start;
-
-const offsetIndex = ({ start, end }: Position, offset: number) =>
-  ({ start: { line: start.line + offset, column: start.column + offset }, end: { line: end.line + offset, column: end.column + offset } });
-
-export const zeroIndexed = (position: Position) => offsetIndex(position, -1);
-export const oneIndexed = (position: Position) => offsetIndex(position, 1);
-
-export const seperateQueryParams = (path: string): [lhs: string, query: string] => {
-  const parts = path.split("?");
-  return parts.length > 1 ? [parts.slice(0, -1).join("?"), parts.at(-1)!] : [path, ""];
-}
-
-export const getQueryParams = (path: string) => seperateQueryParams(path)[1];
-
-export const removeQueryParams = (path: string) => seperateQueryParams(path)[0];
-
-
-export class Intervals {
-  private intervals: Array<[number, number]> = [];
-
-  push(start: number, end: number) {
-    this.intervals.push([Math.min(start, end), Math.max(start, end)]);
-  }
-
-  combine(rhs: Intervals) {
-    this.intervals.push(...rhs.intervals);
-  }
-
-  collapse() {
-    const { intervals } = this;
-    if (!intervals.length) return (this.intervals = []);
-
-    intervals.sort((a, b) => a[0] - b[0]);
-
-    const result: typeof this.intervals = [];
-    let [currStart, currEnd] = intervals[0];
-
-    for (let i = 1; i < intervals.length; i++) {
-      const [start, end] = intervals[i];
-      if (start <= currEnd) currEnd = Math.max(currEnd, end);
-      else {
-        result.push([currStart, currEnd]);
-        currStart = start;
-        currEnd = end;
-      }
-    }
-    result.push([currStart, currEnd]);
-
-    return (this.intervals = result);
-  }
-
-  subtract(rhs: Intervals) {
-    const { intervals } = this;
-    const { intervals: remove } = rhs;
-
-    if (!intervals.length || !remove.length) return intervals;
-
-    let result = [...intervals];
-    for (const [removeStart, removeEnd] of remove) {
-      const updated: typeof this.intervals = [];
-
-      for (const [start, end] of result) {
-        if (removeEnd <= start || removeStart >= end) {
-          updated.push([start, end]);
-          continue;
-        }
-
-        if (removeStart > start) updated.push([start, removeStart]);
-        if (removeEnd < end) updated.push([removeEnd, end]);
-      }
-
-      result = updated;
-    }
-
-    return (this.intervals = result);
-  }
-}
-
-export const COMMA_NOT_IN_PARENTHESIS = /,\s*(?![^()]*\))/;
-
-/** p▼: sanitize */
-const sanitizations: [from: RegExp | string, to: string][] = [
-  [/'''/g, `"`],
-  [/''/g, `'`],
-  [/parkdown:\s+/g, ``],
-  [/p▼:\s+/g, ``],
-]
-
-export const sanitize = (replacement: string, space: string = "-") => {
-  const sanitized = sanitizations.reduce((acc, [from, to]) => acc.replaceAll(from, to), replacement)
-  return space ? sanitized.replaceAll(space, " ") : sanitized;
-}
-/** p▼: sanitize */

package/src/wrap.ts

@@ -1,61 +0,0 @@
-import { createParser, type MethodDefinition } from "./api/";
-
-/** p▼: definition */
-const definitions = [
-  /**
-   * Wraps the content in a markdown-formatted code block.
-   * @param lang The language of the code block (defaults to the file extension).
-   * @param meta Additional metadata to include in the top line of the code block (i.e. to the right of the `lang`).
-   * @example [](<url>?wrap=code)
-   * @example [](<url>?wrap=code())
-   * @example [](<url>?wrap=code(ts))
-   * @example [](<url>?wrap=code(,some-meta))
-   */
-  "code(lang?: string, meta?: string)",
-
-  /**
-   * Wraps the content in a markdown-formatted blockquote 
-   * (using the `>` character if the content is a single line, 
-   * or the `<blockquote>` tag if the content is a multi-line block).
-   * @example [](<url>?wrap=quote)
-   * @example [](<url>?wrap=quote())
-   * @example [](<url>?wrap=quote(,))
-   */
-  "quote()",
-
-  /**
-   * Wraps the content in a markdown-formatted dropdown (using the `<details>` and `<summary>` tags).
-   * @param summary The summary text of the dropdown.
-   * @param open Whether the dropdown should be open by default.
-   * @param space The space character to use between words in the summary (defaults to `-`).
-   * @example [](<url>?wrap=dropdown(hello-world))
-   * @example [](<url>?wrap=dropdown('hello,-world',true))
-   * @example [](<url>?wrap=dropdown(hello_world,,_)) 
-   */
-  "dropdown(summary: string, open?: boolean, space?: string)",
-
-] /** p▼: definition */ satisfies (MethodDefinition)[];
-
-/** p▼: Default-Space */
-const DEFAULT_SPACE = "-";
-/** p▼: Default-Space */
-
-const parse = createParser(definitions);
-
-export const wrap = (content: string, query: string, details?: { extension: string, inline: boolean }): string => {
-  const parsed = parse(query);
-  const isSingleLine = details?.inline && !content.includes("\n\n");
-
-  switch (parsed.name) {
-    case "code":
-      const lang = parsed.lang ?? details?.extension ?? "";
-      const meta = parsed.meta ? ` ${parsed.meta}` : "";
-      return `\`\`\`${lang}${meta}\n${content}\n\`\`\``;
-    case "quote":
-      return isSingleLine ? `> ${content}` : `<blockquote>\n\n${content}\n\n</blockquote>\n`;
-    case "dropdown":
-      const head = `<details${parsed.open ? " open" : ""}>`;
-      const summary = `<summary>${parsed.summary.split(parsed.space ?? DEFAULT_SPACE).join(" ")}</summary>`;
-      return ["", head, summary, "", content, "</details>", ""].join("\n");
-  }
-}

package/tsconfig.json

@@ -1,5 +0,0 @@
-{
-  "compilerOptions": {
-    "moduleResolution": "bundler",
-  }
-}

package/vite.cli.config.ts

@@ -1,23 +0,0 @@
-import { defineConfig } from 'vite';
-import { resolve } from 'node:path';
-import { externalizeDeps } from 'vite-plugin-externalize-deps'
-import { name as packageName } from './package.json';
-
-export default defineConfig({
-  resolve: {
-    alias: {
-      '.': packageName,
-      './': packageName,
-      './index': packageName,
-    },
-  },
-  plugins: [externalizeDeps({ nodeBuiltins: true, include: [packageName] })],
-  build: {
-    lib: {
-      fileName: 'cli',
-      entry: resolve(__dirname, 'src/cli.ts'),
-      formats: ['es']
-    },
-    emptyOutDir: false,
-  }
-});

package/vite.config.ts

@@ -1,20 +0,0 @@
-import { resolve } from 'node:path';
-import { defineConfig } from 'vitest/config';
-import dts from 'vite-plugin-dts';
-import { externalizeDeps } from 'vite-plugin-externalize-deps';
-
-const testPattern = "src/**/*.{test,spec}.{js,ts}"
-
-export default defineConfig({
-  plugins: [dts({ exclude: testPattern, rollupTypes: true }), externalizeDeps({ nodeBuiltins: true })],
-  build: {
-    lib: {
-      name: 'index',
-      fileName: 'index',
-      entry: resolve(__dirname, 'src/index.ts'),
-    },
-  },
-  test: {
-    include: [testPattern],
-  },
-})