Skip to main content

用于检查节点项目 github 存储库的依赖项的 CLI 工具

项目描述


标识

NPMVALIDDEP

用 python 制作的 CLI 工具,用于检查和更新 github 存储库中的 npm 包依赖项
探索文档 »

查看演示 · 报告错误 · 请求功能

目录
  1. 关于该项目
  2. 入门
  3. 用法
  4. 贡献
  5. 执照
  6. 接触
  7. 致谢

关于该项目

NPMVALIDDEP 是一个用 python 制作的 cli 工具,用于检查 NodeJs 项目的 github 存储库中 NPM 包的版本。您可以指定要检查的多个包,还可以指定是否要在包不是最新的情况下提出 PR。它适用于公共和私有存储库(前提是您有权访问存储库),如果您是存储库的所有者,那么它将直接提交到存储库主分支,而不是提出 PR。

回到顶部

内置

回到顶部

入门

下面列出了使用所需先决条件安装软件包的详细步骤。

先决条件

您需要安装以下内容:

  1. Pip(python的包安装程序)
  2. 吉特
  3. 节点和 npm

安装

创建 python 虚拟环境并使用 pip project_url安装 npmvaliddep 包

pip install npmvaliddep

回到顶部

用法

为了确保您可以访问私有存储库,您需要添加您的 github 用户名和身份验证令牌(不用担心,我们将您的令牌存储在本地,甚至不会向您透露它:sunglasses:)

要检查您配置的 github 用户名和密码:

npmvaliddep --getgithubcreds

要配置您的配置 github 用户名和密码:

npmvaliddep --setgithubcreds

要检查存储的密码是否与您的密码匹配:

npmvaliddep --matchgithubpass

要执行多个 github 存储库和包的依赖关系检查:

  1. (必需)创建具有以下标题的 csv 文件并相应地输入行。 图片

  2. (必需)使用 --check 标志指定 csv 的路径

npmvaliddep --check '/home/user/checkrepos.csv'
  1. (必需)使用 --deps 标志指定需要检查的依赖项
npmvaliddep --check '/home/user/checkrepos.csv' --deps axios@0.23.0 cookie-parser@1.4.6
  1. (可选)默认情况下,输出 csv 将在用户主目录中生成,但如果要更改,可以使用 --output 标志指定路径
npmvaliddep --check '/home/user/checkrepos.csv' --deps axios@0.23.0 cookie-parser@1.4.6 --output '/home/user/Downloads/output.csv'

图片

  1. (可选)如果你想生成一个 PR 来更新依赖项,那么你可以传递一个 --createpr 标志
npmvaliddep --check '/home/user/checkrepos.csv' --deps axios@0.23.0 cookie-parser@1.4.6 --output '/home/user/Downloads/output.csv' --createpr

图片 注意 -在上图中,您可以注意到最后一个存储库属于我,即 CLI 的用户,在这种情况下,该工具不会创建 PR,而是直接将更改提交到存储库的主分支。另请注意,如果存储库是私有的并且用户无权访问它,则该工具将跳过该存储库。

回到顶部

贡献

贡献使开源社区成为学习、启发和创造的绝佳场所。非常感谢您所做的任何贡献。

如果你有一个可以让这变得更好的建议,请分叉回购并创建一个拉取请求。您也可以简单地打开带有“增强”标签的问题。别忘了给项目打颗星!再次感谢!

  1. 分叉项目
  2. 创建您的功能分支 ( git checkout -b feature/AmazingFeature)
  3. 提交您的更改 ( git commit -m 'Add some AmazingFeature')
  4. 推送到分支 ( git push origin feature/AmazingFeature)
  5. 打开拉取请求

回到顶部

执照

根据 MIT 许可证分发。有关LICENSE.txt更多信息,请参阅。

回到顶部

接触

Akshat Gupta - @linkedin_handle -给我发邮件

项目链接:https ://github.com/dyte-submissions/dyte-vit-2022-Akshat1903

回到顶部

致谢

  • 我要感谢 dyte 招聘团队完成这项具有挑战性的任务,并专注于另一半不仅渴望 DSA 的学生 :wink:

回到顶部

项目详情


下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

npmvaliddep-2.1.3.tar.gz (12.8 kB 查看哈希

已上传 source

内置分布

npmvaliddep-2.1.3-py3-none-any.whl (10.2 kB 查看哈希

已上传 py3