fxn/workspace-detector
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add better docs to newer features

Browse Source
This commit is contained in:
Ivy C
2025-09-23 23:33:01 -04:00
parent f63ab5820a
commit 281c6c7112
3 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/cli.luau
+3
View File
@@ -12,6 +12,7 @@ export type CLI = {
local cli = {} :: CLI local cli = {} :: CLI
-- parses command line arguments into options
function cli.parseArgs(): types.opts function cli.parseArgs(): types.opts
local args = process.args local args = process.args
local opts = { local opts = {
@@ -68,6 +69,7 @@ function cli.parseArgs(): types.opts
return opts return opts
end end
-- prints usage instructions for the command line tool
function cli.printUsage() function cli.printUsage()
stdio.write(stdio.color("red")) stdio.write(stdio.color("red"))
stdio.write("Error: Please provide file path(s) or use --directory flag.\n") stdio.write("Error: Please provide file path(s) or use --directory flag.\n")
@@ -83,6 +85,7 @@ function cli.printUsage()
stdio.write(stdio.color("reset")) stdio.write(stdio.color("reset"))
end end
-- checks if output file exists to prevent overwriting
function cli.checkOutputFile(outputFile: string?) function cli.checkOutputFile(outputFile: string?)
if outputFile and fs.isFile(outputFile) then if outputFile and fs.isFile(outputFile) then
stdio.write(stdio.color("red")) stdio.write(stdio.color("red"))
lib/core.luau
+1
View File
@@ -54,6 +54,7 @@ function core.fileContainsWorkspace(fileContents: string, opts: types.opts): boo
return core.scanForWorkspace(instances, opts.printInstanceNames) return core.scanForWorkspace(instances, opts.printInstanceNames)
end end
-- formats the workspace detection result as a colored string
function core.formatResult(result: boolean, fileName: string): string function core.formatResult(result: boolean, fileName: string): string
assert(typeof(result) == "boolean", "Expected result to be of type 'boolean'") assert(typeof(result) == "boolean", "Expected result to be of type 'boolean'")
assert(typeof(fileName) == "string", "Expected fileName to be of type 'string'") assert(typeof(fileName) == "string", "Expected fileName to be of type 'string'")
lib/fileproc.luau
+2
View File
@@ -14,6 +14,7 @@ export type FileProc = {
local fileproc = {} :: FileProc local fileproc = {} :: FileProc
-- collects files to process from command line args or directory
function fileproc.collectFiles(opts: types.opts): {string} function fileproc.collectFiles(opts: types.opts): {string}
assert(typeof(opts) == "table", "Expected opts to be of type 'table'") assert(typeof(opts) == "table", "Expected opts to be of type 'table'")
local filesToProcess = opts.filesToProcess or {} local filesToProcess = opts.filesToProcess or {}
@@ -53,6 +54,7 @@ function fileproc.collectFiles(opts: types.opts): {string}
return filesToProcess return filesToProcess
end end
-- processes each file and checks for workspace instances
function fileproc.processFiles(filesToProcess: {string}, opts: types.opts): {string} function fileproc.processFiles(filesToProcess: {string}, opts: types.opts): {string}
assert(typeof(filesToProcess) == "table", "Expected filesToProcess to be of type 'table'") assert(typeof(filesToProcess) == "table", "Expected filesToProcess to be of type 'table'")
assert(typeof(opts) == "table", "Expected opts to be of type 'table'") assert(typeof(opts) == "table", "Expected opts to be of type 'table'")