npm - @daz4126/swifty - Versions diffs - 1.8.1 → 1.10.0 - Mend

@daz4126/swifty 1.8.1 → 1.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/README.md CHANGED Viewed

@@ -17,4 +17,4 @@ It also uses convention over configuration to make is super simple to build site
 5. Change the `sitename` in `config.yaml`
 6. Add some markdown files to the 'pages' directory
 7. `npx swifty start` to rebuild and start the server
-8. Visit [http://localhost:3000] to see your site
+8. Visit [http://localhost:3000](http://localhost:3000) to see your site

package/init.js CHANGED Viewed

@@ -17,7 +17,18 @@ const structure = {
   "css/": null,
   "js/": null,
   "images/": null,
-  "config.yaml": "sitename: My Swifty Site",
+  "config.yaml": `sitename: Swifty
+breadcrumb_separator: "&raquo;"
+breadcrumb_class: swifty_breadcrumb
+link_class: swifty_link
+tag_class: tag
+max_image_size: 800
+dateFormat:
+  weekday: short
+  month: short
+  day: numeric
+  year: numeric`,
   "template.html": `<!DOCTYPE html>
 <html lang="en">
 <head>

package/package.json CHANGED Viewed

@@ -1,18 +1,27 @@
 {
   "name": "@daz4126/swifty",
-  "version": "1.8.1",
+  "version": "1.10.0",
   "main": "index.js",
   "type": "module",
   "bin": {
     "swifty": "./cli.js"
   },
+  "files": [
+    "swifty.js",
+    "cli.js",
+    "init.js"
+  ],
   "scripts": {
     "test": "mocha",
     "build": "node swifty.js",
     "start": "node swifty.js && serve dist",
     "init": "node init.js"
   },
-  "keywords": [],
+  "keywords": [
+    "static",
+    "site",
+    "generator"
+  ],
   "author": "DAZ",
   "license": "MIT",
   "description": "Super Speedy Static Site Generator",
@@ -27,7 +36,6 @@
     "sharp": "^0.33.5"
   },
   "devDependencies": {
-    "jest": "^29.7.0",
     "mocha": "^11.1.0"
   },
   "directories": {

package/swifty.js CHANGED Viewed

@@ -232,7 +232,7 @@ const generatePages = async (sourceDir, baseDir = sourceDir, parent) => {
       const name = root ? "Home" : capitalize(file.name.replace(/\.md$/, "").replace(/-/g, " "));
       const stats = await fs.stat(filePath);
       const isDirectory = file.isDirectory();
-      const assetPath = parent ? parent.filename : "pages";
+      const assetPath = parent ? parent.filename : "layout";
       const layoutFileExists = await fsExtra.pathExists(dirs.layouts + "/" + assetPath + ".html");
       const layout = !root && layoutFileExists && assetPath;
@@ -327,12 +327,12 @@ const generatePages = async (sourceDir, baseDir = sourceDir, parent) => {
 const generateLinkList = async (name,pages) => {
   const partial = `${name}.md`;
   const partialPath = path.join(dirs.partials, partial);
-  const pagesPath = path.join(dirs.partials, "pages.md");
+  const linksPath = path.join(dirs.partials, "links.md");
   // Check if either file exists in the 'partials' folder
   const fileExists = await fsExtra.pathExists(partialPath);
-  const defaultExists = await fsExtra.pathExists(pagesPath);
+  const defaultExists = await fsExtra.pathExists(linksPath);
   if (fileExists || defaultExists) {
-    const partial = await fs.readFile(fileExists ? partialPath : pagesPath, "utf-8");
+    const partial = await fs.readFile(fileExists ? partialPath : linksPath, "utf-8");
     const content = await Promise.all(pages.map(page => replacePlaceholders(partial, page)));
     return content.join('\n');
   } else {
@@ -343,7 +343,9 @@ const generateLinkList = async (name,pages) => {
 const render = async page => {
   const replacedContent = await replacePlaceholders(page.content, page);
   const htmlContent = marked.parse(replacedContent); // Markdown processed once
-  const turboHTML = htmlContent.replace(
+  const wrappedContent = await applyLayoutAndWrapContent(page, htmlContent);
+  const turboHTML = wrappedContent.replace(
     /<a\s+([^>]*?)href="(\/[^"#?]+?)"(.*?)>/g,
     (match, beforeHref, href, afterHref) => {
       // Don't double-add .html
@@ -352,9 +354,7 @@ const render = async page => {
       return `<a ${beforeHref}href="${fullHref}" data-turbo-frame="content" data-turbo-action="advance"${afterHref}>`;
     }
   );
-  const wrappedContent = await applyLayoutAndWrapContent(page, turboHTML);
-  return wrappedContent;
+  return turboHTML;
 };
 // Function to read and render the index template

package/serve.json DELETED Viewed

@@ -1,5 +0,0 @@
-{
-  "rewrites": [
-    { "source": "/**.html", "destination": "/**" }
-  ]
-}

package/test/swifty.test.js DELETED Viewed

@@ -1,78 +0,0 @@
-import assert from "assert";
-import fs from "fs/promises";
-import fsExtra from "fs-extra";
-import path from "path";
-import "../swifty.js";
-// Helper function to ensure directories exist and copy assets
-async function ensureDirectoriesAndCopyAssets(sourceDir, targetDir) {
-  // Ensure the target directory exists
-  await fsExtra.ensureDir(targetDir);
-  // Copy assets from source to target
-  await copyAssets(sourceDir, targetDir);
-}
-// Function to render a page with layout and dynamic content
-async function renderPageWithLayout(pagePath, layoutPath) {
-  // Read the content of the page and layout
-  const pageContent = await fs.readFile(pagePath, "utf-8");
-  const layoutContent = await fs.readFile(layoutPath, "utf-8");
-  // Apply the layout and wrap content
-  const wrappedContent = await applyLayoutAndWrapContent(pageContent, layoutContent);
-  // Render the final output
-  return await render(wrappedContent);
-}
-// Generate a page and write it to the output directory
-async function generateAndWritePage(pageData, outputDir) {
-  const pagePath = path.join(outputDir, `${pageData.title}.html`);
-  // Generate the page content
-  const pageContent = await generatePages(pageData);
-  // Write the generated content to the page file
-  await fs.writeFile(pagePath, pageContent);
-  console.log(`Page generated at: ${pagePath}`);
-}
-// Function to ensure and copy necessary files, then render and generate the pages
-async function prepareAndGeneratePages(sourceDir, targetDir, pagesData) {
-  // Ensure directories and copy assets
-  await ensureDirectoriesAndCopyAssets(sourceDir, targetDir);
-  // Loop through the pagesData and generate pages
-  for (const pageData of pagesData) {
-    const outputPagePath = path.join(targetDir, `${pageData.title}.html`);
-    // Ensure the target page directory exists
-    await fsExtra.ensureDir(path.dirname(outputPagePath));
-    // Generate and write the page
-    await generateAndWritePage(pageData, targetDir);
-  }
-}
-// Example function to demonstrate usage
-async function main() {
-  const sourceDir = "./pages"; // Directory where source markdown or assets are located
-  const targetDir = "./dist";  // Output directory for generated pages
-  const pagesData = [
-    { title: "home", content: "Welcome to our homepage" },
-    { title: "about", content: "Learn more about us" },
-  ];
-  try {
-    // Ensure and generate pages
-    await prepareAndGeneratePages(sourceDir, targetDir, pagesData);
-    console.log("Pages successfully generated!");
-  } catch (error) {
-    console.error("Error generating pages:", error);
-  }
-}
-// Run the main function
-main();