Migrate to ESM

hudochenkov · hudochenkov · commit a7171d02cbb0 · 2026-04-29T02:08:46.000+02:00
diff --git a/README.md b/README.md
@@ -86,7 +86,7 @@ npm install postcss postcss-cli postcss-sorting --save-dev
 Create a `postcss.config.js` with PostCSS Sorting configuration:
 
 ```js
-module.exports = {
+export default {
 	plugins: {
 		'postcss-sorting': {
 			order: [
diff --git a/eslint.config.js b/eslint.config.js
@@ -19,4 +19,10 @@ export default [
 			},
 		},
 	},
+	{
+		files: ['eslint.config.js', 'index.js'],
+		rules: {
+			'import/no-default-export': 'off',
+		},
+	},
 ];
diff --git a/index.js b/index.js
@@ -1,19 +1,21 @@
-const validateOptions = require('./lib/validateOptions');
-const isString = require('./lib/isString');
-const getContainingNode = require('./lib/getContainingNode');
-const sortNode = require('./lib/order/sortNode');
-const sortNodeProperties = require('./lib/properties-order/sortNodeProperties');
+import { validateOptions } from './lib/validateOptions.js';
+import { isString } from './lib/isString.js';
+import { getContainingNode } from './lib/getContainingNode.js';
+import { sortNode } from './lib/order/sortNode.js';
+import { sortNodeProperties } from './lib/properties-order/sortNodeProperties.js';
 
-module.exports = function postcssSorting(opts) {
+function postcssSorting(opts) {
 	return {
 		postcssPlugin: 'postcss-sorting',
 		Root(css) {
 			plugin(css, opts);
 		},
 	};
-};
+}
+
+postcssSorting.postcss = true;
 
-module.exports.postcss = true;
+export default postcssSorting;
 
 function plugin(css, opts) {
 	const validatedOptions = validateOptions(opts);
@@ -56,3 +58,6 @@ function plugin(css, opts) {
 		});
 	}
 }
+
+/** These are not a public API, and could be removed at any point */
+export { sortNode, sortNodeProperties }; // eslint-disable-line unicorn/prefer-export-from
diff --git a/jest-setup.js b/jest-setup.js
@@ -1,9 +1,9 @@
-const fs = require('fs');
-const path = require('path');
-const plugin = require('.');
-const postcss = require('postcss');
-const cssInJS = require('postcss-styled-syntax'); // eslint-disable-line import/no-extraneous-dependencies
-const html = require('postcss-html'); // eslint-disable-line import/no-extraneous-dependencies
+import fs from 'node:fs';
+import path from 'node:path';
+import postcssSorting from './index.js';
+import postcss from 'postcss';
+import cssInJS from 'postcss-styled-syntax'; // eslint-disable-line import/no-extraneous-dependencies
+import html from 'postcss-html'; // eslint-disable-line import/no-extraneous-dependencies
 
 global.groupTest = function groupTest(testGroups) {
 	testGroups.forEach((group) => {
@@ -15,7 +15,7 @@ global.groupTest = function groupTest(testGroups) {
 			const testFn = item.only ? test.only : test;
 
 			testFn(message, () =>
-				postcss(plugin(group.options))
+				postcss(postcssSorting(group.options))
 					.process(item.fixture, { from: undefined })
 					.then((root) => {
 						expect(root.css).toEqual(item.expected);
@@ -64,7 +64,7 @@ global.runTest = function runTest(input, opts, dirname) {
 		syntax = html;
 	}
 
-	return postcss([plugin(opts)])
+	return postcss([postcssSorting(opts)])
 		.process(inputCSS, {
 			from: inputPath,
 			syntax,
diff --git a/lib/__tests__/test.js b/lib/__tests__/test.js
@@ -1,5 +1,7 @@
-const plugin = require('../..');
-const postcss = require('postcss');
+import postcssSorting from '../../index.js';
+import postcss from 'postcss';
+
+const __dirname = import.meta.dirname;
 
 test(`Should do nothing if config is undefined`, () => {
 	runTest('empty-lines-preserve', undefined, __dirname);
@@ -11,7 +13,7 @@ test(`Should throw an error if config has error`, () => {
 		order: 'Justice Rains From Above',
 	};
 
-	return expect(postcss([plugin(opts)]).process('', { from: undefined })).rejects.toThrow(
+	return expect(postcss([postcssSorting(opts)]).process('', { from: undefined })).rejects.toThrow(
 		'postcss-sorting: order: Should be an array',
 	);
 });
diff --git a/lib/__tests__/validate-options.js b/lib/__tests__/validate-options.js
@@ -1,4 +1,4 @@
-const validateOptions = require('../validateOptions');
+import { validateOptions } from '../validateOptions.js';
 
 function testConfig(input) {
 	let testFn;
diff --git a/lib/getComments.js b/lib/getComments.js
@@ -1,12 +1,5 @@
-module.exports = {
-	beforeNode,
-	afterNode,
-	beforeDeclaration,
-	afterDeclaration,
-};
-
 // eslint-disable-next-line max-params
-function beforeNode(comments, previousNode, node, currentInitialIndex) {
+export function beforeNode(comments, previousNode, node, currentInitialIndex) {
 	if (!previousNode || previousNode.type !== 'comment') {
 		return comments;
 	}
@@ -29,7 +22,7 @@ function beforeNode(comments, previousNode, node, currentInitialIndex) {
 }
 
 // eslint-disable-next-line max-params
-function afterNode(comments, nextNode, node, currentInitialIndex) {
+export function afterNode(comments, nextNode, node, currentInitialIndex) {
 	if (!nextNode || nextNode.type !== 'comment') {
 		return comments;
 	}
@@ -47,7 +40,7 @@ function afterNode(comments, nextNode, node, currentInitialIndex) {
 }
 
 // eslint-disable-next-line max-params
-function beforeDeclaration(comments, previousNode, nodeData, currentInitialIndex) {
+export function beforeDeclaration(comments, previousNode, nodeData, currentInitialIndex) {
 	if (!previousNode || previousNode.type !== 'comment') {
 		return comments;
 	}
@@ -73,7 +66,7 @@ function beforeDeclaration(comments, previousNode, nodeData, currentInitialIndex
 }
 
 // eslint-disable-next-line max-params
-function afterDeclaration(comments, nextNode, nodeData, currentInitialIndex) {
+export function afterDeclaration(comments, nextNode, nodeData, currentInitialIndex) {
 	if (!nextNode || nextNode.type !== 'comment') {
 		return comments;
 	}
diff --git a/lib/getContainingNode.js b/lib/getContainingNode.js
@@ -1,4 +1,4 @@
-module.exports = function getContainingNode(node) {
+export function getContainingNode(node) {
 	if (node.type === 'rule' || node.type === 'atrule') {
 		return node;
 	}
@@ -14,4 +14,4 @@ module.exports = function getContainingNode(node) {
 	}
 
 	return node;
-};
+}
diff --git a/lib/isAllowedToProcess.js b/lib/isAllowedToProcess.js
@@ -1,6 +1,6 @@
 const atRuleExcludes = ['function', 'if', 'else', 'for', 'each', 'while'];
 
-module.exports = function isAllowedToProcess(node, options) {
+export function isAllowedToProcess(node, options) {
 	if (node.type === 'atrule' && atRuleExcludes.includes(node.name)) {
 		return false;
 	}
@@ -24,4 +24,4 @@ module.exports = function isAllowedToProcess(node, options) {
 	}
 
 	return true;
-};
+}
diff --git a/lib/isCustomProperty.js b/lib/isCustomProperty.js
@@ -1,3 +1,3 @@
-module.exports = function isCustomProperty(property) {
+export function isCustomProperty(property) {
 	return property.slice(0, 2) === '--';
-};
+}
diff --git a/lib/isStandardSyntaxProperty.js b/lib/isStandardSyntaxProperty.js
@@ -1,4 +1,4 @@
-module.exports = function isStandardSyntaxProperty(property) {
+export function isStandardSyntaxProperty(property) {
 	// SCSS var (e.g. $var: x), list (e.g. $list: (x)) or map (e.g. $map: (key:value))
 	if (property[0] === '$') {
 		return false;
@@ -15,4 +15,4 @@ module.exports = function isStandardSyntaxProperty(property) {
 	}
 
 	return true;
-};
+}
diff --git a/lib/isString.js b/lib/isString.js
@@ -1,3 +1,3 @@
-module.exports = function isString(str) {
+export function isString(str) {
 	return str && typeof str.valueOf() === 'string';
-};
+}
diff --git a/lib/order/__tests__/order.js b/lib/order/__tests__/order.js
@@ -1,3 +1,5 @@
+const __dirname = import.meta.dirname;
+
 const config = {
 	order: ['declarations', 'rules'],
 };
diff --git a/lib/order/calcAtRulePatternPriority.js b/lib/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;
-};
+}
diff --git a/lib/order/calcRulePatternPriority.js b/lib/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;
-};
+}
diff --git a/lib/order/createExpectedOrder.js b/lib/order/createExpectedOrder.js
@@ -1,6 +1,6 @@
-const isString = require('../isString');
+import { isString } from '../isString.js';
 
-module.exports = function createExpectedOrder(input) {
+export function createExpectedOrder(input) {
 	const order = {};
 	let position = 0;
 
@@ -81,4 +81,4 @@ module.exports = function createExpectedOrder(input) {
 	});
 
 	return order;
-};
+}
diff --git a/lib/order/getOrderData.js b/lib/order/getOrderData.js
@@ -1,11 +1,11 @@
-const isStandardSyntaxProperty = require('../isStandardSyntaxProperty');
-const isCustomProperty = require('../isCustomProperty');
-const isDollarVariable = require('./isDollarVariable');
-const isAtVariable = require('./isAtVariable');
-const calcAtRulePatternPriority = require('./calcAtRulePatternPriority');
-const calcRulePatternPriority = require('./calcRulePatternPriority');
-
-module.exports = function getOrderData(expectedOrder, node) {
+import { isStandardSyntaxProperty } from '../isStandardSyntaxProperty.js';
+import { isCustomProperty } from '../isCustomProperty.js';
+import { isDollarVariable } from './isDollarVariable.js';
+import { isAtVariable } from './isAtVariable.js';
+import { calcAtRulePatternPriority } from './calcAtRulePatternPriority.js';
+import { calcRulePatternPriority } from './calcRulePatternPriority.js';
+
+export function getOrderData(expectedOrder, node) {
 	let nodeType;
 
 	if (isAtVariable(node)) {
@@ -87,4 +87,4 @@ module.exports = function getOrderData(expectedOrder, node) {
 
 	// Return null if there no patterns for that node
 	return null;
-};
+}
diff --git a/lib/order/isAtVariable.js b/lib/order/isAtVariable.js
@@ -2,6 +2,6 @@
  * Check whether a property is a @-variable (Less)
  */
 
-module.exports = function isAtVariable(node) {
+export function isAtVariable(node) {
 	return node.type === 'atrule' && node.variable;
-};
+}
diff --git a/lib/order/isDollarVariable.js b/lib/order/isDollarVariable.js
@@ -1,3 +1,3 @@
-module.exports = function isDollarVariable(property) {
+export function isDollarVariable(property) {
 	return property[0] === '$';
-};
+}
diff --git a/lib/order/processLastComments.js b/lib/order/processLastComments.js
@@ -1,4 +1,4 @@
-module.exports = function processLastComments(node, index, processedNodes) {
+export function processLastComments(node, index, processedNodes) {
 	if (node.type === 'comment' && !node.hasOwnProperty('position')) {
 		node.position = Infinity;
 		node.initialIndex = index;
@@ -7,4 +7,4 @@ module.exports = function processLastComments(node, index, processedNodes) {
 	}
 
 	return processedNodes;
-};
+}
diff --git a/lib/order/processMostNodes.js b/lib/order/processMostNodes.js
@@ -1,8 +1,8 @@
-const getOrderData = require('./getOrderData');
-const getComments = require('../getComments');
+import { getOrderData } from './getOrderData.js';
+import { beforeNode, afterNode } from '../getComments.js';
 
 // eslint-disable-next-line max-params
-module.exports = function processMostNodes(node, index, order, processedNodes) {
+export function processMostNodes(node, index, order, processedNodes) {
 	if (node.type === 'comment') {
 		return processedNodes;
 	}
@@ -13,10 +13,10 @@ module.exports = function processMostNodes(node, index, order, processedNodes) {
 	node.initialIndex = index;
 
 	// If comment on separate line before node, use node's indexes for comment
-	const commentsBefore = getComments.beforeNode([], node.prev(), node);
+	const commentsBefore = beforeNode([], node.prev(), node);
 
 	// If comment on same line with the node and node, use node's indexes for comment
-	const commentsAfter = getComments.afterNode([], node.next(), node);
+	const commentsAfter = afterNode([], node.next(), node);
 
 	return [...processedNodes, ...commentsBefore, node, ...commentsAfter];
-};
+}
diff --git a/lib/order/sortByIndexes.js b/lib/order/sortByIndexes.js
@@ -1,4 +1,4 @@
-module.exports = function sortByIndexes(a, b) {
+export function sortByIndexes(a, b) {
 	// If a and b have the same group index, and a's property index is
 	// higher than b's property index, in a sorted list a appears after
 	// b:
@@ -10,4 +10,4 @@ module.exports = function sortByIndexes(a, b) {
 	// in a sorted list they appear in the same order they were in
 	// original array:
 	return a.initialIndex - b.initialIndex;
-};
+}
diff --git a/lib/order/sortNode.js b/lib/order/sortNode.js
@@ -1,10 +1,10 @@
-const createExpectedOrder = require('./createExpectedOrder');
-const isAllowedToProcess = require('../isAllowedToProcess');
-const processLastComments = require('./processLastComments');
-const processMostNodes = require('./processMostNodes');
-const sortByIndexes = require('./sortByIndexes');
+import { createExpectedOrder } from './createExpectedOrder.js';
+import { isAllowedToProcess } from '../isAllowedToProcess.js';
+import { processLastComments } from './processLastComments.js';
+import { processMostNodes } from './processMostNodes.js';
+import { sortByIndexes } from './sortByIndexes.js';
 
-module.exports = function sortNode(node, optsOrder) {
+export function sortNode(node, optsOrder) {
 	if (!isAllowedToProcess(node)) {
 		return;
 	}
@@ -33,4 +33,4 @@ module.exports = function sortNode(node, optsOrder) {
 	// Replace rule content with sorted one
 	node.removeAll();
 	node.append(processed);
-};
+}
diff --git a/lib/properties-order/__tests__/isShorthand.test.js b/lib/properties-order/__tests__/isShorthand.test.js
@@ -1,4 +1,4 @@
-const { isShorthand } = require('../isShorthand');
+import { isShorthand } from '../isShorthand.js';
 
 test('margin is shorthand for margin-top', () => {
 	expect(isShorthand('margin', 'margin-top')).toBe(true);
diff --git a/lib/properties-order/__tests__/properties-order.js b/lib/properties-order/__tests__/properties-order.js
@@ -1,3 +1,5 @@
+const __dirname = import.meta.dirname;
+
 test('Should sort properties (array config)', () =>
 	runTest(
 		'properties-simple',
diff --git a/lib/properties-order/__tests__/vendor.test.js b/lib/properties-order/__tests__/vendor.test.js
@@ -1,4 +1,4 @@
-let vendor = require('../vendor');
+import * as vendor from '../vendor.js';
 
 const VALUE = '-1px -1px 1px rgba(0, 0, 0, 0.2) inset';
 
diff --git a/lib/properties-order/createExpectedPropertiesOrder.js b/lib/properties-order/createExpectedPropertiesOrder.js
@@ -1,4 +1,4 @@
-module.exports = function createExpectedPropertiesOrder(input) {
+export function createExpectedPropertiesOrder(input) {
 	const order = {};
 
 	input.forEach((property, propertyIndex) => {
@@ -8,4 +8,4 @@ module.exports = function createExpectedPropertiesOrder(input) {
 	});
 
 	return order;
-};
+}
diff --git a/lib/properties-order/getPropertiesOrderData.js b/lib/properties-order/getPropertiesOrderData.js
diff --git a/lib/properties-order/isShorthand.js b/lib/properties-order/isShorthand.js
diff --git a/lib/properties-order/shorthandData.js b/lib/properties-order/shorthandData.js
diff --git a/lib/properties-order/sortDeclarations.js b/lib/properties-order/sortDeclarations.js
diff --git a/lib/properties-order/sortDeclarationsAlphabetically.js b/lib/properties-order/sortDeclarationsAlphabetically.js
diff --git a/lib/properties-order/sortNodeProperties.js b/lib/properties-order/sortNodeProperties.js
diff --git a/lib/properties-order/vendor.js b/lib/properties-order/vendor.js
diff --git a/lib/validateOptions.js b/lib/validateOptions.js
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-const validateOptions = require('../validateOptions');`
	`1`	`+import { validateOptions } from '../validateOptions.js';`
`2`	`2`
`3`	`3`	`function testConfig(input) {`
`4`	`4`	`let testFn;`
Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,5 @@`
`1`		`-module.exports = {`
`2`		`- beforeNode,`
`3`		`- afterNode,`
`4`		`- beforeDeclaration,`
`5`		`- afterDeclaration,`
`6`		`-};`
`7`		`-`
`8`	`1`	`// eslint-disable-next-line max-params`
`9`		`-function beforeNode(comments, previousNode, node, currentInitialIndex) {`
	`2`	`+export function beforeNode(comments, previousNode, node, currentInitialIndex) {`
`10`	`3`	`if (!previousNode \|\| previousNode.type !== 'comment') {`
`11`	`4`	`return comments;`
`12`	`5`	`}`
`@@ -29,7 +22,7 @@ function beforeNode(comments, previousNode, node, currentInitialIndex) {`
`29`	`22`	`}`
`30`	`23`
`31`	`24`	`// eslint-disable-next-line max-params`
`32`		`-function afterNode(comments, nextNode, node, currentInitialIndex) {`
	`25`	`+export function afterNode(comments, nextNode, node, currentInitialIndex) {`
`33`	`26`	`if (!nextNode \|\| nextNode.type !== 'comment') {`
`34`	`27`	`return comments;`
`35`	`28`	`}`
`@@ -47,7 +40,7 @@ function afterNode(comments, nextNode, node, currentInitialIndex) {`
`47`	`40`	`}`
`48`	`41`
`49`	`42`	`// eslint-disable-next-line max-params`
`50`		`-function beforeDeclaration(comments, previousNode, nodeData, currentInitialIndex) {`
	`43`	`+export function beforeDeclaration(comments, previousNode, nodeData, currentInitialIndex) {`
`51`	`44`	`if (!previousNode \|\| previousNode.type !== 'comment') {`
`52`	`45`	`return comments;`
`53`	`46`	`}`
`@@ -73,7 +66,7 @@ function beforeDeclaration(comments, previousNode, nodeData, currentInitialIndex`
`73`	`66`	`}`
`74`	`67`
`75`	`68`	`// eslint-disable-next-line max-params`
`76`		`-function afterDeclaration(comments, nextNode, nodeData, currentInitialIndex) {`
	`69`	`+export function afterDeclaration(comments, nextNode, nodeData, currentInitialIndex) {`
`77`	`70`	`if (!nextNode \|\| nextNode.type !== 'comment') {`
`78`	`71`	`return comments;`
`79`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-module.exports = function getContainingNode(node) {`
	`1`	`+export function getContainingNode(node) {`
`2`	`2`	`if (node.type === 'rule' \|\| node.type === 'atrule') {`
`3`	`3`	`return node;`
`4`	`4`	`}`
`@@ -14,4 +14,4 @@ module.exports = function getContainingNode(node) {`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`return node;`
`17`		`-};`
	`17`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`const atRuleExcludes = ['function', 'if', 'else', 'for', 'each', 'while'];`
`2`	`2`
`3`		`-module.exports = function isAllowedToProcess(node, options) {`
	`3`	`+export function isAllowedToProcess(node, options) {`
`4`	`4`	`if (node.type === 'atrule' && atRuleExcludes.includes(node.name)) {`
`5`	`5`	`return false;`
`6`	`6`	`}`
`@@ -24,4 +24,4 @@ module.exports = function isAllowedToProcess(node, options) {`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`return true;`
`27`		`-};`
	`27`	`+}`