votive 0.2.1 → 0.3.0

package/README.md

@@ -1,18 +1,11 @@
 # Votive
 
-*File processor*
-
-- Powers [Voot](https://github.com/samlfair/voot)
-- Bundles [Vowel](https://github.com/samlfair/vowel)
-
 ## Roadmap
 
+- [ ] ReadPaths
 - [ ] Flesh out job runners
-- [ ] Rename jobs and paths
-- [ ] Better dependency tracking
-- [ ] Better query filters
-- [x] File deletion handling
+- [ ] Destination query filters
 
-## Project: Jobs
+## Helpers
 
-Jobs was originally a generic concept, but after working it's clear that there are two main categories of jobs: async writes and data fetching. We can probably handle async writes with inbuilt logic. So, instead of a "job", we should have "read uri"? That way we can cache all the uris.
+- Read

package/lib/bundle.js

@@ -5,8 +5,6 @@ import readSources from "./readSources.js"
 import runJobs from "./runJobs.js"
 import writeDestinations from "./writeDestinations.js"
 import { default as createDatabase } from "./createDatabase.js"
-import { stopwatch } from "./utils/index.js"
-import { styleText } from "node:util"
 
 /** @import {Database} from "./createDatabase.js" */
 
@@ -19,40 +17,17 @@ import { styleText } from "node:util"
  */
 
 /**
- * @typedef {object} VotiveProcessorCommon
- * @property {string[]} extensions
- * @property {ReadResource} [readResource]
- * @property {ProcessorWrite} [writeFile]
- * @property {ReadFolder} [readFolder]
- * @property {ReadAbstract} [transformFile]
- */
-
-/**
- * @typedef {VotiveProcessorCommon & {
- *  format: "buffer",
- *  readFile: ReadPath | undefined
- * }} VotiveProcessorBuffer
- */
-
-/**
- * @typedef {VotiveProcessorCommon & {
- *  format: "text",
- *  readFile: ReadText | undefined
- * }} VotiveProcessorText
- */
-
-/**
- * @typedef {VotiveProcessorBuffer | VotiveProcessorText} VotiveProcessor
- */
-
-/**
- * @typedef {object} ReadResource
+ * @typedef {object} VotiveProcessor
+ * @property {ProcessorFilter} [filter]
+ * @property {ProcessorSyntax} syntax
+ * @property {ProcessorRead} [read]
+ * @property {ProcessorWrite} [write]
  */
 
 /**
  * Filter for files that the processor will read from.
  * @typedef {object} ProcessorFilter
- * @property {string} extensions
+ * @property {string[]} extensions
  */
 
 /**
@@ -81,7 +56,6 @@ import { styleText } from "node:util"
  * @callback ReadText
  * @param {string} text
  * @param {string} filePath
- * @param {string} destinationPath
  * @param {Database} database
  * @param {VotiveConfig} config
  * @returns {ReadTextResult | undefined}
@@ -129,11 +103,11 @@ import { styleText } from "node:util"
  * @param {object} Folder
  * @param {Database} database
  * @param {VotiveConfig} config
- * @returns {{ jobs?: Jobs, targets?: Target[] }}
+ * @returns {{ jobs?: Jobs, destinations?: Destination[] }}
  */
 
 /**
- * @typedef {object} Target
+ * @typedef {object} Destination
  * @property {string} path
  * @property {object} metadata
  * @property {Abstract} abstract
@@ -170,14 +144,10 @@ import { styleText } from "node:util"
  * @property {string} [plugin]
  */
 
-/**
- * @typedef {(Pick<path.ParsedPath, "root" | "base" | "ext" | "name") & { dir: string[] | string }} RouteInfo
- */
-
 /**
  * @callback Router
- * @param {RouteInfo} path
- * @returns {Partial<RouteInfo> | path.ParsedPath | false}
+ * @param {string} path
+ * @returns {string | false | undefined}
  */
 
 /**
@@ -185,7 +155,6 @@ import { styleText } from "node:util"
  * @property {string} sourceFolder
  * @property {string} destinationFolder
  * @property {VotivePlugin[]} plugins
- * @property {boolean} verbose
  */
 
 /**
@@ -208,6 +177,7 @@ async function bundle(config, cache) {
   const processors = config.plugins
     && config.plugins.flatMap(plugin => plugin.processors && plugin.processors.map(processor => ({ plugin, processor })))
 
+  // Create database
   const database = cache || createDatabase(path.join(config.sourceFolder, ".votive.db"))
 
   /*
@@ -221,94 +191,32 @@ async function bundle(config, cache) {
     even out.
   */
 
-  // database.begin()
-
-  const sourceTime = stopwatch("build", "read sources in", config.verbose)
   // Read folders and source files
   const { folders, sources } = await readSources(config, database, processors)
 
-  sourceTime()
-
-  if(config.verbose) console.info(`${styleText("dim", "build:")} ${styleText("magenta", `found ${sources.length} stale files`)}`)
-
-  if (sources.length) {
-    // Map out jobs from source files
-    const sourcesJobs = sources.flatMap(source => source.jobs) || []
+  // Map out jobs from source files
+  const sourcesJobs = sources.flatMap(source => source.jobs) || []
 
-    // Process source file abstracts and map jobs
-    const { abstractsJobs } = readAbstracts(sources, config, database, processors)
+  // Process source file abstracts and map jobs
+  const { abstractsJobs } = readAbstracts(sources, config, database, processors)
 
-    // Scan folders and map out jobs
-    const foldersJobs = readFolders(folders, config, database, processors) || []
+  // Scan folders and map out jobs
+  const foldersJobs = readFolders(folders, config, database, processors) || []
 
-    const writeTime = stopwatch("build", "wrote files in", config.verbose)
-    // Write destination files
-    await writeDestinations(config, database)
+  // Write destination files
+  await writeDestinations(config, database)
 
-    writeTime()
-
-    // database.commit()
-
-    await database.saveDB(sources)
-  }
   // Run all jobs
-  // await runJobs([
-  //   ...sourcesJobs,
-  //   ...abstractsJobs,
-  //   ...foldersJobs
-  // ], config, database)
+  await runJobs([
+    ...sourcesJobs,
+    ...abstractsJobs,
+    ...foldersJobs
+  ], config, database)
 
   // Back up database (only if in-memory first run)
+  await database.saveDB()
 
   return database
 }
 
-/**
- * @param {VotiveConfig} config
- */
-async function bundler(config) {
-  let queue = []
-  let cache
-
-  async function step() {
-    if (queue.length === 0) {
-      if(config.verbose) console.info(`${styleText("dim", "build:")} ${styleText("magenta", "starting build")}`)
-      /*
-        If queue is empty, bundle.
-      */
-      if (!cache) {
-        queue.push(bundle(config))
-        cache = await queue[0]
-      } else {
-        "cache"
-        queue.push(bundle(config, cache))
-        await queue[0]
-      }
-      queue.shift()
-      return cache
-    } else if (queue.length === 1) {
-      /*
-        If currently bundling, prepare another
-        bundle as cleanup.
-      */
-      if(config.verbose) console.info(`${styleText("dim", "build:")} ${styleText("magenta", "queueing build")}`)
-
-      let bundling
-      queue.push(bundling)
-      bundling = await bundle(config, cache)
-      queue.shift()
-      return cache
-    } else {
-      /*
-        If cleanup is already queued, do nothing.
-      */
-      if(config.verbose) console.info(`${styleText("dim", "build:")} ${styleText("magenta", "already queued")}`)
-      await Promise.all(queue)
-      return cache
-    }
-  }
-
-  return step
-}
-
-export default bundler
+export default bundle

package/lib/cleanDeletions.js

@@ -0,0 +1,32 @@
+import { readdir, rm } from "node:fs/promises"
+import path from "node:path"
+
+/** @import {Abstract, Abstracts, VotiveConfig} from "./bundle.js" */
+/** @import {Database} from "./createDatabase.js" */
+
+
+/**
+ * @param {VotiveConfig} config
+ * @param {Database} database
+ */
+async function cleanDeletions(config, database) {
+  // Must remove from sources first??
+  const dirents = new Set((await readdir(config.destinationFolder, {
+    recursive: true,
+    withFileTypes: true
+  })).map(d => d.isFile() && path.relative(config.destinationFolder, path.join(d.parentPath, d.name)))
+    .filter(a => a)
+  )
+
+  const targets = new Set(database.target.getAll().map(t => t.path))
+
+  const deletions = dirents.difference(targets)
+
+  deletions.forEach(async deletion => {
+    const deletionPath = path.join(config.destinationFolder, deletion)
+    await rm(deletionPath)
+  })
+
+}
+
+export default cleanDeletions