aboutsummaryrefslogtreecommitdiff
path: root/validators/nodejs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'validators/nodejs/README.md')
-rw-r--r--validators/nodejs/README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/validators/nodejs/README.md b/validators/nodejs/README.md
new file mode 100644
index 0000000..4fe9fa6
--- /dev/null
+++ b/validators/nodejs/README.md
@@ -0,0 +1,37 @@
+# Node.js Validator
+
+A zero-dependency Node.js CLI tool for validating `.gitinfo` files.
+
+## Requirements
+
+- Node.js 14+
+
+## Usage
+
+```bash
+# Validate .gitinfo in current directory
+node validate.js
+
+# Validate a specific file
+node validate.js path/to/.gitinfo
+```
+
+## Features
+
+- Parses JSONC (strips `//` and `/* */` comments)
+- Validates against the gitinfo JSON Schema
+- Checks types, formats (URI, email), and patterns
+- Enforces `additionalProperties: false`
+- Returns exit code 0 on success, 1 on failure
+
+## Example Output
+
+```
+✓ .gitinfo is valid
+```
+
+```
+Validation failed for .gitinfo:
+ - .root: invalid URI "not-a-url"
+ - root: unknown property "invalid_field"
+```