The CLI tool automatically generates basic validation rules for popular libraries such as JOI, ValidatorJS and @vinejs/vine based on your database table schema!
npm install nodejs-schema-rules
The CLI tool automatically generates basic validation rules for popular libraries such as JOI, ValidatorJS and @vinejs/vine rules based on your database table schema. These rules serve as a convenient starting point, allowing you to refine and enhance them to suit your specific needs.
ndVr CLI bash
npm install nodejs-schema-rules -g
yarn add global nodejs-schema-rules
`
Then run for initialization of schema.config.js file then modify as your requirement.`bash
ndVr init
`Modify the
javascript
require("dotenv").config();
const schemaConfig = {
defaultDatabase: 'sqlite',
databases: {
postgres: {
host: 'localhost',
port: 5432,
user: 'postgres',
password: '123456',
database: 'testing'
},
mysql: {
host: 'localhost',
port: 3306,
user: 'root',
password: '123456',
database: 'schema_builder'
},
sqlite: { database: './schema_builder.db' }
},
skipColumns: [ 'created_at', 'updated_at', 'deleted_at' ],
validationSchemaType: 'joi'
};
module.exports = schemaConfig;
`Usage
The
command generates validation rules for a specified database table and its columns. It creates a validation rules based on the chosen validation libraries like joi, "validatorjs", "vine". The generated rules can be used to enforce data integrity and validate incoming requests in your application. Options:
- -db, --database: Specify the type of database (e.g.,
mysql, postgres, sqlite).
- -t, --table: Specify the name of the database table for which rules should be generated.
- -c, --columns: Specify the column names of the table to generate rules for.
- -h, --help: Display help for the command. Examples:
- Generate rules for a MySQL table named
users with columns id and name:
`bash
ndVr joi -t users -db mysql -c id,name
` - Generate rules for a PostgreSQL table named
with a validation library validatorJs:
`bash
ndVr validatorJs -t users -db mysql -c id,name
`
as same as for sqlite.Let's say you've the table structure:
sql
CREATE TABLE data_types (
id INTEGER PRIMARY KEY,
name TEXT,
age INTEGER,
height REAL,
is_student BOOLEAN,
birthdate DATE,
registration_timestamp TIMESTAMP,
description BLOB
created_at TIMESTAMP,
updated_at TIMESTAMP
);
`$3
Now if you run:
bash
ndVr joi -db sqlite -t data_types
`You'll get:
š Schema Base Validation rules for "joi" generated! š
Copy and paste these rules into your validation location, such as controller, form request, or any applicable place š
______________________________________________________________________________________________________________________
{
name: Joi.string().required(),
age: Joi.integer().min(-9223372036854775808).max(9223372036854775807).required(),
height: Joi.number().required(),
is_student: Joi.required(),
birthdate: Joi.date().required(),
registration_timestamp: Joi.required(),
description: Joi.required(),
}
$3
You can also explicitly specify the columns:
bash
ndVr joi -db sqlite -t data_types -c name,age
`Which gives you:
š Schema Base Validation rules for "joi" generated! š
Copy and paste these rules into your validation location, such as controller, form request, or any applicable place š
______________________________________________________________________________________________________________________
{
name: Joi.string().required(),
age: Joi.integer().min(-9223372036854775808).max(9223372036854775807).required(),
}
$3
To always skip columns add it in the
file, under skipColumns attribute.`javascript
skipColumns: (process.env.SKIP_COLUMNS || 'created_at,updated_at,deleted_at').split(',')
`
Supported Drivers
Supported database drivers are MySQL, PostgreSQL, and SQLite.
Validation rules may vary based on the selected driver due to differences in supported data types and range specifications.
Testing
bash
yarn test
``* Linkedin: @tasmidur
* Github: @tasmidur
* Medium: @tasmidur
Contributions, issues and feature requests are welcome!
Feel free to check issues page
Give a āļø if this project helped you!
The MIT License (MIT). Please see License File for more information.