159 lines
6.5 KiB
Plaintext
159 lines
6.5 KiB
Plaintext
"use strict";
|
|
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
if (k2 === undefined) k2 = k;
|
|
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
}
|
|
Object.defineProperty(o, k2, desc);
|
|
}) : (function(o, m, k, k2) {
|
|
if (k2 === undefined) k2 = k;
|
|
o[k2] = m[k];
|
|
}));
|
|
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
}) : function(o, v) {
|
|
o["default"] = v;
|
|
});
|
|
var __importStar = (this && this.__importStar) || (function () {
|
|
var ownKeys = function(o) {
|
|
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
var ar = [];
|
|
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
return ar;
|
|
};
|
|
return ownKeys(o);
|
|
};
|
|
return function (mod) {
|
|
if (mod && mod.__esModule) return mod;
|
|
var result = {};
|
|
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
__setModuleDefault(result, mod);
|
|
return result;
|
|
};
|
|
})();
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
const utils_1 = require("@typescript-eslint/utils");
|
|
const tsutils = __importStar(require("ts-api-utils"));
|
|
const ts_api_utils_1 = require("ts-api-utils");
|
|
const ts = __importStar(require("typescript"));
|
|
const util_1 = require("../util");
|
|
const promiseUtils_1 = require("../util/promiseUtils");
|
|
exports.default = (0, util_1.createRule)({
|
|
name: 'only-throw-error',
|
|
meta: {
|
|
type: 'problem',
|
|
docs: {
|
|
description: 'Disallow throwing non-`Error` values as exceptions',
|
|
extendsBaseRule: 'no-throw-literal',
|
|
recommended: 'recommended',
|
|
requiresTypeChecking: true,
|
|
},
|
|
messages: {
|
|
object: 'Expected an error object to be thrown.',
|
|
undef: 'Do not throw undefined.',
|
|
},
|
|
schema: [
|
|
{
|
|
type: 'object',
|
|
additionalProperties: false,
|
|
properties: {
|
|
allow: {
|
|
...util_1.typeOrValueSpecifiersSchema,
|
|
description: 'Type specifiers that can be thrown.',
|
|
},
|
|
allowRethrowing: {
|
|
type: 'boolean',
|
|
description: 'Whether to allow rethrowing caught values that are not `Error` objects.',
|
|
},
|
|
allowThrowingAny: {
|
|
type: 'boolean',
|
|
description: 'Whether to always allow throwing values typed as `any`.',
|
|
},
|
|
allowThrowingUnknown: {
|
|
type: 'boolean',
|
|
description: 'Whether to always allow throwing values typed as `unknown`.',
|
|
},
|
|
},
|
|
},
|
|
],
|
|
},
|
|
defaultOptions: [
|
|
{
|
|
allow: [],
|
|
allowRethrowing: true,
|
|
allowThrowingAny: true,
|
|
allowThrowingUnknown: true,
|
|
},
|
|
],
|
|
create(context, [options]) {
|
|
const services = (0, util_1.getParserServices)(context);
|
|
const allow = options.allow;
|
|
function isRethrownError(node) {
|
|
if (node.type !== utils_1.AST_NODE_TYPES.Identifier) {
|
|
return false;
|
|
}
|
|
const scope = context.sourceCode.getScope(node);
|
|
const smVariable = (0, util_1.nullThrows)((0, util_1.findVariable)(scope, node), `Variable ${node.name} should exist in scope manager`);
|
|
const variableDefinitions = smVariable.defs.filter(def => def.isVariableDefinition);
|
|
if (variableDefinitions.length !== 1) {
|
|
return false;
|
|
}
|
|
const def = smVariable.defs[0];
|
|
// try { /* ... */ } catch (x) { throw x; }
|
|
if (def.node.type === utils_1.AST_NODE_TYPES.CatchClause) {
|
|
return true;
|
|
}
|
|
// promise.catch(x => { throw x; })
|
|
// promise.then(onFulfilled, x => { throw x; })
|
|
if (def.node.type === utils_1.AST_NODE_TYPES.ArrowFunctionExpression &&
|
|
def.node.params.length >= 1 &&
|
|
def.node.params[0] === def.name &&
|
|
def.node.parent.type === utils_1.AST_NODE_TYPES.CallExpression) {
|
|
const callExpression = def.node.parent;
|
|
const parsedPromiseHandlingCall = (0, promiseUtils_1.parseCatchCall)(callExpression, context) ??
|
|
(0, promiseUtils_1.parseThenCall)(callExpression, context);
|
|
if (parsedPromiseHandlingCall != null) {
|
|
const { object, onRejected } = parsedPromiseHandlingCall;
|
|
if (onRejected === def.node) {
|
|
const tsObjectNode = services.esTreeNodeToTSNodeMap.get(object);
|
|
// make sure we're actually dealing with a promise
|
|
if ((0, ts_api_utils_1.isThenableType)(services.program.getTypeChecker(), tsObjectNode)) {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
function checkThrowArgument(node) {
|
|
if (options.allowRethrowing && isRethrownError(node)) {
|
|
return;
|
|
}
|
|
const type = services.getTypeAtLocation(node);
|
|
if ((0, util_1.typeMatchesSomeSpecifier)(type, allow, services.program)) {
|
|
return;
|
|
}
|
|
if (tsutils.isTypeFlagSet(type, ts.TypeFlags.Undefined)) {
|
|
context.report({ node, messageId: 'undef' });
|
|
return;
|
|
}
|
|
if (options.allowThrowingAny && (0, util_1.isTypeAnyType)(type)) {
|
|
return;
|
|
}
|
|
if (options.allowThrowingUnknown && (0, util_1.isTypeUnknownType)(type)) {
|
|
return;
|
|
}
|
|
if ((0, util_1.isErrorLike)(services.program, type)) {
|
|
return;
|
|
}
|
|
context.report({ node, messageId: 'object' });
|
|
}
|
|
return {
|
|
ThrowStatement(node) {
|
|
checkThrowArgument(node.argument);
|
|
},
|
|
};
|
|
},
|
|
});
|