@oscarpalmer/atoms 0.171.0 → 0.172.1

package/package.json

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

package/plugin/array/array.exists.plugin.js

@@ -0,0 +1,39 @@
+import {isArrayMethod} from '../helpers.js';
+
+/**
+ * @typedef Plugin
+ * @property {string} name
+ * @property {import('eslint').Rule.RuleModule} value
+ */
+
+const message =
+	"Prefer the use of 'exists()' (@oscarpalmer/atoms) over 'Array.prototype.includes()'";
+
+const methods = new Set(['includes']);
+
+/**
+ * @type {Plugin}
+ */
+export default {
+	name: 'array.exists',
+	value: {
+		create(context) {
+			return {
+				CallExpression(node) {
+					if (isArrayMethod(context, node, methods)) {
+						context.report({
+							message,
+							node,
+						});
+					}
+				},
+			};
+		},
+		meta: {
+			docs: {
+				description: message,
+			},
+			type: 'suggestion',
+		},
+	},
+};

package/plugin/array/array.sort.plugin.js

@@ -0,0 +1,38 @@
+import {isArrayMethod} from '../helpers.js';
+
+/**
+ * @typedef Plugin
+ * @property {string} name
+ * @property {import('eslint').Rule.RuleModule} value
+ */
+
+const message = "Prefer the use of 'sort()' (@oscarpalmer/atoms) over 'Array.prototype.sort()'";
+
+const methods = new Set(['sort']);
+
+/**
+ * @type {Plugin}
+ */
+export default {
+	name: 'array.sort',
+	value: {
+		create(context) {
+			return {
+				CallExpression(node) {
+					if (isArrayMethod(context, node, methods)) {
+						context.report({
+							message,
+							node,
+						});
+					}
+				},
+			};
+		},
+		meta: {
+			docs: {
+				description: message,
+			},
+			type: 'suggestion',
+		},
+	},
+};

package/plugin/helpers.js

@@ -0,0 +1,27 @@
+/**
+ * @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,17 @@
+import arrayExistsPlugin from './array/array.exists.plugin.js';
+import arraySortPlugin from './array/array.sort.plugin.js';
+
+/**
+ * @typedef {import('eslint').Linter.Config} ESLintConfig
+ */
+export default {
+	configs: {},
+	meta: {
+		name: '@oscarpalmer/atoms',
+		version: '1.0.0',
+	},
+	rules: {
+		[arrayExistsPlugin.name]: arrayExistsPlugin.value,
+		[arraySortPlugin.name]: arraySortPlugin.value,
+	},
+};

package/src/is.ts

@@ -1,7 +1,6 @@
 import {getArray} from './array/get';
 import {isNumber} from './internal/is';
 import {getString} from './internal/string';
-import type {Primitive} from './models';
 
 // #region Functions