@babel/helper-validator-option

What is @babel/helper-validator-option?

The @babel/helper-validator-option package is a utility for Babel's internal use. It provides helper functions to validate options passed to Babel plugins or presets. It ensures that the options are of the correct type and format before they are processed by Babel.

What are @babel/helper-validator-option's main functionalities?

Validation of Option Types

This feature allows developers to validate the type of an option passed to a Babel plugin or preset. The 'validator' function is used to create a validator for a specific option, which can then be used to check the type of the value passed for that option.

const { validator } = require('@babel/helper-validator-option');
const validateOption = validator('plugin-name', 'optionName', 'expectedType');
validateOption(someValue);

Custom Error Messages

This feature enables the customization of error messages when an invalid option is passed. Developers can provide a custom error message that will be displayed if the validation fails.

const { validator } = require('@babel/helper-validator-option');
const validateOption = validator('plugin-name', 'optionName', 'expectedType', 'Custom error message for invalid option.');
validateOption(someValue);

Other packages similar to @babel/helper-validator-option

joi

Joi is a powerful schema description language and data validator for JavaScript. It allows for a more comprehensive and detailed validation schema compared to @babel/helper-validator-option, which is more focused on Babel's internal use for validating plugin and preset options.

prop-types

Prop-types is a library for React that is used to validate the types of props passed to React components. While it serves a different ecosystem (React vs. Babel), the core functionality of validating input types is similar to what @babel/helper-validator-option provides for Babel plugins and presets.

yup

Yup is a JavaScript schema builder for value parsing and validation. It defines a schema with a fluent API and is often used in form validation. Yup provides a more extensive set of features for validating complex data structures compared to @babel/helper-validator-option, which is more narrowly scoped for Babel configuration validation.

README

@babel/helper-validator-option

Validate plugin/preset options

See our website @babel/helper-validator-option for more information.

Install

Using npm:

npm install --save @babel/helper-validator-option

or using yarn:

yarn add @babel/helper-validator-option

Changelog

v7.25.9 (2024-10-22)

:bug: Bug Fix

• babel-parser, babel-template, babel-types
  • #16905 fix: Keep type annotations in syntacticPlaceholders mode (@liuxingbaoyu)
• babel-helper-compilation-targets, babel-preset-env
  • #16907 fix: support BROWSERSLIST{,_CONFIG} env (@JLHwung)
• Other
  • #16884 Analyze ClassAccessorProperty to prevent the no-undef rule (@victorenator)

:house: Internal

• babel-helper-transform-fixture-test-runner
  • #16914 remove test options flaky (@JLHwung)

:running_woman: Performance

• babel-parser, babel-types
  • #16918 perf: Make VISITOR_KEYS etc. faster to access (@liuxingbaoyu)