1

我发现很难找到一个关于为 nodejs 应用程序编写插件的好教程(而不是 nodejs 本身!)。

我想要做的是,对于一些 nodejs 应用程序,我想用我写的几个 js 文件来扩展它的功能。

例如,我正在使用 karma runner 来运行 JS 单元测试,但是现有的记者并不能很好地满足我们的日志记录要求。所以我写了我自己的记者并将它放在一个单独的 js 文件中,例如myreporter.js。现在要使用它,我必须将myreporter.js添加到 karma 代码的文件夹中,然后在 karma 的reporter.js中添加一些这样的行:

exports.myreporter = require('./reporters/myreporter');

这在我的机器上运行良好,但是,它可能是 CI 服务器的问题。我不想在我们自己的项目中包含所有业力代码。我想从服务器上的公共 repo 安装业力,并且只在我们的项目中包含 myreporter.js,这样我们就不必为每个构建安装修改后的业力。而且我只想安装 myreporter.js 作为构建的 karma 插件。

我不确定这是否足够清楚。所以我需要为 karma 或任何现有的 nodejs 应用程序编写一个插件。我应该仍然可以像以前一样使用该应用程序,同时我可以使用插件带来的新功能。

我已经看到这个关于peerdependency的页面。这是否意味着如果我将 peerdependency 或 karma 添加到 myreporter.js 的 package.json 文件中,一旦我安装了 myreporter 包并运行 karma,karma 就会选择新的记者?

感谢您对这个长问题的任何帮助。

更新:

尝试过对等依赖,似乎 karma 0.8.6 没有选择我的插件。看起来从 0.9 开始 karma 正在使用di,我想那是它开始支持插件的时候。但是,0.9.3 仍然不是一个稳定的版本。

4

1 回答 1

4

自己找到了答案。如果应用程序本身不明确支持插件,则可能无法为通用 nodejs 应用程序编写插件。

但是,更改应用程序以支持插件非常容易。唯一要做的就是使用强大的“require”来获取带有名称的插件模块。例如,在 Karma 0.9.4(目前是最新版本)中,它具有加载所有插件模块的plugin.js :

...
var requirePlugin = function(name) {
    log.debug('Loading plugin %s.', name);
    try {
      modules.push(require(name));  // Call require here!
    } catch (e) {
      if (e.code === 'MODULE_NOT_FOUND' && e.message.indexOf(name) !== -1) {
        log.warn('Cannot find plugin "%s".\n  Did you forget to install it ?\n' +
                 '  npm install %s --save-dev', name, name);
      } else {
        log.warn('Error during loading "%s" plugin:\n  %s', name, e.message);
      }
    }
  };

所有自定义插件都可以在conf.js文件中设置,如下所示:

...
plugins: ['you-own-plugin'],
...

要编写自己的插件,请查看Karma github,这里有很多 Karma 插件示例。

不幸的是,Karma 的最新稳定版本 (0.8.6) 不支持外部插件。我必须自己修改preprocessor.js和report.js 以支持自定义预处理器和报告器我在下面提供了更改,这是简单的更改,但并不推荐。

//preprocessor.js line 26
processor = exports[processorName] || require(processorName.toLowerCase())

//reporter.js line 48
var Reporter = exports[helper.ucFirst(name) + (config.colors ? 'Color' : '')] || require(name.toLowerCase());
于 2013-07-02T00:26:19.483 回答