eslint-plugin-unicorn-ts 0.0.1-security → 50.0.1

package/rules/prefer-top-level-await.js

@@ -0,0 +1,152 @@
+'use strict';
+const {findVariable, getFunctionHeadLocation} = require('@eslint-community/eslint-utils');
+const {isFunction, isMemberExpression, isMethodCall} = require('./ast/index.js');
+
+const ERROR_PROMISE = 'promise';
+const ERROR_IIFE = 'iife';
+const ERROR_IDENTIFIER = 'identifier';
+const SUGGESTION_ADD_AWAIT = 'add-await';
+const messages = {
+	[ERROR_PROMISE]: 'Prefer top-level await over using a promise chain.',
+	[ERROR_IIFE]: 'Prefer top-level await over an async IIFE.',
+	[ERROR_IDENTIFIER]: 'Prefer top-level await over an async function `{{name}}` call.',
+	[SUGGESTION_ADD_AWAIT]: 'Insert `await`.',
+};
+
+const promisePrototypeMethods = ['then', 'catch', 'finally'];
+const isTopLevelCallExpression = node => {
+	if (node.type !== 'CallExpression') {
+		return false;
+	}
+
+	for (let ancestor = node.parent; ancestor; ancestor = ancestor.parent) {
+		if (
+			isFunction(ancestor)
+			|| ancestor.type === 'ClassDeclaration'
+			|| ancestor.type === 'ClassExpression'
+		) {
+			return false;
+		}
+	}
+
+	return true;
+};
+
+const isPromiseMethodCalleeObject = node =>
+	node.parent.type === 'MemberExpression'
+	&& node.parent.object === node
+	&& !node.parent.computed
+	&& node.parent.property.type === 'Identifier'
+	&& promisePrototypeMethods.includes(node.parent.property.name)
+	&& node.parent.parent.type === 'CallExpression'
+	&& node.parent.parent.callee === node.parent;
+const isAwaitExpressionArgument = node => {
+	if (node.parent.type === 'ChainExpression') {
+		node = node.parent;
+	}
+
+	return node.parent.type === 'AwaitExpression' && node.parent.argument === node;
+};
+
+// `Promise.{all,allSettled,any,race}([foo()])`
+const isInPromiseMethods = node =>
+	node.parent.type === 'ArrayExpression'
+	&& node.parent.elements.includes(node)
+	&& isMethodCall(node.parent.parent, {
+		object: 'Promise',
+		methods: ['all', 'allSettled', 'any', 'race'],
+		argumentsLength: 1,
+	})
+	&& node.parent.parent.arguments[0] === node.parent;
+
+/** @param {import('eslint').Rule.RuleContext} context */
+function create(context) {
+	if (context.filename.toLowerCase().endsWith('.cjs')) {
+		return;
+	}
+
+	return {
+		CallExpression(node) {
+			if (
+				!isTopLevelCallExpression(node)
+				|| isPromiseMethodCalleeObject(node)
+				|| isAwaitExpressionArgument(node)
+				|| isInPromiseMethods(node)
+			) {
+				return;
+			}
+
+			// Promises
+			if (isMemberExpression(node.callee, {
+				properties: promisePrototypeMethods,
+				computed: false,
+			})) {
+				return {
+					node: node.callee.property,
+					messageId: ERROR_PROMISE,
+				};
+			}
+
+			const {sourceCode} = context;
+
+			// IIFE
+			if (
+				(node.callee.type === 'FunctionExpression' || node.callee.type === 'ArrowFunctionExpression')
+				&& node.callee.async
+				&& !node.callee.generator
+			) {
+				return {
+					node,
+					loc: getFunctionHeadLocation(node.callee, sourceCode),
+					messageId: ERROR_IIFE,
+				};
+			}
+
+			// Identifier
+			if (node.callee.type !== 'Identifier') {
+				return;
+			}
+
+			const variable = findVariable(sourceCode.getScope(node), node.callee);
+			if (!variable || variable.defs.length !== 1) {
+				return;
+			}
+
+			const [definition] = variable.defs;
+			const value = definition.type === 'Variable' && definition.kind === 'const'
+				? definition.node.init
+				: definition.node;
+			if (
+				!value
+				|| !(isFunction(value) && !value.generator && value.async)
+			) {
+				return;
+			}
+
+			return {
+				node,
+				messageId: ERROR_IDENTIFIER,
+				data: {name: node.callee.name},
+				suggest: [
+					{
+						messageId: SUGGESTION_ADD_AWAIT,
+						fix: fixer => fixer.insertTextBefore(node, 'await '),
+					},
+				],
+			};
+		},
+	};
+}
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+	create,
+	meta: {
+		type: 'suggestion',
+		docs: {
+			description: 'Prefer top-level await over top-level promises and async function calls.',
+		},
+		hasSuggestions: true,
+		messages,
+	},
+};

package/rules/prefer-type-error.js

@@ -0,0 +1,151 @@
+'use strict';
+const {isNewExpression} = require('./ast/index.js');
+
+const MESSAGE_ID = 'prefer-type-error';
+const messages = {
+	[MESSAGE_ID]: '`new Error()` is too unspecific for a type check. Use `new TypeError()` instead.',
+};
+
+const typeCheckIdentifiers = new Set([
+	'isArguments',
+	'isArray',
+	'isArrayBuffer',
+	'isArrayLike',
+	'isArrayLikeObject',
+	'isBigInt',
+	'isBoolean',
+	'isBuffer',
+	'isDate',
+	'isElement',
+	'isError',
+	'isFinite',
+	'isFunction',
+	'isInteger',
+	'isLength',
+	'isMap',
+	'isNaN',
+	'isNative',
+	'isNil',
+	'isNull',
+	'isNumber',
+	'isObject',
+	'isObjectLike',
+	'isPlainObject',
+	'isPrototypeOf',
+	'isRegExp',
+	'isSafeInteger',
+	'isSet',
+	'isString',
+	'isSymbol',
+	'isTypedArray',
+	'isUndefined',
+	'isView',
+	'isWeakMap',
+	'isWeakSet',
+	'isWindow',
+	'isXMLDoc',
+]);
+
+const typeCheckGlobalIdentifiers = new Set([
+	'isNaN',
+	'isFinite',
+]);
+
+const isTypecheckingIdentifier = (node, callExpression, isMemberExpression) =>
+	callExpression !== undefined
+	&& callExpression.arguments.length > 0
+	&& node.type === 'Identifier'
+	&& (
+		(isMemberExpression === true && typeCheckIdentifiers.has(node.name))
+		|| (isMemberExpression === false && typeCheckGlobalIdentifiers.has(node.name))
+	);
+
+const isLone = node => node.parent && node.parent.body && node.parent.body.length === 1;
+
+const isTypecheckingMemberExpression = (node, callExpression) => {
+	if (isTypecheckingIdentifier(node.property, callExpression, true)) {
+		return true;
+	}
+
+	if (node.object.type === 'MemberExpression') {
+		return isTypecheckingMemberExpression(node.object, callExpression);
+	}
+
+	return false;
+};
+
+const isTypecheckingExpression = (node, callExpression) => {
+	switch (node.type) {
+		case 'Identifier': {
+			return isTypecheckingIdentifier(node, callExpression, false);
+		}
+
+		case 'MemberExpression': {
+			return isTypecheckingMemberExpression(node, callExpression);
+		}
+
+		case 'CallExpression': {
+			return isTypecheckingExpression(node.callee, node);
+		}
+
+		case 'UnaryExpression': {
+			return (
+				node.operator === 'typeof'
+				|| (node.operator === '!' && isTypecheckingExpression(node.argument))
+			);
+		}
+
+		case 'BinaryExpression': {
+			return (
+				node.operator === 'instanceof'
+				|| isTypecheckingExpression(node.left, callExpression)
+				|| isTypecheckingExpression(node.right, callExpression)
+			);
+		}
+
+		case 'LogicalExpression': {
+			return (
+				isTypecheckingExpression(node.left, callExpression)
+				&& isTypecheckingExpression(node.right, callExpression)
+			);
+		}
+
+		default: {
+			return false;
+		}
+	}
+};
+
+const isTypechecking = node => node.type === 'IfStatement' && isTypecheckingExpression(node.test);
+
+/** @param {import('eslint').Rule.RuleContext} context */
+const create = () => ({
+	ThrowStatement(node) {
+		if (
+			isNewExpression(node.argument, {name: 'Error'})
+			&& isLone(node)
+			&& node.parent.parent
+			&& isTypechecking(node.parent.parent)
+		) {
+			const errorConstructor = node.argument.callee;
+			return {
+				node: errorConstructor,
+				messageId: MESSAGE_ID,
+				fix: fixer => fixer.insertTextBefore(errorConstructor, 'Type'),
+			};
+		}
+	},
+});
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+	create,
+	meta: {
+		type: 'suggestion',
+		docs: {
+			description: 'Enforce throwing `TypeError` in type checking conditions.',
+		},
+		fixable: 'code',
+		messages,
+	},
+};