到目前为止还没有添加任何描述。
npm-package-validator的Python项目详细描述
这个python包允许您验证npm包的名称。 它是javascript官方npm/validate-npm-package-name包的python实现。在
$ pip install npm_package_validator
CLI使用
^{pr2}$编程用法
验证npm包名称,如下所示:
importnpm_package_validator# Fails! Uppercase is not allowed for new packagesassertnpm_package_validator.valid_new_package('MY-package')
但是,只允许大写一次,您还可以验证旧的、现有的包:
assertnpm_package_validator.valid_old_package('MY-package')# Succeeds!
使用CLI时,可以使用--old标志。在
如果您想知道名字有什么问题,请使用:
fromnpm_package_validator.validateimportvalidate_packageerrors,warnings=validate_package('MY-package')print("Errors: %s"%", ".join(errors))print("Warnings: %s"%", ".join(warnings))
有效的新包名必须既没有errors也没有warnings。 现有包可以有warnings, 随着时间的推移,npm验证规则变得越来越严格。在
学分
此包是来自官方npm/validate-npm-package-name的端口
发展
有关详细说明,请参见CONTRIBUTING。在
测试
可以使用运行测试
$ invoke test$ invoke test --min-coverage=90# Fail when code coverage is below 90% $ invoke type-check # Run mypy type checks
Linting和格式化
Lint并用
$ invoke format $ invoke lint
所有这些都是在运行invoke pre-commit时发生的。在
注意
该项目仍处于第一阶段,不应视为已准备好生产。在
- 项目
标签: