blazed-past-us 0.4.1 → 0.4.2

package/README.md

@@ -33,6 +33,10 @@ _"Very well… let the cosmos bear witness."_
 - Post tags are written in every post on the very top as `tag1, tag2,...`
 - The descriptions of the posts will be a brief showcase of the first paragraph (below the tags).
 
+## Useful notes
+
+- Append `/#/?tags=` to the base URL to filter home page posts by tag.
+
 ## Installation
 
 ### Set up scaffold:

package/dist/engine/getters.d.ts

@@ -1,5 +1,5 @@
 import type { PostMetaData, Config, PostDataType } from '../types';
-declare function getPostData(postsMetaData: PostMetaData[], slug: string, option: PostDataType): string | Date | undefined;
+declare function getPostData(postsMetaData: PostMetaData[], slug: string, option: PostDataType): string | string[] | Date | undefined;
 declare function getAllPostsHTML(postsMetaData: PostMetaData[], baseURL: string): Promise<{
     slug: string;
     html: string | void;

package/dist/engine/utils.d.ts

@@ -1,8 +1,10 @@
-import { MsgColor } from '../types';
+import { MsgColor, PostMetaData } from '../types';
 declare function postExists(postsMetaData: any[], slug: string): boolean;
+declare function getPathnameFromLocationHash(locationHash: string): string;
 declare function beautifyDate(d: Date | undefined): undefined | string;
 declare function inject(root: HTMLElement, html: string): void;
 declare function log(msg: string, color: MsgColor): void;
 declare function boltRotator(document: HTMLDocument, elementID: string): void;
 declare function setTitle(document: HTMLDocument, elementID: string, packageName: string): void;
-export { postExists, beautifyDate, inject, log, boltRotator, setTitle };
+declare function filterByUrlQueryIsPresent(postsMetaData: PostMetaData[], tags: string[]): PostMetaData[];
+export { postExists, beautifyDate, inject, log, boltRotator, setTitle, getPathnameFromLocationHash, filterByUrlQueryIsPresent, };

package/dist/engine/utils.js

@@ -3,6 +3,9 @@ import pkg from '../../package.json' with { type: 'json' };
 function postExists(postsMetaData, slug) {
     return postsMetaData.some((post) => post.slug === slug);
 }
+function getPathnameFromLocationHash(locationHash) {
+    return locationHash.split('/').splice(1).join('/');
+}
 function beautifyDate(d) {
     if (!d)
         return;
@@ -45,4 +48,7 @@ function setTitle(document, elementID, packageName) {
         el.innerText = packageName.replaceAll('-', ' ');
     }
 }
-export { postExists, beautifyDate, inject, log, boltRotator, setTitle };
+function filterByUrlQueryIsPresent(postsMetaData, tags) {
+    return postsMetaData.filter((post) => tags ? tags.some((tag) => post.tags.includes(tag)) : true);
+}
+export { postExists, beautifyDate, inject, log, boltRotator, setTitle, getPathnameFromLocationHash, filterByUrlQueryIsPresent, };

package/dist/template/src/router.js

@@ -1,5 +1,4 @@
-import { render } from 'blazed-past-us';
-import { postExists } from 'blazed-past-us';
+import { render, postExists, getPathnameFromLocationHash } from 'blazed-past-us';
 import home from './views/home';
 import post from './views/post';
 import notFound from './views/notFound';
@@ -19,7 +18,7 @@ export default function initRouter(root, postsMetaData) {
  */
 async function handleRoute(root, postsMetaData) {
   const hashRoute = window.location.hash;
-  const pathname = getPathname(hashRoute);
+  const pathname = getPathnameFromLocationHash(hashRoute);
   const queryString = hashRoute.split('?')[1] || '';
   const urlParams = new URLSearchParams(queryString);
   const views = { home, post, notFound };
@@ -36,8 +35,3 @@ async function handleRoute(root, postsMetaData) {
 
   render('404', root, views, postsMetaData);
 }
-
-// Removes "#/" from the location hash.
-function getPathname(locationHash) {
-  return locationHash.split('/').splice(1).join('/');
-}

package/dist/template/src/views/home.js

@@ -1,11 +1,11 @@
 import { postsMetaData } from '../main';
-import { beautifyDate } from 'blazed-past-us';
+import { beautifyDate, filterByUrlQueryIfPresent } from 'blazed-past-us';
 
 export default function home(tags) {
   const baseURL = import.meta.env.BASE_URL;
+  const postsToShow = filterByUrlQueryIfPresent(postsMetaData, tags);
 
-  const postsHtmlArray = postsMetaData
-    .filter((post) => (tags ? tags.some((tag) => post.tags.includes(tag)) : true))
+  return postsToShow
     .map(
       (post) => `
       <a href="${baseURL}#/${post.slug}">
@@ -16,7 +16,6 @@ export default function home(tags) {
         </div>
       </a>
     `
-    );
-
-  return postsHtmlArray.join('');
+    )
+    .join('');
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blazed-past-us",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "A static blog framework made for developers that allows content to be written in Markdown directly from the IDE.",
   "license": "MIT",
   "author": "gass-git",