support an assets dir

Author: bradcypert

adr/00001-Support-an-assets-folder.md

@@ -0,0 +1,23 @@
+# 00001 - Support an assets folder
+
+## Abstract
+
+Adding an assets folder to the `adr` directory would help organize assets, but we don't 
+want those to be included in the auto-incrementation of the ADRs or be included in the README.
+
+## Context and Problem Statement
+
+A lot of ADRs have assets associated with them and users need a place to store those assets, ideally alongside the ADRs.
+
+## Considered Options
+
+- Store the assets in the same `adr` directory.
+- Store the assets in a subdirectory
+- Store the assets in a dot-subdirectory.
+
+## Decision Outcome
+
+Store the assets in a subdirectory
+
+<!-- Add additional information here, comparison of options, research, etc -->
+  

adr/README.md

@@ -9,7 +9,7 @@ If you need to regenerate this readme without creating a new ADR, please use `ad
 
 ## Contents 
 
-- [README](./README.md)
+- [00001-Support-an-assets-folder](./00001-Support-an-assets-folder.md)
 - [00000-Use-Deno](./00000-Use-Deno.md)
 
-Last generated 2024-11-16T17:08:26.792Z
+Last generated 2024-11-20T23:37:05.656Z

main.ts

@@ -1,14 +1,18 @@
 import * as path from "jsr:@std/path";
 
-async function getAllFilesInDir(path: string) {
-  const files = [];
+async function ensureDirExists(path: string) {
   try {
     await Deno.lstat(path);
   } catch (error) {
     if (error && error instanceof Deno.errors.NotFound) {
       await Deno.mkdir(path);
     }
   }
+}
+
+async function getAllFilesInDir(path: string) {
+  const files = [];
+  await ensureDirExists(path);
   const walker = Deno.readDir(path);
   for await (const f of walker) {
     files.push(f);
@@ -17,6 +21,10 @@ async function getAllFilesInDir(path: string) {
   return files;
 }
 
+async function ensureAssetsDirExists(adrdir: string) {
+  await ensureDirExists(path.join(adrdir, "assets"));
+}
+
 async function makeNewADR(
   adrdir: string,
   n: number,
@@ -48,10 +56,7 @@ async function makeNewADR(
 
 async function rebuildReadme(adrDirPath: string, files: Array<Deno.DirEntry>) {
   files.sort((a, b) => {
-    if (a.name.startsWith("README")) {
-      return -9999999;
-    }
-    return parseInt(a.name.substring(0, 6)) - parseInt(b.name.substring(0, 6));
+    return parseInt(a.name.substring(0, 5)) - parseInt(b.name.substring(0, 5));
   });
   await Deno.writeTextFile(
     path.join(adrDirPath, "README.md"),
@@ -67,7 +72,7 @@ If you need to regenerate this readme without creating a new ADR, please use \`a
 ## Contents 
 
 ${
-      files.filter((f) => f.isFile).map((f) => {
+      files.filter((f) => f.isFile && !f.name.startsWith("README")).map((f) => {
         const noExt = f.name.substring(0, f.name.lastIndexOf("."));
         return `- [${noExt}](./${f.name})`;
       }).join("\n")
@@ -87,6 +92,7 @@ if (import.meta.main) {
   }
 
   const files = await getAllFilesInDir(adrdir);
+  await ensureAssetsDirExists(adrdir);
   const adrsOnly = files.filter((f) => /^\d{5}-.*$/.test(f.name));
   const action = Deno.args[0];