使用 Mocha 使用 Typescript 对 Jquery 进行单元测试时，如何修复“$ 未定义”错误？

Question

我正在为包含Jquery 的Typescript代码编写Mocha单元测试。 我正在使用jsdom来获取文档对象。 当我将 TS 代码编译为 JS 并运行测试时，它会引发错误[ReferenceError: $ is not defined] 。

我的打字稿代码在这里

export function hello(element) : void {
    $(element).toggleClass('abc');
};

我的单元测试代码如下：

import {hello} from '../src/dummy';

var expect = require('chai').expect;
var jsdom = require('jsdom');
var document = jsdom.jsdom();
var window = document.defaultView;

var $ = require('jquery')(window);

describe('TEST NAME', () => {

    it('should run', (done) => {
        hello($('div'));
        done();
    });
});

当我运行 Mocha 测试时，它显示

    <failure message="$ is not defined"><![CDATA[ReferenceError: $ is not defined ...
]]></failure>

也尝试使用global.$ = require("jquery"); 但不起作用。

Answer 1

jQuery 必须全局可用，因为您的脚本从全局空间获取它。 如果我修改您的代码，以便var $ = require('jquery')(window); 被替换为：

global.$ = require('jquery')(window);

那么它的工作原理。 注意两个调用：第一个需要jquery ，然后通过传递window来构建它。 你也可以这样做：

global.window = window
global.$ = require('jquery');

如果window全局可用，则不需要像第一个片段中那样执行双重调用：jQuery 只使用全局可用的window 。

您可能还想定义global.jQuery因为某些脚本依赖于它的存在。

这是运行的测试文件的完整示例：

/// <reference path="../typings/mocha/mocha.d.ts" />
/// <reference path="../typings/chai/chai.d.ts" />
/// <reference path="../typings/jsdom/jsdom.d.ts" />
/// <reference path="./global.d.ts" />

import {hello} from './dummy';

import chai = require('chai');
var expect = chai.expect;
import jsdom = require('jsdom');
var document = jsdom.jsdom("");
var window = document.defaultView;

global.window = window
global.$ = require('jquery');

describe('TEST NAME', () => {

    it('should run', (done) => {
        hello($('div'));
        done();
    });
});

该typings文件获得使用通常方式tsd 。 文件./global.d.ts修复了在global上设置新值时可能遇到的问题。 它包含：

declare namespace NodeJS {
    interface Global {
      window: any;
      $: any;
    }
}

dummy.js也做了如下修改：

declare var $: any;

export function hello(element) : void {
    $(element).toggleClass('abc');
};

Answer 2

你需要先在 Node 中包含 jsdom 和 jQuery：

 npm install jsdom --save-dev npm install jquery --save-dev

然后将此行添加到您使用 jQuery 的 .js 文件中

 const jsdom = require("jsdom"); const { JSDOM } = jsdom; const { window } = new JSDOM(`...`); var jQuery = require('jquery')(window); var example = (function($) { .....your jQuery code.... })(jQuery); module.exports = example;

Answer 3

我在 2020 年发现了这个问题，路易斯让我指出了正确的方向。 但是，我发现jsdom-global是一种在 Mocha 中获取文档的更简单的替代方法。 我jsdom-global的说明安装了jsdom-global

我使用这些行让 jQuery 和 $ 按预期工作：

require('jsdom-global')();
global.window = window;
global.$ = require('jquery');
global.jQuery = $;

然后这个测试以优异的成绩通过了：

const assert = require("chai").assert;
function test(){
    return "test";
}
describe('Setting up global constants...', function () {
    describe('Libraries...', function () {
        it('jQuery and $ are present', () => {
            assert(jQuery !== undefined);
            assert($ !== undefined);
            assert($ === jQuery);
            assert($.isFunction(test));
        });
    });
});

Answer 4

如果您不能或不想更改全局命名空间类型定义，您仍然可以包含 jQuery，如下所示：

const globalAny:any = global;
const $ = globalAny.$ = require('jquery')(window);

jQuery 的完整初始化然后变成：

const jsdom = require("jsdom");
const { JSDOM } = jsdom;
const { window } = (new JSDOM());
const globalAny:any = global;
const $ = globalAny.$ = require('jquery')(window);

Answer 5

如上所述，您应该正确导入 jQuery： import $ = require('jquery');