docs(postinstall): add @throws documentation to validateAgentFile

leocavalcante · leocavalcante · commit 81c6d7bc765f · 2026-01-18T20:41:49.000-03:00
Signed-off-by: leocavalcante &lt;leo@cavalcante.dev&gt;
diff --git a/postinstall.mjs b/postinstall.mjs
@@ -69,6 +69,9 @@ const verbose = logger.verbose
  *
  * @param {string} filePath - Path to the agent file to validate
  * @returns {{ valid: boolean, error?: string }} Validation result with optional error message
+ * @throws {Error} If the file does not exist (ENOENT)
+ * @throws {Error} If permission is denied reading the file (EACCES)
+ * @throws {Error} If the file is a directory (EISDIR)
  *
  * @example
  * // Validate an agent file

Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,9 @@ const verbose = logger.verbose`
`69`	`69`	`*`
`70`	`70`	`* @param {string} filePath - Path to the agent file to validate`
`71`	`71`	`* @returns {{ valid: boolean, error?: string }} Validation result with optional error message`
	`72`	`+ * @throws {Error} If the file does not exist (ENOENT)`
	`73`	`+ * @throws {Error} If permission is denied reading the file (EACCES)`
	`74`	`+ * @throws {Error} If the file is a directory (EISDIR)`
`72`	`75`	`*`
`73`	`76`	`* @example`
`74`	`77`	`* // Validate an agent file`