Fix title not being correct when several top level items are in a library

Author: filiptibell

.lune/generate.luau

@@ -9,36 +9,62 @@ local writeMarkdown = require("./writer")
 local typedefsFile = fs.readFile("temp/moonwave.json")
 local items: { moonwave.Item } = serde.decode("json", typedefsFile)
 
--- Generate markdown for all of the libraries
-local generatedFiles = {} :: { [number]: {
-	displayName: string,
+-- Sort all of the extracted files & items, making sure that
+-- the item that matches the library name always comes first,
+-- which will prevent for example ChildProcessWriter from
+-- becoming the title for the Process standard library
+local parsedFiles = {} :: { [number]: {
+	path: string,
 	name: string,
-	content: string,
+	item: moonwave.Item,
 } }
 for _, item in items do
-	local file = item.source.path
-	local name = string.match(file, "lune%-std%-(.+)/types%.d%.luau")
-	assert(name ~= nil, "Failed to remove luau suffix from file name")
+	local rawPath = item.source.path
+
+	local path = string.match(rawPath, "lune%-std%-(.+)/types%.d%.luau")
+	assert(path ~= nil, "Failed to match standard library path")
+
+	table.insert(parsedFiles, {
+		path = string.lower(path),
+		name = item.name,
+		item = item,
+	})
+end
+table.sort(parsedFiles, function(a, b)
+	local aIsExact = a.path == string.lower(a.name)
+	local bIsExact = b.path == string.lower(b.name)
+	if aIsExact ~= bIsExact then
+		return aIsExact
+	end
+	return a.path < b.path
+end)
 
+-- Generate all of the markdown
+local generatedFiles = {} :: { [number]: {
+	path: string,
+	name: string,
+	content: string,
+} }
+for _, parsed in parsedFiles do
 	-- If we have an existing entry, such as when we have multiple
 	-- classes within the same library (Regex, RegexCaptures, ...)
 	-- we want to append to the existing entry instead of creating
 	local existing = nil
 	for _, info in generatedFiles do
-		if info.name == string.lower(name) then
+		if info.path == string.lower(parsed.path) then
 			existing = info
 			break
 		end
 	end
 
 	if existing then
-		existing.content ..= writeMarkdown(item, false)
+		existing.content ..= writeMarkdown(parsed.item, false)
 	else
-		local content = `---\ntitle: {item.name}\n---\n\n`
-		content ..= writeMarkdown(item, true)
+		local content = `---\ntitle: {parsed.item.name}\n---\n\n`
+		content ..= writeMarkdown(parsed.item, true)
 		table.insert(generatedFiles, {
-			displayName = item.name,
-			name = string.lower(name),
+			path = string.lower(parsed.path),
+			name = parsed.name,
 			content = content,
 		})
 	end
@@ -50,8 +76,7 @@ if fs.isDir("src/content/docs/api-reference") then
 end
 fs.writeDir("src/content/docs/api-reference")
 for _, file in generatedFiles do
-	print(file)
-	fs.writeFile(`src/content/docs/api-reference/{file.name}.md`, file.content)
+	fs.writeFile(`src/content/docs/api-reference/{file.path}.md`, file.content)
 end
 
 -- Finally, call out to prettier to ensure that our

src/content/docs/api-reference/process.md

@@ -1,65 +1,7 @@
 ---
-title: ChildProcessReader
+title: Process
 ---
 
-A reader class to read data from a child process' streams in realtime.
-
-## Functions
-
-### read
-
-Reads a chunk of data up to the specified length, or a default of 1KB at a time.
-
-Returns nil if there is no more data to read.
-
-This function may yield until there is new data to read from reader, if all data
-till present has already been read, and the process has not exited.
-
-#### Parameters
-
-- `chunkSize` number?
-
-#### Returns
-
-- The string containing the data read from the reader
-
----
-
-### readToEnd
-
-Reads all the data currently present in the reader as a string.
-This function will yield until the process exits.
-
-#### Returns
-
-- The string containing the data read from the reader
-
----
-
-# ChildProcessWriter
-
-A writer class to write data to a child process' streams in realtime.
-
-## Functions
-
-### write
-
-Writes a buffer or string of data to the writer.
-
-#### Parameters
-
-- `data` The data to write to the writer
-
----
-
-### close
-
-Closes the underlying I/O stream for the writer.
-
----
-
-# Process
-
 Built-in functions for the current process & child processes
 
 #### Example usage
@@ -319,3 +261,61 @@ This is a dictionary containing the following values:
 - `stderr` - The full contents written to stderr by the child process, or an empty string if nothing was written
 
 ---
+
+# ChildProcessReader
+
+A reader class to read data from a child process' streams in realtime.
+
+## Functions
+
+### read
+
+Reads a chunk of data up to the specified length, or a default of 1KB at a time.
+
+Returns nil if there is no more data to read.
+
+This function may yield until there is new data to read from reader, if all data
+till present has already been read, and the process has not exited.
+
+#### Parameters
+
+- `chunkSize` number?
+
+#### Returns
+
+- The string containing the data read from the reader
+
+---
+
+### readToEnd
+
+Reads all the data currently present in the reader as a string.
+This function will yield until the process exits.
+
+#### Returns
+
+- The string containing the data read from the reader
+
+---
+
+# ChildProcessWriter
+
+A writer class to write data to a child process' streams in realtime.
+
+## Functions
+
+### write
+
+Writes a buffer or string of data to the writer.
+
+#### Parameters
+
+- `data` The data to write to the writer
+
+---
+
+### close
+
+Closes the underlying I/O stream for the writer.
+
+---

src/content/docs/api-reference/regex.md

@@ -152,10 +152,6 @@ Replaces all matches in the given text with the given replacer string.
 
 ---
 
-# RegexCaptures
-
-Captures from a regular expression.
-
 # RegexMatch
 
 A match from a regular expression.
@@ -166,3 +162,7 @@ Contains the following values:
 - `finish` -- The end index of the match in the original string.
 - `text` -- The text that was matched.
 - `len` -- The length of the text that was matched.
+
+# RegexCaptures
+
+Captures from a regular expression.