npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@baethon/adonis-validator-extras

v1.1.0

Published

Validator goodies for Adonis framework

Downloads

2

Readme

@baethon/adonis-validator-extras

Package contains some extensions for Adonis Validation extension.

Table of contents

Installation

  1. Install package
    # via adonis
    adonis install @baethon/adonis-validator-extras
    
    # or for Yarn users
    adonis install --yarn @baethon/adonis-validator-extras
    
    # or via yarn
    yarn add @baethon/adonis-validator-extras
    
    # or via npm
    npm i @baethon/adonis-validator-extras
  2. Add @baethon/adonis-validator-extras/providers/ValidationExtenderProvider to application providers

Request extension

Module provides validated() macro for request instance. It will return data from request which went through route validators.

Only defined data will be returned.

Route
  .post('/test', ({ request }) => {
    console.log(request.validated())
  })
  .validator('Test')

This method will fail with exception if request was not validated with validator().

Validator rules flattener

Indicative has support for nested rules.

In many ways they can be inconvienient:

class Test {
  get rules () {
    return {
      name: 'required',
      'address.street': 'string',
      'address.city': 'string'
    }
  }
}

It gets even worse with arrays:

class Test {
  get rules () {
    return {
      name: 'required',
      'family.*.name': 'string',
      'family.*.age': 'integer',
    }
  }
}

Package provides flattenRules helper which allows to write nested rules in more natural manner and later flatten them to format accepted by Indicative.

const { flattenRules } = require('@baethon/adonis-validator-extras')

class Test {
  get rules () {
    return {
      name: 'required',
      family: [{
        name: 'string',
        age: 'integer'
      }]
    }
  }
}

module.exports = flattenRules(Test)

flattenRules will process rules only once. Results are cached which means that rules getter will be static.

Flattened rules support string interpolation of values from ctx:

const { flattenRules } = require('@baethon/adonis-validator-extras')

class Test {
  get rules () {
    return {
      email: 'unique:users,email,id,{{params.id}}'
    }
  }
}

module.exports = flattenRules(Test)

It's also possible to call methods from context (without any arguments):

const { flattenRules } = require('@baethon/adonis-validator-extras')

class Test {
  get rules () {
    return {
      email: 'unique:users,email,id,{{request.all().id}}'
    }
  }
}

module.exports = flattenRules(Test)

development

If you're planning to contribute to the package please make sure to adhere to following conventions.

tests & linting

  • lint your code using standard; run npm run lint to check if there are any linting errors
  • make sure to write tests for all the changes/bug fixes

issues & PR

  • try to provide regression test when you find a bug
  • share some context on what you are trying to do, with enough code to reproduce the issue