{"id":30990600,"url":"https://github.com/varletjs/ruler-factory","last_synced_at":"2025-09-12T19:48:18.453Z","repository":{"id":313448812,"uuid":"1051476715","full_name":"varletjs/ruler-factory","owner":"varletjs","description":"A flexible, chainable validation rule factory for typeScript/javaScript.","archived":false,"fork":false,"pushed_at":"2025-09-06T05:35:16.000Z","size":80,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-06T06:24:50.191Z","etag":null,"topics":["chainable","data","factory","form","javascript","rules","typescript","validation","validator"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/varletjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-06T04:32:40.000Z","updated_at":"2025-09-06T05:35:19.000Z","dependencies_parsed_at":"2025-09-06T06:25:01.424Z","dependency_job_id":"b4591e60-211a-4757-bcda-38e70ab0f7fd","html_url":"https://github.com/varletjs/ruler-factory","commit_stats":null,"previous_names":["varletjs/rule-factory"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/varletjs/ruler-factory","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varletjs%2Fruler-factory","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varletjs%2Fruler-factory/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varletjs%2Fruler-factory/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varletjs%2Fruler-factory/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/varletjs","download_url":"https://codeload.github.com/varletjs/ruler-factory/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varletjs%2Fruler-factory/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274865598,"owners_count":25364250,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-12T02:00:09.324Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chainable","data","factory","form","javascript","rules","typescript","validation","validator"],"created_at":"2025-09-12T19:48:14.319Z","updated_at":"2025-09-12T19:48:18.423Z","avatar_url":"https://github.com/varletjs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ruler-factory\n\nA flexible, chainable validation rule factory for TypeScript/JavaScript.\n\n## Features\n\n- Chainable API for building complex validation rules\n- Supports string, number, array, boolean, object, symbol, bigint, null, undefined\n- Customizable error messages\n- Easy to extend and integrate\n- TypeScript support\n\n## Installation\n\n```bash\npnpm add ruler-factory\n# or\nnpm install ruler-factory\n# or\nyarn add ruler-factory\n```\n\n## Integration with UI frameworks\n\n### Varlet UI\n\n```vue\n\u003cscript setup lang=\"ts\"\u003e\nimport { ref } from 'vue'\nimport { rulerFactory } from 'ruler-factory'\n\nconst ruler = rulerFactory((validator) =\u003e {\n  return (value) =\u003e {\n    const e = validator(value)\n    return e ? e.message : true\n  }\n})\n\nconst model = ref({\n  name: '',\n  email: '',\n})\n\u003c/script\u003e\n\n\u003ctemplate\u003e\n  \u003cvar-form\u003e\n    \u003cvar-input\n      v-model=\"model.name\"\n      placeholder=\"Name\"\n      :rules=\"ruler().required('Required').min(2, 'Wrong length').done()\"\n    /\u003e\n    \u003cvar-input v-model=\"model.age\" placeholder=\"Email\" :rules=\"ruler().email('Must be email format').done()\" /\u003e\n  \u003c/var-form\u003e\n\u003c/template\u003e\n```\n\n### Vant\n\n```vue\n\u003cscript setup lang=\"ts\"\u003e\nimport { ref } from 'vue'\nimport { rulerFactory } from 'ruler-factory'\nimport type { FieldRule } from 'vant'\n\nconst ruler = rulerFactory\u003cFieldRule\u003e((validator, params) =\u003e ({\n  validator(value) {\n    const e = validator(value)\n\n    return e ? e.message : true\n  },\n  trigger: ['onChange', 'onBlur', 'onSubmit'],\n  ...params,\n}))\n\nconst model = ref({\n  name: '',\n  email: '',\n})\n\u003c/script\u003e\n\n\u003ctemplate\u003e\n  \u003cvan-form\u003e\n    \u003cvan-cell-group inset\u003e\n      \u003cvan-field v-model=\"model.name\" label=\"Name\" placeholder=\"Name\" :rules=\"ruler().required('Required').done()\" /\u003e\n      \u003cvan-field\n        v-model=\"model.email\"\n        label=\"Email\"\n        placeholder=\"Email\"\n        :rules=\"ruler().email('Must be email format').done()\"\n      /\u003e\n    \u003c/van-cell-group\u003e\n  \u003c/van-form\u003e\n\u003c/template\u003e\n```\n\n### Naive UI\n\n```vue\n\u003cscript setup lang=\"ts\"\u003e\nimport { ref } from 'vue'\nimport type { FormItemRule } from 'naive-ui'\nimport { rulerFactory } from 'ruler-factory'\n\nconst ruler = rulerFactory\u003cFormItemRule\u003e((validator, params = {}) =\u003e ({\n  trigger: ['blur', 'change', 'input'],\n  validator: (_, value) =\u003e validator(value),\n  ...params,\n}))\n\nconst model = ref({\n  name: '',\n  age: 20,\n})\n\u003c/script\u003e\n\n\u003ctemplate\u003e\n  \u003cn-form :model\u003e\n    \u003cn-form-item path=\"name\" label=\"Name\" :rule=\"ruler().required('Required').min(2, 'Wrong length').done()\"\u003e\n      \u003cn-input v-model:value=\"model.name\" /\u003e\n    \u003c/n-form-item\u003e\n    \u003cn-form-item\n      path=\"age\"\n      label=\"Age\"\n      :rule=\"ruler().number().required('Required').negative('Must be negative').done()\"\n    \u003e\n      \u003cn-input-number v-model:value=\"model.age\" /\u003e\n    \u003c/n-form-item\u003e\n  \u003c/n-form\u003e\n\u003c/template\u003e\n```\n\n### Element Plus\n\n```vue\n\u003cscript setup lang=\"ts\"\u003e\nimport { ref } from 'vue'\nimport type { FormItemRule } from 'element-plus'\nimport { rulerFactory } from 'ruler-factory'\n\nconst ruler = rulerFactory\u003cFormItemRule\u003e((validator, params) =\u003e ({\n  validator(_, value, callback) {\n    const e = validator(value)\n\n    e ? callback(e) : callback()\n  },\n  trigger: ['blur', 'change', 'input'],\n  ...params,\n}))\n\nconst model = ref({\n  name: '',\n  email: '',\n})\n\u003c/script\u003e\n\n\u003ctemplate\u003e\n  \u003cel-form :model\u003e\n    \u003cel-form-item prop=\"name\" label=\"Name\" :rules=\"ruler().required('Required').done()\"\u003e\n      \u003cel-input v-model=\"model.name\" /\u003e\n    \u003c/el-form-item\u003e\n    \u003cel-form-item prop=\"email\" label=\"Email\" :rules=\"ruler().email('Must be email format').done()\"\u003e\n      \u003cel-input v-model=\"model.email\" /\u003e\n    \u003c/el-form-item\u003e\n  \u003c/el-form\u003e\n\u003c/template\u003e\n```\n\n### Extend API\n\nTake `Naive UI` as an example\n\n```ts\nimport { FormItemRule } from 'naive-ui'\nimport { RulerContext, rulerFactory, RulerFactoryMessage } from 'ruler-factory'\n\ninterface RulerExtendedContext {\n  ip(message: RulerFactoryMessage, params?: FormItemRule): RulerContext\u003cFormItemRule, FormItemRule, this\u003e\n}\n\ncustomRuler().ip('ip format error').done()\n\nconst ruler = rulerFactory\u003cFormItemRule, FormItemRule, RulerExtendedContext\u003e(\n  (validator, params = {}) =\u003e ({\n    trigger: ['blur', 'change', 'input'],\n    validator: (_, value) =\u003e validator(value),\n    ...params,\n  }),\n  (ctx) =\u003e {\n    function ip(message: RulerFactoryMessage, params?: FormItemRule) {\n      ctx.addRule((value) =\u003e {\n        // Implement isString and isIP by yourself\n        if (!isString(value) || !isIP(value)) {\n          return new Error(ctx.getMessage(message))\n        }\n      }, params)\n\n      return ctx\n    }\n\n    return { ip }\n  },\n)\n```\n\n## API\n\n### Types Validation\n\n- `.string(message?, params?)`\n- `.number(message?, params?)`\n- `.array(message?, params?)`\n- `.boolean(message?, params?)`\n- `.object(message?, params?)`\n- `.symbol(message?, params?)`\n- `.bigint(message?, params?)`\n- `.null(message?, params?)`\n- `.undefined(message?, params?)`\n- `.true(message?, params?)`\n- `.false(message?, params?)`\n\n### Non Empty Validation\n\n- `.required(message)`\n\n### String Validation\n\n- `.min(value, message, params?)`\n- `.max(value, message, params?)`\n- `.length(value, message, params?)`\n- `.regex(regexp, message, params?)`\n- `.startsWith(value, message, params?)`\n- `.endsWith(value, message, params?)`\n- `.includes(value, message, params?)`\n- `.uppercase(message, params?)`\n- `.lowercase(message, params?)`\n- `.email(message, params?)`\n\n### Number Validation\n\n- `.number().min(value, message, params?)`\n- `.number().max(value, message, params?)`\n- `.number().gt(value, message, params?)`\n- `.number().gte(value, message, params?)` alias .min\n- `.number().lt(value, message, params?)`\n- `.number().lte(value, message, params?)` alias .max\n- `.number().positive(value, message, params?)`\n- `.number().negative(value, message, params?)`\n\n### Bigint Validation\n\n- `.bigint().min(value, message, params?)`\n- `.bigint().max(value, message, params?)`\n- `.bigint().gt(value, message, params?)`\n- `.bigint().gte(value, message, params?)` alias .min\n- `.bigint().lt(value, message, params?)`\n- `.bigint().lte(value, message, params?)` alias .max\n- `.bigint().positive(value, message, params?)`\n- `.bigint().negative(value, message, params?)`\n\n### Array Validation\n\n- `.array().min(value, message, params?)`\n- `.array().max(value, message, params?)`\n- `.array().length(value, message, params?)`\n- `.array().includes(value, message, params?)`\n\n### Predicate Validation\n\n- `.is(fn, message, params?)`\n- `.not(fn, message, params?)`\n\n### Complete rule building\n\n- `.done()`\n\n### Custom Rule\n\n- `.addRule(validator)`\n\n### Value Transformer\n\n- `.trim()`\n- `.toLowerCase()`\n- `.toUpperCase()`\n- `.transform(fn)`\n\n## License\n\nMIT\n\n## Links\n\n- [GitHub Repository](https://github.com/varletjs/ruler-factory)\n- [Issues](https://github.com/varletjs/ruler-factory/issues)\n\n## Inspired By\n\n[`zod`](https://zod.dev/)\n[`yup`](https://github.com/jquense/yup)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvarletjs%2Fruler-factory","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvarletjs%2Fruler-factory","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvarletjs%2Fruler-factory/lists"}