Add option to remap paths at the start

Author: anthonyec

src/cli.ts

@@ -17,7 +17,7 @@ const ERROR_CODE = {
 
 function logUsage() {
   stdout.write(`🙅🏻‍♀️ staticbuild - a static site generator that isn't for you!\n\n`)
-  stdout.write(`Usage: staticbuild <inputDirectory> <outputDirectory> [--watch, --dry-run, --check]\n`)
+  stdout.write(`Usage: staticbuild <inputDirectory> <outputDirectory> [arguments]\n`)
 
   stdout.write(`\nArguments:\n`)
   stdout.write(`<inputDirectory>    Path to directory containing content\n`)
@@ -26,6 +26,8 @@ function logUsage() {
   stdout.write(`--dry-run           Prevent writing files to disk, instead logging the file list out\n`)
   stdout.write(`--check, -c         Perform a dead link check on the output files\n`)
   stdout.write(`--verbose, -v       Output all info and warning logs\n`)
+  stdout.write(`--ignore            List of start of paths to ignore\n`)
+  stdout.write(`--remap             Mapping of start of paths that will get renamed, e.g 'projects':'blog' \n`)
 }
 
 async function main() {
@@ -99,6 +101,21 @@ async function main() {
           continue
         }
 
+        case "remap": {
+          const pathRemaps: Record<string, string> = {}
+
+          for (const mapping of arg.value.split(",")) {
+            const [from, to] = mapping.split(":")
+            if (from === undefined || to === undefined) continue
+            if (pathRemaps[from]) continue
+
+            pathRemaps[path.join(options.outputDirectory, from)] = path.join(options.outputDirectory, to)
+          }
+
+          options.pathRemaps = pathRemaps
+          continue
+        }
+
         default: {
           stdout.write(`Error: Unknown argument ${arg.key}\n`)
           return ERROR_CODE.CALLED_WITH_ILLEGAL_PARAMETERS

src/staticbuild.ts

@@ -56,6 +56,7 @@ export interface StaticBuildOptions {
   dryRun?: boolean
   check?: boolean
   ignoredPaths?: string[]
+  pathRemaps?: Record<string, string>
   baseURL?: string
 
   logger?: {
@@ -190,11 +191,20 @@ function getLayouts(inputDirectory: string): Templates {
   return templates
 }
 
+function replaceStart(text: string, searchValue: string, replaceValue: string): string {
+  if (text.startsWith(searchValue)) {
+    return replaceValue + text.slice(searchValue.length)
+  }
+
+  return text
+}
+
 function shouldSkipFilePath(
   relativeFilePath: string,
   ignoredPaths: string[] = [],
 ): [shouldSkip: boolean, reason: string] {
   const filename = path.basename(relativeFilePath)
+  if (filename === "_config.js") return [false, ""]
   if (filename.startsWith("_")) return [true, "underscore_prefix"]
 
   for (const ignoredPath of ignoredPaths || []) {
@@ -912,13 +922,20 @@ export default async function staticbuild(options: StaticBuildOptions) {
 
     options.logger?.time("Write")
 
+    const pathRemaps: Exclude<StaticBuildOptions["pathRemaps"], undefined> = options.pathRemaps || {}
+
     for (const [_, file] of outputFiles) {
       const buffer: Buffer<ArrayBuffer> = isExternalFile(file)
         ? Buffer.from(fs.readFileSync(file.inputPath))
         : file.buffer
 
+      for (const [from, to] of Object.entries(pathRemaps)) {
+        file.outputPath = replaceStart(file.outputPath, from, to)
+      }
+
       if (options.dryRun) {
         options.logger?.info("[fake_file_write]")
+
         if (isExternalFile(file)) {
           options.logger?.info(" in: " + file.inputPath)
         } else {