Convert to ESM

.eslintrc.json

@@ -9,8 +9,20 @@
 		"es6": true,
 		"jest": true
 	},
+	"parserOptions": {
+		"sourceType": "module",
+		"ecmaVersion": "latest"
+	},
 	"globals": {
 		"testConfig": true,
 		"testRule": true
+	},
+	"rules": {
+		"import/extensions": ["error", "always", { "ignorePackages": true } ],
+		"import/no-default-export": "error",
+		"import/no-useless-path-segments": ["warn", { "commonjs": false, "noUselessIndex": false }],
+		"import/prefer-default-export": "off",
+		"unicorn/prefer-module": "error",
+		"unicorn/prefer-node-protocol": "error"
 	}
 }

index.js

@@ -1,9 +1,10 @@
-const { createPlugin } = require('stylelint');
-const { namespace } = require('./utils');
-const rules = require('./rules');
+import stylelint from 'stylelint';
+import { rules } from './rules/index.js';
+import { namespace } from './utils/namespace.js';
 
 const rulesPlugins = Object.keys(rules).map((ruleName) => {
-	return createPlugin(namespace(ruleName), rules[ruleName]);
+	return stylelint.createPlugin(namespace(ruleName), rules[ruleName]);
 });
 
-module.exports = rulesPlugins;
+// eslint-disable-next-line import/no-default-export
+export default rulesPlugins;

jest-setup.js

@@ -1,6 +1,6 @@
-const stylelint = require('stylelint');
+import stylelint from 'stylelint';
 // eslint-disable-next-line import/no-extraneous-dependencies
-const getTestRule = require('jest-preset-stylelint/getTestRule');
+import { getTestRule } from 'jest-preset-stylelint';
 
 global.testRule = getTestRule({ plugins: ['./'] });
 
@@ -27,7 +27,6 @@ global.testConfig = (input) => {
 			.lint({
 				code: '',
 				config,
-				quietDeprecationWarnings: true,
 			})
 			.then((data) => {
 				const { invalidOptionWarnings } = data.results[0];

package.json

@@ -19,13 +19,17 @@
 		"index.js",
 		"!.DS_Store"
 	],
-	"main": "index.js",
+	"type": "module",
+	"exports": "./index.js",
+	"engines": {
+		"node": ">=18.12.0"
+	},
 	"dependencies": {
 		"postcss": "^8.4.38",
 		"postcss-sorting": "^8.0.2"
 	},
 	"peerDependencies": {
-		"stylelint": "^14.0.0 || ^15.0.0 || ^16.0.1"
+		"stylelint": "^16.3.1"
 	},
 	"devDependencies": {
 		"eslint": "^8.55.0",
@@ -46,9 +50,9 @@
 	},
 	"scripts": {
 		"lint": "eslint . --max-warnings=0 && prettier '**/*.js' --check",
-		"test": "jest",
-		"watch": "jest --watch",
-		"coverage": "jest --coverage",
+		"test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+		"watch": "npm run test -- --watch",
+		"coverage": "npm run test -- --coverage",
 		"fix": "eslint . --fix --max-warnings=0 && prettier '**/*.js' --write",
 		"prepare": "husky"
 	},

rules/checkAlphabeticalOrder.js

@@ -1,13 +1,13 @@
-const shorthandData = require('./shorthandData');
-const { vendor } = require('../utils');
+import { shorthandData } from './shorthandData.js';
+import * as vendor from '../utils/vendor.js';
 
 function isShorthand(a, b) {
 	const longhands = shorthandData[a] || [];
 
 	return longhands.includes(b);
 }
 
-module.exports = function checkAlphabeticalOrder(firstPropData, secondPropData) {
+export function checkAlphabeticalOrder(firstPropData, secondPropData) {
 	// OK if the first is shorthand for the second:
 	if (isShorthand(firstPropData.unprefixedName, secondPropData.unprefixedName)) {
 		return true;
@@ -32,4 +32,4 @@ module.exports = function checkAlphabeticalOrder(firstPropData, secondPropData)
 	}
 
 	return firstPropData.unprefixedName < secondPropData.unprefixedName;
-};
+}

rules/index.js

@@ -1,5 +1,9 @@
-module.exports = {
-	order: require('./order'),
-	'properties-order': require('./properties-order'),
-	'properties-alphabetical-order': require('./properties-alphabetical-order'),
+import { rule as order } from './order/index.js';
+import { rule as propertiesOrder } from './properties-order/index.js';
+import { rule as propertiesAlphabeticalOrder } from './properties-alphabetical-order/index.js';
+
+export const rules = {
+	order,
+	'properties-order': propertiesOrder,
+	'properties-alphabetical-order': propertiesAlphabeticalOrder,
 };

rules/order/calcAtRulePatternPriority.js

@@ -1,4 +1,4 @@
-module.exports = function calcAtRulePatternPriority(pattern, node) {
+export function calcAtRulePatternPriority(pattern, node) {
 	// 0 — it pattern doesn't match
 	// 1 — pattern without `name` and `hasBlock`
 	// 10010 — pattern match `hasBlock`
@@ -57,4 +57,4 @@ module.exports = function calcAtRulePatternPriority(pattern, node) {
 	}
 
 	return priority;
-};
+}

rules/order/calcRulePatternPriority.js

@@ -1,4 +1,4 @@
-module.exports = function calcRulePatternPriority(pattern, node) {
+export function calcRulePatternPriority(pattern, node) {
 	// 0 — it pattern doesn't match
 	// 1 — pattern without `selector`
 	// 2 — pattern match `selector`
@@ -16,4 +16,4 @@ module.exports = function calcRulePatternPriority(pattern, node) {
 	}
 
 	return priority;
-};
+}

rules/order/checkNode.js

@@ -1,18 +1,11 @@
-const stylelint = require('stylelint');
-const sortNode = require('postcss-sorting/lib/order/sortNode');
-const checkOrder = require('./checkOrder');
-const getOrderData = require('./getOrderData');
-const ruleName = require('./ruleName');
-const messages = require('./messages');
-
-module.exports = function checkNode({
-	node,
-	isFixEnabled,
-	orderInfo,
-	primaryOption,
-	result,
-	unspecified,
-}) {
+import stylelint from 'stylelint';
+import sortNode from 'postcss-sorting/lib/order/sortNode.js';
+import { checkOrder } from './checkOrder.js';
+import { getOrderData } from './getOrderData.js';
+import { ruleName } from './ruleName.js';
+import { messages } from './messages.js';
+
+export function checkNode({ node, isFixEnabled, orderInfo, primaryOption, result, unspecified }) {
 	if (isFixEnabled) {
 		let shouldFix = false;
 		let allNodesData = [];
@@ -104,4 +97,4 @@ module.exports = function checkNode({
 			previousNodeData,
 		};
 	}
-};
+}

rules/order/checkOrder.js

@@ -1,9 +1,9 @@
-let stylelint = require('stylelint');
-let ruleName = require('./ruleName');
-let messages = require('./messages');
+import stylelint from 'stylelint';
+import { ruleName } from './ruleName.js';
+import { messages } from './messages.js';
 
 // eslint-disable-next-line max-params, consistent-return
-module.exports = function checkOrder({
+export function checkOrder({
 	firstNodeData,
 	secondNodeData,
 	allNodesData,
@@ -75,4 +75,4 @@ module.exports = function checkOrder({
 	if (unspecified === 'bottom' && !firstNodeIsSpecified) {
 		return false;
 	}
-};
+}

rules/order/createOrderInfo.js

@@ -1,7 +1,7 @@
-const getDescription = require('./getDescription');
-const { isString } = require('../../utils/validateType');
+import { getDescription } from './getDescription.js';
+import { isString } from '../../utils/validateType.js';
 
-module.exports = function createOrderInfo(input) {
+export function createOrderInfo(input) {
 	let order = {};
 	let expectedPosition = 0;
 
@@ -85,4 +85,4 @@ module.exports = function createOrderInfo(input) {
 	});
 
 	return order;
-};
+}

rules/order/getDescription.js

@@ -1,6 +1,6 @@
-const { isObject } = require('../../utils/validateType');
+import { isObject } from '../../utils/validateType.js';
 
-module.exports = function getDescription(item) {
+export function getDescription(item) {
 	const descriptions = {
 		'custom-properties': 'custom property',
 		'dollar-variables': '$-variable',
@@ -48,4 +48,4 @@ module.exports = function getDescription(item) {
 
 	// Return description for keyword patterns
 	return descriptions[item];
-};
+}

rules/order/getOrderData.js

@@ -1,21 +1,25 @@
-const utils = require('../../utils');
-const calcAtRulePatternPriority = require('./calcAtRulePatternPriority');
-const calcRulePatternPriority = require('./calcRulePatternPriority');
-const getDescription = require('./getDescription');
-
-module.exports = function getOrderData(orderInfo, node) {
+import { calcAtRulePatternPriority } from './calcAtRulePatternPriority.js';
+import { calcRulePatternPriority } from './calcRulePatternPriority.js';
+import { getDescription } from './getDescription.js';
+import { isAtVariable } from '../../utils/isAtVariable.js';
+import { isCustomProperty } from '../../utils/isCustomProperty.js';
+import { isDollarVariable } from '../../utils/isDollarVariable.js';
+import { isLessMixin } from '../../utils/isLessMixin.js';
+import { isStandardSyntaxProperty } from '../../utils/isStandardSyntaxProperty.js';
+
+export function getOrderData(orderInfo, node) {
 	let nodeType;
 
-	if (utils.isAtVariable(node)) {
+	if (isAtVariable(node)) {
 		nodeType = 'at-variables';
-	} else if (utils.isLessMixin(node)) {
+	} else if (isLessMixin(node)) {
 		nodeType = 'less-mixins';
 	} else if (node.type === 'decl') {
-		if (utils.isCustomProperty(node.prop)) {
+		if (isCustomProperty(node.prop)) {
 			nodeType = 'custom-properties';
-		} else if (utils.isDollarVariable(node.prop)) {
+		} else if (isDollarVariable(node.prop)) {
 			nodeType = 'dollar-variables';
-		} else if (utils.isStandardSyntaxProperty(node.prop)) {
+		} else if (isStandardSyntaxProperty(node.prop)) {
 			nodeType = 'declarations';
 		}
 	} else if (node.type === 'rule') {
@@ -89,4 +93,4 @@ module.exports = function getOrderData(orderInfo, node) {
 	return {
 		description: getDescription(nodeType),
 	};
-};
+}

rules/order/index.js

@@ -1,12 +1,13 @@
-const stylelint = require('stylelint');
-const { getContainingNode, isRuleWithNodes } = require('../../utils');
-const checkNode = require('./checkNode');
-const createOrderInfo = require('./createOrderInfo');
-const validatePrimaryOption = require('./validatePrimaryOption');
-const ruleName = require('./ruleName');
-const messages = require('./messages');
+import stylelint from 'stylelint';
+import { getContainingNode } from '../../utils/getContainingNode.js';
+import { isRuleWithNodes } from '../../utils/isRuleWithNodes.js';
+import { checkNode } from './checkNode.js';
+import { createOrderInfo } from './createOrderInfo.js';
+import { validatePrimaryOption } from './validatePrimaryOption.js';
+import { ruleName } from './ruleName.js';
+import { messages } from './messages.js';
 
-function rule(primaryOption, options = {}, context = {}) {
+export function rule(primaryOption, options = {}, context = {}) {
 	return function ruleBody(root, result) {
 		let validOptions = stylelint.utils.validateOptions(
 			result,
@@ -61,5 +62,3 @@ function rule(primaryOption, options = {}, context = {}) {
 rule.ruleName = ruleName;
 rule.messages = messages;
 rule.primaryOptionArray = true;
-
-module.exports = rule;

rules/order/messages.js

@@ -1,6 +1,6 @@
-const stylelint = require('stylelint');
-const ruleName = require('./ruleName');
+import stylelint from 'stylelint';
+import { ruleName } from './ruleName.js';
 
-module.exports = stylelint.utils.ruleMessages(ruleName, {
+export const messages = stylelint.utils.ruleMessages(ruleName, {
 	expected: (first, second) => `Expected ${first} to come before ${second}`,
 });

rules/order/ruleName.js

@@ -1,3 +1,3 @@
-const { namespace } = require('../../utils');
+import { namespace } from '../../utils/namespace.js';
 
-module.exports = namespace('order');
+export const ruleName = namespace('order');

rules/order/tests/index.js

@@ -1,4 +1,4 @@
-const rule = require('..');
+import { rule } from '../index.js';
 
 const { ruleName, messages } = rule;
 

rules/order/tests/validate-options.js

@@ -1,4 +1,4 @@
-const { ruleName } = require('..');
+import { ruleName } from '../ruleName.js';
 
 testConfig({
 	ruleName,

rules/order/validatePrimaryOption.js

@@ -1,6 +1,6 @@
-const { isObject, isString } = require('../../utils/validateType');
+import { isObject, isString } from '../../utils/validateType.js';
 
-module.exports = function validatePrimaryOption(actualOptions) {
+export function validatePrimaryOption(actualOptions) {
 	// Otherwise, begin checking array options
 	if (!Array.isArray(actualOptions)) {
 		return false;
@@ -78,7 +78,7 @@ module.exports = function validatePrimaryOption(actualOptions) {
 	}
 
 	return true;
-};
+}
 
 function isRegExp(value) {
 	return Object.prototype.toString.call(value) === '[object RegExp]';

rules/properties-alphabetical-order/checkNode.js

@@ -1,9 +1,11 @@
-let stylelint = require('stylelint');
-let checkAlphabeticalOrder = require('../checkAlphabeticalOrder');
-let { isStandardSyntaxProperty, isCustomProperty, vendor } = require('../../utils');
+import stylelint from 'stylelint';
+import { checkAlphabeticalOrder } from '../checkAlphabeticalOrder.js';
+import { isCustomProperty } from '../../utils/isCustomProperty.js';
+import { isStandardSyntaxProperty } from '../../utils/isStandardSyntaxProperty.js';
+import * as vendor from '../../utils/vendor.js';
 
 // eslint-disable-next-line max-params
-module.exports = function checkNode(node, result, ruleName, messages) {
+export function checkNode(node, result, ruleName, messages) {
 	let allPropData = [];
 
 	node.each(function processEveryNode(child) {
@@ -58,4 +60,4 @@ module.exports = function checkNode(node, result, ruleName, messages) {
 			ruleName,
 		});
 	});
-};
+}