poops 1.0.18 → 1.0.20

package/README.md

@@ -41,6 +41,9 @@ It uses a simple config file where you define your input and output paths and it
 * Live reloads on file changes (optional)
 
 ## Quick Start
+
+> For a superfast start, you can use the Poops template repository: [💩🌪️Shitstorm](https://github.com/stamat/shitstorm)
+
 You can install Poops globally:
 
 ```bash
@@ -117,6 +120,12 @@ Just create a `poops.json` file in the root of your project and add the followin
       ]
     }
   },
+    "copy": [
+    {
+      "in": "example/src/static",
+      "out": "example/dist"
+    }
+  ],
   "banner": "/* {{ name }} v{{ version }} | {{ homepage }} | {{ license }} License */",
   "serve" : {
     "port": 4040,
@@ -235,9 +244,9 @@ Poops can generate static pages for you. This feature is still under development
 * `out` - the output path, can be only a directory path (for now)
 * `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` (WIP 🚧) - an array of paths to directories that will be added to the nunjucks include paths. Useful if you want to separate template partials and layouts. For instance, if you have a `_includes` directory with a `header.njk` 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. This will change in the future, to provide better ignore and include patterns for the markup directories.
+* `includePaths` - an array of paths to directories that will be added to the nunjucks include paths. Useful if you want to separate template partials and layouts. For instance, if you have a `_includes` directory with a `header.njk` 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. This will change in the future, to provide better ignore and include patterns for the markup directories.
 
-**💡 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 golobal variable `package` to the parsed JSON. So you can use it in your markup files, for example like this: `{{ package.version }}`.
+**💡 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 }}`.
 
 
 Here is a sample markup configuration:
@@ -270,6 +279,66 @@ If your project doesn't have markups, you can remove the `markups` property from
 
 * `slugify` - slugifies a string. Usage: `{{ "My Awesome Title" | slugify }}` will output `my-awesome-title`
 
+### Copy
+
+Configuration entry to copy files or directories - copy your static files like images and fonts, for instance, from `src` to `dist` directory. This feature was added to enable moving static files if you deploy GitHub pages via a GitHub action. If you don't want to use this feature, simply exclude the `copy` property from your config file.
+
+Here is a sample copy configuration which will copy the `static` directory and it's contents to the  `dist` directory:
+
+```JSON
+{
+  "copy": {
+    "in": "src/static",
+    "out": "dist"
+  }
+}
+```
+
+You can specify a list of input paths and pass them to an output directory, for instance:
+
+```JSON
+{
+  "copy": {
+    "in": ["src/static/ogimage.jpg", "src/static/favicon.ico", "src/fonts"],
+    "out": "dist"
+  }
+}
+```
+
+**💡 NOTE:** Copy property can also accept the list of objects containing `in` and `out` properties. For instance:
+
+```JSON
+{
+  "copy": [
+    {
+      "in": ["src/static/ogimage.jpg", "src/static/favicon.ico", "src/fonts"],
+      "out": "dist"
+    },
+    {
+      "in": "images",
+      "out": "dist/static"
+    }
+  ]
+}
+```
+
+**💡 NOTE:** Copy can also accept some basic **GLOB** as input paths. Does NOT support **EXTGLOB** yet. Don't expect too much of it, but for instance these paths will work:
+
+```JSON
+{
+  "copy": {
+    "in": [
+      "images/**/awesome.{jpeg,jpg,png}",
+      "notes/info[0-9].txt",
+      "notes/doc?.txt",
+      "notes/memo*.txt",
+      "notes/log[!123a].txt",
+    ],
+    "out": "dist"
+  }
+}
+```
+
 ### Banner (optional)
 
 Here you can specify a banner that will be added to the top of the output files. It is templatable via mustache. The following variables are available from your project's `package.json`:

package/lib/copy.js

@@ -0,0 +1,121 @@
+const { globSync, hasMagic } = require('glob')
+const helpers = require('./utils/helpers.js')
+const fs = require('node:fs')
+const path = require('node:path')
+const PrintStyle = require('./utils/print-style.js')
+
+const {
+  pathExists,
+  pathIsDirectory,
+  mkDir,
+  copyDirectory,
+  buildTime
+} = helpers
+
+const pstyle = new PrintStyle()
+
+module.exports = class Copy {
+  constructor(config) {
+    this.config = config
+  }
+
+  async execute() {
+    if (!this.config.copy) return
+    const copyStartTime = performance.now()
+    this.config.copy = Array.isArray(this.config.copy) ? this.config.copy : [this.config.copy]
+    let copyLastPath = ''
+    let copyPathCount = 0
+
+    for (const copyEntry of this.config.copy) {
+      if (!copyEntry.in || !copyEntry.out) {
+        console.log(`${pstyle.redBright + pstyle.bold}[error]${pstyle.reset}[copy] ${pstyle.dim}Cannot copy. Missing 'in' or 'out' property in copy entry:${pstyle.reset} ${JSON.stringify(copyEntry)}`)
+        continue
+      }
+
+      const outPath = path.resolve(process.cwd(), copyEntry.out)
+      const inEntries = Array.isArray(copyEntry.in) ? copyEntry.in : [copyEntry.in]
+
+      for (const inEntry of inEntries) {
+        const hasGlobMagic = typeof hasMagic === 'function'
+          ? hasMagic(inEntry)
+          : ['*', '?', '[', ']', '{', '}', '(', ')', '!'].some((ch) => inEntry.includes(ch))
+        let matches = []
+        try {
+          if (typeof globSync === 'function') {
+            matches = globSync(inEntry, { dot: true, nodir: false })
+          }
+        } catch (err) {
+          matches = []
+        }
+
+        if (matches.length > 0) {
+          for (const matchedPath of matches) {
+            if (pathExists(matchedPath)) {
+              await this.copyEntry(matchedPath, outPath)
+              copyLastPath = inEntry
+              copyPathCount++
+            } else {
+              console.log(`${pstyle.redBright + pstyle.bold}[error]${pstyle.reset}[copy] ${pstyle.dim}Cannot copy. Source path does not exist:${pstyle.reset} ${matchedPath}`)
+            }
+          }
+          continue
+        }
+
+        if (pathExists(inEntry)) {
+          await this.copyEntry(inEntry, outPath)
+          copyLastPath = inEntry
+          copyPathCount++
+        } else {
+          if (hasGlobMagic) {
+            console.log(`${pstyle.redBright + pstyle.bold}[error]${pstyle.reset}[copy] ${pstyle.dim}No files matched glob pattern:${pstyle.reset} ${inEntry}`)
+          } else {
+            console.log(`${pstyle.redBright + pstyle.bold}[error]${pstyle.reset}[copy] ${pstyle.dim}Cannot copy. Source path does not exist:${pstyle.reset} ${inEntry}`)
+          }
+        }
+      }
+    }
+
+    const copyEndTime = performance.now()
+    if (copyPathCount === 0) return
+    if (copyPathCount === 1) {
+      console.log(`${pstyle.green + pstyle.bold}[copy]${pstyle.reset} ${pstyle.dim}Copied${pstyle.reset} ${pstyle.italic + pstyle.underline}${copyLastPath}${pstyle.reset} ${pstyle.green}(${buildTime(copyStartTime, copyEndTime)})${pstyle.reset}`)
+      return
+    }
+
+    console.log(`${pstyle.green + pstyle.bold}[copy]${pstyle.reset} ${pstyle.dim}Copied${pstyle.reset} ${copyPathCount} paths ${pstyle.green}(${buildTime(copyStartTime, copyEndTime)})${pstyle.reset}`)
+  }
+
+  async unlink(file, copyPaths) {
+    if (!file || !copyPaths) return
+    if (!copyPaths.out || !copyPaths.in) return
+    if (!pathExists(copyPaths.out) || !pathExists(copyPaths.in)) return
+
+    if (pathIsDirectory(copyPaths.in)) {
+      const inBaseName = path.basename(copyPaths.in)
+      copyPaths.out = path.join(copyPaths.out, inBaseName)
+    }
+
+    file = file.replace(copyPaths.in, copyPaths.out)
+
+    const outputFilePath = path.join(process.cwd(), file)
+
+    if (pathExists(outputFilePath)) {
+      if (pathIsDirectory(outputFilePath)) {
+        fs.rmdirSync(outputFilePath, { recursive: true })
+        return
+      }
+      fs.unlinkSync(outputFilePath)
+    }
+  }
+
+  async copyEntry(inFilePath, outFilePath) {
+    const baseName = path.basename(inFilePath)
+    let outPath = outFilePath
+    mkDir(outFilePath)
+
+    if (pathIsDirectory(outFilePath)) {
+      outPath = path.join(outFilePath, baseName)
+    }
+    copyDirectory(inFilePath, outPath)
+  }
+}