Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@codama/validators

Package Overview
Dependencies
Maintainers
0
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@codama/validators

Validator visitors for the Codama framework

  • 1.0.0
  • Source
  • npm
  • Socket score

Version published
Maintainers
0
Created
Source

Codama ➤ Validators

npm npm-downloads

This package offers a set of validation rules for Codama IDLs to ensure that they are correctly formatted.

Installation

pnpm install @codama/validators

[!NOTE] This package is included in the main codama package. Meaning, you already have access to its content if you are installing Codama this way.

pnpm install codama

Types

ValidationItem

A validation item describes a single piece of information — typically a warning or an error — about a node in the Codama IDL.

type ValidationItem = {
    // The level of importance of a validation item.
    level: 'debug' | 'trace' | 'info' | 'warn' | 'error';
    // A human-readable message describing the issue or information.
    message: string;
    // The node that the validation item is related to.
    node: Node;
    // The stack of nodes that led to the node above.
    stack: readonly Node[];
};

Functions

getValidationItemsVisitor(visitor)

The getValidationItemsVisitor function returns a visitor that collects all validation items from a Codama IDL. Note that this visitor is still a work in progress and does not cover all validation rules.

import { getValidationItemsVisitor } from '@codama/validators';

const validationItems = codama.accept(getValidationItemsVisitor());

throwValidatorItemsVisitor(visitor)

The throwValidatorItemsVisitor function accepts a Visitor<ValidationItemp[]> and throws an error if any validation items above a certain level are found. By default, the level is set to 'error' but a second argument can be passed to change it.

import { throwValidatorItemsVisitor, getValidationItemsVisitor } from '@codama/validators';

// Throw if any "error" items are found.
codama.accept(throwValidatorItemsVisitor(getValidationItemsVisitor()));

// Throw if any "warn" or "error" items are found.
codama.accept(throwValidatorItemsVisitor(getValidationItemsVisitor(), 'warn'));

Keywords

FAQs

Package last updated on 09 Oct 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc