poops 1.2.0 → 1.2.2

package/README.md

@@ -507,6 +507,7 @@ Then use Tailwind utility classes directly in your markup templates. Tailwind v4
 - `site` (optional) - global data that will be available to all templates in the markup directory. Like site title, description, social media links, etc. You can then use this data in your templates `{{ site.title }}` for instance.
 - `data` (optional) - is an array of JSON or YAML data files, that once loaded will be available to all templates in the markup directory. If you provide a path to a file for instance `links.json` with a `facebook` property, you can then use this data in your templates `{{ links.facebook }}`. The base name of the file will be used as the variable name, with spaces, dashes and dots replaced with underscores. So `the awesome-links.json` will be available as `{{ the_awesome_links.facebook }}` in your templates. The root directory of the data files is `in` directory. So if you have a `data` directory in your `in` directory, you can specify the data files like this `data: ["data/links.json"]`. The same goes for the YAML files.
 - `includePaths` - an array of paths to directories that will be added to the template engine's include paths. Useful if you want to separate template partials and layouts. For instance, if you have a `_includes` directory with a `header.njk` (or `header.liquid`) partial that you want to include in your markup, you can add it to the include paths and then include the templates like this `{% include "header.njk" %}`, without specifying the full path to the partial.
+- `baseURL` (optional) - a base URL prefix to use instead of relative path prefixes. When set, `{{ relativePathPrefix }}` will always resolve to this value (with a trailing slash ensured) instead of being computed relative to each page's depth. Useful when deploying under a subdirectory (e.g. `"/blog"` for `domain.com/blog/`). When not set, relative prefixes (`./`, `../`, etc.) are used, which work for any deployment location including subdirectories and `file://` URLs.
 
 **💡 NOTE:** If, for instance, you are building a simple static onepager for your library, and want to pass a version variable from your `package.json`, Poops automatically reads your `package.json` if it exists in your working directory and sets the global variable `package` to the parsed JSON. So you can use it in your markup files, for example like this: `{{ package.version }}`.
 
@@ -527,7 +528,8 @@ Here is a sample markup configuration using the default Nunjucks engine:
     ],
     "includePaths": [
       "_includes"
-    ]
+    ],
+    "baseURL": "/blog"
   }
 }
 ```

package/lib/markup/collections.js

@@ -182,7 +182,7 @@ export function getCollectionIndexFile(markupInDir, collectionName) {
   return indexFiles[0]
 }
 
-export function generateCollectionPaginationPages(collectionData, markupInDir, markupOutDir, compileEntryFn) {
+export function generateCollectionPaginationPages(collectionData, markupInDir, markupOutDir, compileEntryFn, baseURL) {
   if (!collectionData) return []
 
   const compilePromises = []
@@ -201,7 +201,7 @@ export function generateCollectionPaginationPages(collectionData, markupInDir, m
       const pageUrl = pageNumber === 1 ? collection.name : `${collection.name}/${pageNumber}`
       const nextPage = pageNumber === collection.totalPages ? null : pageNumber + 1
       const nextPageUrl = pageNumber === collection.totalPages ? null : `${collection.name}/${pageNumber + 1}`
-      let prevPage = pageNumber === 1 ? null : pageNumber - 1
+      const prevPage = pageNumber === 1 ? null : pageNumber - 1
       let prevPageUrl = pageNumber === 1 ? null : `${collection.name}/${pageNumber - 1}`
       if (prevPage === 1) {
         prevPageUrl = collection.name
@@ -228,7 +228,7 @@ export function generateCollectionPaginationPages(collectionData, markupInDir, m
       const context = {
         ...collectionData,
         [collectionName]: pageSnapshot,
-        relativePathPrefix: getRelativePathPrefix(markupOutDirFull, fromPath),
+        relativePathPrefix: getRelativePathPrefix(markupOutDirFull, fromPath, baseURL),
         _url: getPageUrl(markupOut)
       }
 

package/lib/markup/helpers.js

@@ -148,7 +148,11 @@ export function getUpDirPrefix(relativeDir) {
   return upDir
 }
 
-export function getRelativePathPrefix(outputDir, fromDir) {
+export function getRelativePathPrefix(outputDir, fromDir, baseURL) {
+  if (baseURL != null) {
+    return baseURL.endsWith('/') ? baseURL : baseURL + '/'
+  }
+
   let relativeDir = path.relative(process.cwd(), outputDir)
   const fromRelativeDir = fromDir ? path.relative(process.cwd(), fromDir) : ''
 
@@ -156,7 +160,7 @@ export function getRelativePathPrefix(outputDir, fromDir) {
     relativeDir = relativeDir.replace(fromRelativeDir, '')
   }
 
-  return getUpDirPrefix(relativeDir)
+  return getUpDirPrefix(relativeDir) || './'
 }
 
 export function getPageUrl(outputPath) {

package/lib/markups.js

@@ -35,6 +35,7 @@ export default class Markups {
     this.includePaths = moduleConfig.includePaths || moduleConfig.options.includePaths || []
     this.searchIndexConfig = moduleConfig.options.searchIndex || moduleConfig.searchIndex
     this.sitemapConfig = moduleConfig.options.sitemap || moduleConfig.sitemap
+    this.baseURL = moduleConfig.baseURL || moduleConfig.options.baseURL || null
     this.dataFiles = []
 
     // Instantiate engine
@@ -196,7 +197,7 @@ export default class Markups {
 
       const fileContext = {
         ...collectionData,
-        relativePathPrefix: getRelativePathPrefix(markupOutDir, fromPath),
+        relativePathPrefix: getRelativePathPrefix(markupOutDir, fromPath, this.baseURL),
         _url: getPageUrl(markupOut)
       }
 
@@ -254,7 +255,7 @@ export default class Markups {
 
     const fileContext = {
       ...collectionData,
-      relativePathPrefix: getRelativePathPrefix(markupOutDir),
+      relativePathPrefix: getRelativePathPrefix(markupOutDir, null, this.baseURL),
       _url: getPageUrl(markupOut)
     }
 
@@ -321,7 +322,7 @@ export default class Markups {
     const pageEntries = shouldIndex ? [] : null
 
     buildCollectionPaginationData(collectionData)
-    const collectionPromises = generateCollectionPaginationPages(collectionData, this.markupIn, this.markupOut, this.compileEntry.bind(this))
+    const collectionPromises = generateCollectionPaginationPages(collectionData, this.markupIn, this.markupOut, this.compileEntry.bind(this), this.baseURL)
 
     await Promise.all(collectionPromises)
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "poops",
   "description": "Straightforward, no-bullshit bundler for the web.",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "license": "MIT",
   "type": "module",
   "main": "poops.js",

package/poops.js

@@ -206,11 +206,22 @@ async function startServer() {
   await poops() // Initial compilation before starting the server
   const app = connect()
 
-  if (config.serve.base && pathExists(cwd, config.serve.base)) {
-    app.use(serveStatic(path.join(cwd, config.serve.base)))
-  } else {
-    app.use(serveStatic(cwd))
-  }
+  const base = config.serve.base && pathExists(cwd, config.serve.base)
+    ? path.join(cwd, config.serve.base)
+    : cwd
+
+  app.use(serveStatic(base))
+
+  // Serve 404.html for unmatched routes
+  const notFoundPage = path.join(base, '404.html')
+  app.use((req, res) => {
+    res.statusCode = 404
+    if (pathExists(notFoundPage)) {
+      fs.createReadStream(notFoundPage).pipe(res)
+    } else {
+      res.end('Not Found')
+    }
+  })
 
   let port = overridePort || config.serve.port || 4040
   if (!overridePort) port = await getAvailablePort(port, port + 10)