javascript - 将第三方库包含到您的 GitHub 项目中

Question

将第三方 Javascript 库包含到使用该库的项目的 GitHub 存储库中是否合适？或者在 README 文件中定义依赖关系和指向它的链接是更好的做法吗？或者是否有任何其他最佳实践来处理项目中使用的第三方库？

Answer 1

Is it appropriate to include a third-party Javascript library

它可能是也可能不是，这取决于图书馆的许可证。例如，如果该库是根据 MIT、Apache 或 BSD 许可中的任何一个许可的，通常就可以了。如果它是 GPL 许可证，这通常意味着您的整个项目需要在 GPL 下。 (免责声明:IANAL)

Or is it a better practice to define the dependency

是的——出于上述原因以及可维护性。如果您将库包含在您的存储库中，它不会自动包含错误修复或更新版本。

are there any other best practices to deal with third-party libraries

是的，这就是包管理器的设计目的。典型的包管理器是 npm和 bower .

作为使用 Bower 的示例，您的 github 存储库需要包含文件 bower.json ，像这样:

{
  "name": "mylib",
  "version": "1.0.0",
  "main": "path/to/mylib.js",
  "dependencies": {
    "<third-party-library>": "<version>",
  },
}

更多选项可用于管理仅开发依赖项、在创建分发版本时忽略文件等。查看以上链接中的教程。

完成此操作后，您可以 register the package方便其他人安装，例如通过这个命令:

bower install mylib

这将自动安装您的代码以及所有依赖项，例如您提到的第三方库。

请注意，我并不是特别提倡 Bower，它只是与 git 存储库配合良好的一个示例。