Dactyloidae/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/mark-test-function-used.js

37 lines
1.1 KiB
JavaScript

/**
* @fileoverview Simply marks `test` (the test method) or `run_test` as used when
* in mochitests or xpcshell tests respectively. This avoids ESLint telling us
* that the function is never called.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
"use strict";
// -----------------------------------------------------------------------------
// Rule Definition
// -----------------------------------------------------------------------------
var helpers = require("../helpers");
module.exports = function(context) {
// ---------------------------------------------------------------------------
// Public
// ---------------------------------------------------------------------------
return {
Program: function() {
if (helpers.getTestType(this) == "browser") {
context.markVariableAsUsed("test");
return;
}
if (helpers.getTestType(this) == "xpcshell") {
context.markVariableAsUsed("run_test");
return;
}
}
};
};