git.iko.soy/urbit.org
on master help sign in
urbit.org/lib/buildPageTree.js
111 lines 3.3 kB history raw
1const fs = require("fs");
2const path = require("path");
3const matter = require("gray-matter");
4const toml = require("@iarna/toml");
6// node ./buildPageTree.js [directory] [sort]
7// eg. node ./buildPageTree docs weight
8// will produce docs.json in the cache folder.
10const options = {
11 engines: {
12 toml: toml.parse.bind(toml),
13 },
14 language: "toml",
15 delimiters: "+++",
16};
18/**
19 * buildPageTree is written to provide a recursive index of posts
20 * for nested directories for creating sidebars
21 * @param {string} path Absolute path to the subdirectory.
22 * @returns {Object.<string,string|Object<string,string[]|number>>} Title of the directory, child pages, and child directories (recursive structure).
23 *
24 */
26// type PageTree =
27// { title: string,
28// pages: [{
29// title: string,
30// base: string,
31// slug: string,
32// weight: number,
33// }],
34// children: { [string]: PageTree },
35// }
37function buildPageTree(dirPath, ordering = "", content = false) {
38 const metadata = matter(
39 fs.readFileSync(path.join(dirPath, "_index.md")),
40 options
41 );
42 // get a list of contents at the dirPath, with file types so that the item at the dirPath can be identified as file or folder
43 const children = fs.readdirSync(dirPath, { withFileTypes: true });
44 // get a list of files
45 const pages = children.filter((f) => f.isFile() && f.name !== "_index.md");
46 // get a list of folders
47 const subdirs = children.filter((f) => f.isDirectory());
48 // return a pagetree datastructure
49 return {
50 title: metadata.data.title,
51 pages: pages
52 .map((page) => {
53 // retrieve topmatter as JSON
54 const { content, data } = matter(
55 fs.readFileSync(path.join(dirPath, page.name)),
56 options
57 );
59 return {
60 ...data,
61 title: data.title,
62 base: page.name,
63 slug: page.name.replace(/.md$/, ""),
64 ...(ordering === "weight" && { weight: data?.weight ?? 0 }),
65 ...(ordering === "date" && {
66 date: data?.date ?? "2000-01-01T00:00:00.000Z",
67 }),
68 };
69 })
70 .sort((a, b) => a.weight - b.weight),
71 children: Object.fromEntries(
72 subdirs
73 .sort((a, b) => {
74 const aMetadata = matter(
75 fs.readFileSync(path.join(dirPath, a.name, "_index.md")),
76 options
77 );
78 const bMetadata = matter(
79 fs.readFileSync(path.join(dirPath, b.name, "_index.md")),
80 options
81 );
82 return aMetadata?.data?.weight - bMetadata?.data?.weight || 0;
83 })
84 .map((subdir) => [
85 subdir.name,
86 buildPageTree(path.join(dirPath, subdir.name), ordering, content),
87 ])
88 ),
89 };
92const process = require("process");
94const arg = process.argv?.[2];
95const sort = process?.argv?.[3] || "weight";
97const dir = buildPageTree(path.join(process.cwd(), `content/${arg}`), sort);
98const fileContents = `${JSON.stringify(dir)}`;
100try {
101 fs.readdirSync("cache");
102} catch (err) {
103 fs.mkdirSync("cache");
106fs.writeFile(`cache/${arg}.json`, fileContents, function (err) {
107 if (err) return console.error(err);
108 console.log(`${arg} directory structure created.`);
109});
111module.exports = { buildPageTree };