javascript - 记录 javascript 库依赖项的最佳实践

Question

因此，您正在外部 .js 文件中创建一堆代码，这些代码需要 jQuery 及其一些插件、MooTools 或一些更深奥的库。显然，当您加载每个脚本时，实际的“包含”是在 HEAD 部分的主机 HTML 页面中完成的。

但作为可移植性的最佳实践，您的 JavaScript .js 文件中存在哪些内置功能或广泛采用的约定，以确保下一个使用您的代码的笨蛋还记得包含其他所需的库？

我正在寻求开发者社区的一些共识，因此请务必投票选出看起来最常见或您最熟悉的答案。

Answer 1

jQuery UI 在文件头中添加了它们的小部件的依赖关系:

/*
* jQuery UI Effects Bounce @VERSION
*
* Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
* Dual licensed under the MIT or GPL Version 2 licenses.
* http://jquery.org/license
*
* http://docs.jquery.com/UI/Effects/Bounce
*
* Depends:
* jquery.effects.core.js
*/

不幸的是，现在 JavaScript 依赖管理器的使用比他们应该使用的要少，但如果你能让你的库用户切换到一个，你就根本不用担心了:

• StealJS
• Jingo
• YUI loader
• Pyramid Dependency Manager

显式检查可能也是一个好主意，因为如果某些插件可用或不可用，您可以动态使用react(例如，如果未找到 jQuery UI 对话框则抛出异常，或者只是优雅地降级并显示一个简单的模态窗口):

if(!$.isFunction($.fn.dialog)) {
    throw "Could not find jQueryUI dialog. Please include jQuery UI";
}

这样，如果不满足可选依赖项，您的脚本就不必完全中断。