@moonwave99/goffre 0.1.3 → 0.1.5

package/README.md

@@ -15,16 +15,13 @@ npm install @moonwave99/goffre --save
 ```js
 import { load, render } from "@moonwave99/goffre";
 
-(async () => {
+try {
   const { pages } = await load();
-
-  try {
-    const results = await render({ pages });
-    console.log(`Generated ${results.length} pages`);
-  } catch (error) {
-    console.log("Error generating site", error);
-  }
-})();
+  const results = await render({ pages });
+  console.log(`Generated ${results.length} pages`);
+} catch (error) {
+  console.log("Error generating site", error);
+}
 ```
 
 Default paths:

package/dist/index.d.ts

@@ -1,44 +1,6 @@
 import { MarkedExtension, RendererObject } from 'marked';
 import { HelperOptions } from 'handlebars';
 
-type Context = {
-    data: {
-        root: {
-            options?: {
-                domain?: string;
-                env?: {
-                    mode?: string;
-                };
-            };
-        };
-    };
-};
-type HelperContext = Context & Omit<HelperOptions, "fn" | "inverse">;
-type BlockContext = Context & HelperOptions;
-declare const markdown: (text: string) => string | Promise<string>;
-declare const getParamLink: (url: string, options: HelperContext) => string;
-declare const getAsset: (asset: string, context: Omit<HelperContext, "hash">) => string;
-declare const getSitemapLink: (page: Page, context: HelperContext) => string;
-declare const getLink: (page: Page, context: HelperContext) => string;
-declare const getNavClass: ({ slug }: Page, currentPage: Page) => string;
-declare const list: (context: Page[], options: BlockContext) => string;
-declare const nextItem: (context: Page, options: Pick<BlockContext, "hash" | "fn">) => string | undefined;
-declare const prevItem: (context: Page, options: Pick<BlockContext, "hash" | "fn">) => string | undefined;
-
-declare const defaultHelpers_getAsset: typeof getAsset;
-declare const defaultHelpers_getLink: typeof getLink;
-declare const defaultHelpers_getNavClass: typeof getNavClass;
-declare const defaultHelpers_getParamLink: typeof getParamLink;
-declare const defaultHelpers_getSitemapLink: typeof getSitemapLink;
-declare const defaultHelpers_list: typeof list;
-declare const defaultHelpers_markdown: typeof markdown;
-declare const defaultHelpers_nextItem: typeof nextItem;
-declare const defaultHelpers_prevItem: typeof prevItem;
-declare namespace defaultHelpers {
-  export { defaultHelpers_getAsset as getAsset, defaultHelpers_getLink as getLink, defaultHelpers_getNavClass as getNavClass, defaultHelpers_getParamLink as getParamLink, defaultHelpers_getSitemapLink as getSitemapLink, defaultHelpers_list as list, defaultHelpers_markdown as markdown, defaultHelpers_nextItem as nextItem, defaultHelpers_prevItem as prevItem };
-}
-
-declare const helpers: typeof defaultHelpers;
 type Page = {
     slug: string;
     link?: string;
@@ -60,7 +22,7 @@ type LoadParams = {
 declare function load({ dataPath }?: LoadParams): Promise<{
     json: {};
     pages: {
-        excerpt: string | undefined;
+        excerpt: string;
         slug: string;
         description: any;
         content: string;
@@ -68,7 +30,7 @@ declare function load({ dataPath }?: LoadParams): Promise<{
 }>;
 declare function loadJSON(cwd: string): Promise<{}>;
 declare function loadMarkdown(cwd: string): Promise<{
-    excerpt: string | undefined;
+    excerpt: string;
     slug: string;
     description: any;
     content: string;
@@ -119,4 +81,108 @@ type PaginatedResult<T extends Page> = {
 };
 declare function paginate<T extends Page>({ collection, size, sortBy, order, }: PaginateParams<T>): PaginatedResult<T>[];
 
-export { type Page, getSlug, getSorter, getTemplate, helpers, load, loadJSON, loadMarkdown, paginate, render };
+type Context = {
+    data: {
+        root: {
+            options?: {
+                domain?: string;
+                env?: {
+                    mode?: string;
+                };
+            };
+        };
+    };
+};
+type HelperContext = Context & Omit<HelperOptions, "fn" | "inverse">;
+type BlockContext = Context & HelperOptions;
+declare const markdown: (text: string) => string | Promise<string>;
+declare function getExcerpt(content: string): Promise<string>;
+declare const getParamLink: (url: string, options: HelperContext) => string;
+declare const getAsset: (asset: string, context: Omit<HelperContext, "hash">) => string;
+declare const getSitemapLink: (page: Page, context: HelperContext) => string;
+declare const getLink: (page: Page, context: HelperContext) => string;
+declare const getNavClass: ({ slug }: Page, currentPage: Page) => string;
+declare const list: (context: Page[], options: BlockContext) => string;
+declare const nextItem: (context: Page, options: Pick<BlockContext, "hash" | "fn">) => string | undefined;
+declare const prevItem: (context: Page, options: Pick<BlockContext, "hash" | "fn">) => string | undefined;
+
+declare const helpers_getAsset: typeof getAsset;
+declare const helpers_getExcerpt: typeof getExcerpt;
+declare const helpers_getLink: typeof getLink;
+declare const helpers_getNavClass: typeof getNavClass;
+declare const helpers_getParamLink: typeof getParamLink;
+declare const helpers_getSitemapLink: typeof getSitemapLink;
+declare const helpers_list: typeof list;
+declare const helpers_markdown: typeof markdown;
+declare const helpers_nextItem: typeof nextItem;
+declare const helpers_prevItem: typeof prevItem;
+declare namespace helpers {
+  export { helpers_getAsset as getAsset, helpers_getExcerpt as getExcerpt, helpers_getLink as getLink, helpers_getNavClass as getNavClass, helpers_getParamLink as getParamLink, helpers_getSitemapLink as getSitemapLink, helpers_list as list, helpers_markdown as markdown, helpers_nextItem as nextItem, helpers_prevItem as prevItem };
+}
+
+declare function getRandomProjectNames(length: number): string[];
+type WriteOutputParams = {
+    basePath: string;
+    fileName: string;
+    output: string;
+};
+declare function writeOutput({ basePath, fileName, output, }: WriteOutputParams): Promise<void>;
+declare function toMarkdownFile({ content, ...frontMatter }: {
+    content: string;
+    frontMatter: Record<string, unknown>;
+}): string;
+type GeneratePostParams = {
+    index: number;
+    template?: string;
+    slug?: string;
+    withBlocks?: boolean;
+};
+declare function generatePost({ index, template, slug, withBlocks, }: GeneratePostParams): {
+    title: string;
+    template: string;
+    created_at: Date;
+    slug: string;
+    cover: {
+        url: string;
+        caption: string;
+        attribution: {
+            text: string;
+            link: string;
+        };
+    };
+    fileName: string;
+    content: string;
+};
+declare function generateProject({ name, index, }: {
+    name: string;
+    index: number;
+}): {
+    title: string;
+    slug: string;
+    template: string;
+    work_date: Date;
+    homepage: string;
+    demo: string;
+    technologies: string[];
+    cover: {
+        url: string;
+        caption: string;
+        attribution: {
+            text: string;
+            link: string;
+        };
+    };
+    fileName: string;
+    content: string;
+};
+
+declare const generator_generatePost: typeof generatePost;
+declare const generator_generateProject: typeof generateProject;
+declare const generator_getRandomProjectNames: typeof getRandomProjectNames;
+declare const generator_toMarkdownFile: typeof toMarkdownFile;
+declare const generator_writeOutput: typeof writeOutput;
+declare namespace generator {
+  export { generator_generatePost as generatePost, generator_generateProject as generateProject, generator_getRandomProjectNames as getRandomProjectNames, generator_toMarkdownFile as toMarkdownFile, generator_writeOutput as writeOutput };
+}
+
+export { type Page, generator, getSlug, getSorter, getTemplate, helpers, load, loadJSON, loadMarkdown, paginate, render };