How ibrahimhyazouri/sureform works
Project type and purpose
• This is an open-source, schema-based validation library written in TypeScript. It provides a set of built-in rules (required, string, numeric, etc.), a factory for custom rules, and a core Validator that applies those rules to user data.
• Consumers import the library (npm install sureform) and call new Validator(data, schema...) to validate JavaScript/Vue.js payloads.
File structure
• Top-level files:
• package.json, tsconfig.json, vitest.config.* → Node/TypeScript project and test runner configuration
• src/ → TypeScript source code
• dist/ → Compiled output (ESM/CJS, .js, .d.ts)
• src/ subdirectories:
• core/ → Validator engine (AbstractRule, ValidationRule, Validator)
• factory/ → RuleFactory (Strategy/Factory pattern for creating rule instances)
• rules/ → Individual rule implementations (ArrayRule, Email, Max, etc.)
• tests/ → Unit tests for each rule and integration tests for Validator
• Build pipeline:
• tsc compiles src/ → dist/
• vitest runs tests against src or dist
README for architectural clues
• Core features emphasize a “fluent API,” “schema-based validation,” extensibility via RuleFactory, wildcard paths, and inline callback rules.
• Data flow: data + schema → Validator → ValidationResult (valid/errors)
• Plug-in points: custom rules through RuleFactory or inline functions
Detailed capture of essential elements
– Annotate key methods (e.g., validate(), create() in RuleFactory)
– Highlight plugin point: “RuleFactory.register(‘myRule’, MyRuleClass)”
– Include notes on wildcard support and inline callback rules