astro-accelerator-utils 0.1.3 → 0.1.4

package/index.d.mts

@@ -1,13 +1,13 @@
 import { DateFormatter } from "./lib/v1/dates.mjs";
-import { UrlFormatter } from "./lib/v1/urls.mjs";
+import { Markdown } from "./lib/v1/markdown.mjs";
 import { Posts } from "./lib/v1/posts.mjs";
+import { UrlFormatter } from "./lib/v1/urls.mjs";
 import * as Cache from "./lib/cache.mjs";
 import * as PostQueries from "./lib/postQueries.mjs";
 import * as PostFiltering from "./lib/postFiltering.mjs";
 import * as PostOrdering from "./lib/postOrdering.mjs";
 import * as PostPaging from "./lib/postPaging.mjs";
 import * as FooterMenu from "./lib/footerMenu.mjs";
-import * as Markdown from "./lib/markdown.mjs";
 import * as Navigation from "./lib/navigation.mjs";
 import * as Taxonomy from "./lib/taxonomy.mjs";
-export { DateFormatter, UrlFormatter, Posts, Cache, PostQueries, PostFiltering, PostOrdering, PostPaging, FooterMenu, Markdown, Navigation, Taxonomy };
+export { DateFormatter, Markdown, Posts, UrlFormatter, Cache, PostQueries, PostFiltering, PostOrdering, PostPaging, FooterMenu, Navigation, Taxonomy };

package/index.mjs

@@ -1,6 +1,7 @@
 import { DateFormatter } from './lib/v1/dates.mjs';
-import { UrlFormatter } from './lib/v1/urls.mjs';
+import { Markdown } from './lib/v1/markdown.mjs';
 import { Posts } from './lib/v1/posts.mjs';
+import { UrlFormatter } from './lib/v1/urls.mjs';
 
 import * as Cache from './lib/cache.mjs';
 import * as PostQueries from './lib/postQueries.mjs';
@@ -8,21 +9,20 @@ import * as PostFiltering from './lib/postFiltering.mjs';
 import * as PostOrdering from './lib/postOrdering.mjs';
 import * as PostPaging from './lib/postPaging.mjs';
 import * as FooterMenu from './lib/footerMenu.mjs';
-import * as Markdown from './lib/markdown.mjs';
 import * as Navigation from './lib/navigation.mjs';
 import * as Taxonomy from './lib/taxonomy.mjs';
 
 export {
     DateFormatter,
-    UrlFormatter,
+    Markdown,
     Posts,
+    UrlFormatter,
     Cache,
     PostQueries,
     PostFiltering,
     PostOrdering,
     PostPaging,
     FooterMenu,
-    Markdown,
     Navigation,
     Taxonomy
 };

package/lib/v1/markdown.d.mts

@@ -0,0 +1,20 @@
+export class Markdown {
+    /**
+     * Converts markdown to HTML without wrapping in a <p>
+     * @param {string} markdown
+     * @returns {Promise<string>}
+     */
+    getInlineHtmlFrom(markdown: string): Promise<string>;
+    /**
+     * Converts markdown to HTML
+     * @param {string} markdown
+     * @returns {Promise<string>}
+     */
+    getHtmlFrom(markdown: string): Promise<string>;
+    /**
+     * Converts markdown to plain text
+     * @param {string} markdown
+     * @returns {Promise<string>}
+     */
+    getTextFrom(markdown: string): Promise<string>;
+}

package/lib/v1/markdown.mjs

@@ -0,0 +1,47 @@
+import { unified } from 'unified';
+import remarkParse from 'remark-parse';
+import remarkRehype from 'remark-rehype'
+import rehypeStringify from 'rehype-stringify';
+
+export class Markdown {
+    /**
+     * Converts markdown to HTML without wrapping in a <p>
+     * @param {string} markdown 
+     * @returns {Promise<string>}
+     */
+    async getInlineHtmlFrom(markdown) {
+        let html = await this.getHtmlFrom(markdown);
+
+        // There may be a better way to unwrap this... maybe a visitor
+        if (html.substring(0, 3) == '<p>' && html.substring(html.length - 4) == '</p>') {
+            html = html.substring(3, html.length - 4);
+        }
+
+        return html;
+    }
+
+    /**
+     * Converts markdown to HTML
+     * @param {string} markdown 
+     * @returns {Promise<string>}
+     */
+    async getHtmlFrom(markdown) {
+        const vfile = await unified()
+        .use(remarkParse)
+        .use(remarkRehype)
+        .use(rehypeStringify)
+        .process(markdown)
+
+        return String(vfile);
+    }
+
+    /**
+     * Converts markdown to plain text
+     * @param {string} markdown 
+     * @returns {Promise<string>}
+     */
+    async getTextFrom(markdown) {
+        const html = await this.getInlineHtmlFrom(markdown);
+        return html.replace(/<.*?>/g, '');
+    }
+}

package/lib/v1/posts.mjs

@@ -4,6 +4,7 @@ export class Posts {
      * @param {() => MarkdownInstance[]} fetchAll 
      */
     constructor(fetchAll) {
+        /* istanbul ignore next */
         this.fetchAll = fetchAll ?? function() { return import.meta.glob("/src/pages/**/*.md", { eager: true }); }
         this.allPosts = [];
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-accelerator-utils",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "Astro utilities for Astro Accelerator.",
   "main": "index.mjs",
   "type": "module",

package/lib/markdown.d.mts

@@ -1,18 +0,0 @@
-/**
- * Converts markdown to HTML without wrapping in a <p>
- * @param {string} markdown
- * @returns {Promise<string>}
- */
-export function getInlineHtmlFrom(markdown: string): Promise<string>;
-/**
- * Converts markdown to HTML
- * @param {string} markdown
- * @returns {Promise<string>}
- */
-export function getHtmlFrom(markdown: string): Promise<string>;
-/**
- * Converts markdown to plain text
- * @param {string} markdown
- * @returns {Promise<string>}
- */
-export function getTextFrom(markdown: string): Promise<string>;

package/lib/markdown.mjs

@@ -1,45 +0,0 @@
-import { unified } from 'unified';
-import remarkParse from 'remark-parse';
-import remarkRehype from 'remark-rehype'
-import rehypeStringify from 'rehype-stringify';
-
-/**
- * Converts markdown to HTML without wrapping in a <p>
- * @param {string} markdown 
- * @returns {Promise<string>}
- */
-export async function getInlineHtmlFrom(markdown) {
-    let html = await getHtmlFrom(markdown);
-
-    // There may be a better way to unwrap this... maybe a visitor
-    if (html.substring(0, 3) == '<p>' && html.substring(html.length - 4) == '</p>') {
-        html = html.substring(3, html.length - 4);
-    }
-
-    return html;
-}
-
-/**
- * Converts markdown to HTML
- * @param {string} markdown 
- * @returns {Promise<string>}
- */
-export async function getHtmlFrom(markdown) {
-    const vfile = await unified()
-    .use(remarkParse)
-    .use(remarkRehype)
-    .use(rehypeStringify)
-    .process(markdown)
-
-    return String(vfile);
-}
-
-/**
- * Converts markdown to plain text
- * @param {string} markdown 
- * @returns {Promise<string>}
- */
-export async function getTextFrom(markdown) {
-    const html = await getInlineHtmlFrom(markdown);
-    return html.replace(/<.*?>/g, '');
-}