command-line-args插件系统扩展：如何自定义类型转换器与验证器 [特殊字符]-育师

command-line-args插件系统扩展：如何自定义类型转换器与验证器 🚀

【免费下载链接】command-line-argsA mature, feature-complete library to parse command-line options.项目地址: https://gitcode.com/gh_mirrors/co/command-line-args

command-line-args是一个成熟且功能完整的命令行参数解析库，它提供了强大的插件系统扩展能力，让开发者能够自定义类型转换器和验证器。通过深入了解其扩展机制，你可以创建更加灵活和强大的命令行工具，满足各种复杂的需求场景。

什么是command-line-args的类型转换器？

在command-line-args中，类型转换器（Type Converter）是一个函数，负责将命令行输入的字符串值转换为程序内部使用的数据类型。默认情况下，库提供了String、Number和Boolean三种基本类型转换器，但真正的强大之处在于你可以创建自己的自定义转换器。

基础类型转换示例

让我们先看看如何使用内置的类型转换器：

import commandLineArgs from 'command-line-args' const optionDefinitions = [ { name: 'port', type: Number }, // 转换为数字 { name: 'verbose', type: Boolean }, // 转换为布尔值 { name: 'name', type: String } // 保持为字符串（默认） ] const options = commandLineArgs(optionDefinitions, { argv: ['--port', '8080', '--verbose', '--name', 'myapp'] }) console.log(options) // 输出: { port: 8080, verbose: true, name: 'myapp' }

创建自定义类型转换器 ✨

自定义类型转换器实际上就是一个接受命令行输入值并返回处理结果的函数。这个函数可以执行任何你需要的转换逻辑。

示例1：文件路径验证器

假设你需要验证用户输入的文件路径是否存在，并返回文件的详细信息：

import fs from 'fs' function filePathValidator(filename) { if (!filename) return null const stats = fs.statSync(filename, { throwIfNoEntry: false }) return { path: filename, exists: !!stats, isFile: stats?.isFile() || false, isDirectory: stats?.isDirectory() || false, size: stats?.size || 0 } } const optionDefinitions = [ { name: 'config', type: filePathValidator } ] const options = commandLineArgs(optionDefinitions, { argv: ['--config', 'app.config.json'] }) console.log(options.config) // 如果文件存在，输出类似: // { // path: 'app.config.json', // exists: true, // isFile: true, // isDirectory: false, // size: 1024 // }

示例2：日期时间转换器

创建一个将字符串转换为Date对象的转换器：

function dateConverter(dateString) { if (!dateString) return null const date = new Date(dateString) if (isNaN(date.getTime())) { throw new Error(`Invalid date format: ${dateString}`) } return date } const optionDefinitions = [ { name: 'start-date', type: dateConverter }, { name: 'end-date', type: dateConverter } ]

示例3：枚举值验证器

验证输入值是否在允许的范围内：

function createEnumValidator(allowedValues) { return function(value) { if (!value) return null if (!allowedValues.includes(value)) { throw new Error( `Invalid value "${value}". Allowed values: ${allowedValues.join(', ')}` ) } return value } } const optionDefinitions = [ { name: 'log-level', type: createEnumValidator(['debug', 'info', 'warn', 'error']) }, { name: 'format', type: createEnumValidator(['json', 'yaml', 'xml']) } ]

高级验证器模式 🔧

组合验证器

你可以创建更复杂的验证器，组合多个验证逻辑：

function createRangeValidator(min, max) { return function(value) { if (value === null || value === undefined) return null const num = Number(value) if (isNaN(num)) { throw new Error(`"${value}" is not a valid number`) } if (num < min || num > max) { throw new Error(`Value must be between ${min} and ${max}`) } return num } } function createRegexValidator(pattern, errorMessage) { const regex = new RegExp(pattern) return function(value) { if (!value) return null if (!regex.test(value)) { throw new Error(errorMessage || `Value does not match pattern: ${pattern}`) } return value } } // 使用组合验证器 const optionDefinitions = [ { name: 'port', type: createRangeValidator(1, 65535) }, { name: 'email', type: createRegexValidator( '^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$', 'Invalid email address format' ) } ]

异步验证器（高级技巧）

虽然command-line-args本身不支持异步验证，但你可以通过预处理或后处理来实现类似功能：

async function validateOptionsAsync(options) { // 异步验证逻辑 if (options.port) { const isPortAvailable = await checkPortAvailability(options.port) if (!isPortAvailable) { throw new Error(`Port ${options.port} is not available`) } } return options } // 使用方式 const options = commandLineArgs(optionDefinitions, { argv: process.argv.slice(2) }) try { const validatedOptions = await validateOptionsAsync(options) // 使用验证后的选项 } catch (error) { console.error('Validation failed:', error.message) process.exit(1) }

处理多个值的类型转换 📦

当选项支持多个值时（使用multiple: true），类型转换器会对每个值分别应用：

function jsonParser(value) { try { return JSON.parse(value) } catch (error) { throw new Error(`Invalid JSON: ${value}`) } } const optionDefinitions = [ { name: 'configs', type: jsonParser, multiple: true } ] const options = commandLineArgs(optionDefinitions, { argv: [ '--configs', '{"name":"app1"}', '--configs', '{"name":"app2"}' ] }) console.log(options.configs) // 输出: [{ name: 'app1' }, { name: 'app2' }]

错误处理与用户友好提示 🛡️

良好的错误处理对于命令行工具至关重要：

function createValidatedNumberConverter(options = {}) { const { min, max, integerOnly = false } = options return function(value) { if (value === null || value === undefined) return null // 转换为数字 const num = Number(value) if (isNaN(num)) { throw new Error(`"${value}" is not a valid number`) } // 整数检查 if (integerOnly && !Number.isInteger(num)) { throw new Error(`"${value}" must be an integer`) } // 范围检查 if (min !== undefined && num < min) { throw new Error(`Value must be at least ${min}`) } if (max !== undefined && num > max) { throw new Error(`Value must be at most ${max}`) } return num } } // 使用带错误处理的转换器 const optionDefinitions = [ { name: 'count', type: createValidatedNumberConverter({ min: 1, max: 100, integerOnly: true }) } ] try { const options = commandLineArgs(optionDefinitions, { argv: ['--count', '150'] }) } catch (error) { console.error('Error:', error.message) // 输出: Error: Value must be at most 100 }

实际应用场景示例 🎯

场景1：配置文件路径转换器

import path from 'path' import fs from 'fs' function configFileConverter(filePath) { if (!filePath) return null // 解析路径 const resolvedPath = path.resolve(filePath) // 检查文件是否存在 if (!fs.existsSync(resolvedPath)) { throw new Error(`Config file not found: ${resolvedPath}`) } // 检查文件扩展名 const ext = path.extname(resolvedPath).toLowerCase() const allowedExtensions = ['.json', '.yaml', '.yml', '.js'] if (!allowedExtensions.includes(ext)) { throw new Error( `Unsupported config file format. Allowed: ${allowedExtensions.join(', ')}` ) } return { path: resolvedPath, extension: ext, basename: path.basename(resolvedPath), dirname: path.dirname(resolvedPath) } }

场景2：颜色代码验证器

function colorCodeValidator(color) { if (!color) return null // 支持 hex, rgb, rgba, hsl, hsla, 颜色名称 const colorFormats = { hex: /^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/, rgb: /^rgb\(\s*\d+\s*,\s*\d+\s*,\s*\d+\s*\)$/, rgba: /^rgba\(\s*\d+\s*,\s*\d+\s*,\s*\d+\s*,\s*(0|1|0?\.\d+)\s*\)$/, hsl: /^hsl\(\s*\d+\s*,\s*\d+%\s*,\s*\d+%\s*\)$/, hsla: /^hsla\(\s*\d+\s*,\s*\d+%\s*,\s*\d+%\s*,\s*(0|1|0?\.\d+)\s*\)$/ } const namedColors = [ 'red', 'green', 'blue', 'yellow', 'black', 'white', 'gray', 'grey', 'purple', 'orange', 'pink', 'brown' ] // 检查是否为命名颜色 if (namedColors.includes(color.toLowerCase())) { return color.toLowerCase() } // 检查格式 for (const [format, regex] of Object.entries(colorFormats)) { if (regex.test(color)) { return { format, value: color } } } throw new Error(`Invalid color format: ${color}`) }