@oscarpalmer/atoms 0.172.0 → 0.172.2

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@oscarpalmer/atoms",
-	"version": "0.172.0",
+	"version": "0.172.2",
 	"description": "Atomic utilities for making your JavaScript better.",
 	"keywords": [
 		"helper",
@@ -17,6 +17,7 @@
 	},
 	"files": [
 		"dist",
+		"plugin",
 		"src"
 	],
 	"type": "module",

package/plugin/array.js

@@ -0,0 +1,22 @@
+import {getPlugin, isArrayMethod} from './helpers.js';
+
+export default [
+	getPlugin(
+		{
+			full: 'array.exists',
+			short: 'exists',
+		},
+		new Set(['includes']),
+		isArrayMethod,
+		'Array.prototype',
+	),
+	getPlugin(
+		{
+			full: 'array.sort',
+			short: 'sort',
+		},
+		new Set(['sort']),
+		isArrayMethod,
+		'Array.prototype',
+	),
+];

package/plugin/helpers.js

@@ -0,0 +1,112 @@
+/**
+ * @typedef Name
+ * @property {string} full
+ * @property {string} short
+ */
+
+/**
+ * @typedef Plugin
+ * @property {string} message
+ * @property {string} name
+ * @property {string} selector
+ * @property {import('eslint').Rule.RuleModule} value
+ */
+
+/**
+ * @typedef Validator
+ * @param {import('eslint').Rule.RuleContext} context
+ * @param {import('estree').CallExpression & import('eslint').Rule.NodeParentExtension} node
+ * @param {Set<string>} methods
+ * @returns {boolean}
+ */
+
+/**
+ * @param {Set<string>} methods
+ * @param {string|undefined} prefix
+ * @returns {string}
+ */
+function getMethodNames(methods, prefix) {
+	const array = [...methods];
+	const {length} = array;
+
+	let names = '';
+
+	for (let index = 0; index < length; index += 1) {
+		const method = array[index];
+
+		const name = prefix == null ? method : `${prefix}.${method}`;
+
+		if (index === 0) {
+			names = `'${name}'`;
+		} else {
+			names += index === length - 1 ? `, and '${name}'` : `, '${name}'`;
+		}
+	}
+
+	return names;
+}
+
+/**
+ * @param {Name} name
+ * @param {Set<string>} methods
+ * @param {Validator} validator
+ * @param {string|undefined} prefix
+ * @returns {Plugin}
+ */
+export function getPlugin(name, methods, validator, prefix) {
+	const message = `Prefer using '${name.short}' (@oscarpalmer/atoms) instead of ${getMethodNames(methods, prefix)}`;
+
+	return {
+		message,
+		name: name.full,
+		selector: `CallExpression[callee.type="${memberExpression}"][callee.object.type="${arrayExpression}"][callee.property.type="${identifierType}"]`,
+		value: {
+			create(context) {
+				return {
+					CallExpression(node) {
+						if (validator(context, node, methods)) {
+							context.report({
+								message,
+								node,
+							});
+						}
+					},
+				};
+			},
+			meta: {
+				docs: {
+					description: message,
+				},
+				type: 'suggestion',
+			},
+		},
+	};
+}
+
+/**
+ * @param {import('eslint').Rule.RuleContext} context
+ * @param {import('estree').CallExpression & import('eslint').Rule.NodeParentExtension} node
+ * @param {Set<string>} methods
+ * @returns {boolean}
+ */
+export function isArrayMethod(context, node, methods) {
+	const {callee} = node;
+
+	if (callee.type !== memberExpression) {
+		return false;
+	}
+
+	const {object, property} = callee;
+
+	return (
+		object.type === arrayExpression &&
+		property.type === identifierType &&
+		methods.has(property.name)
+	);
+}
+
+const arrayExpression = 'ArrayExpression';
+
+const memberExpression = 'MemberExpression';
+
+const identifierType = 'Identifier';

package/plugin/index.js

@@ -0,0 +1,16 @@
+import {groupBy} from '../dist/array/group-by.mjs';
+import array from './array.js';
+
+/**
+ * @typedef {import('eslint').Linter.Config} ESLintConfig
+ */
+export default {
+	configs: {},
+	meta: {
+		name: '@oscarpalmer/atoms',
+		version: '1.0.0',
+	},
+	rules: {
+		...groupBy(array, 'name', 'value'),
+	},
+};