jest-preset-stylelint 6.3.2 → 7.0.1

package/README.md

@@ -22,16 +22,21 @@ Add the preset to your `jest.config.js` or `jest` field in `package.json`:
 }
 ```
 
+### Adjust setup globally
+
 Optionally, you can avoid specifying `plugins` in every schema by defining your own setup file to configure the `testRule`/`testRuleConfigs` functions.
 This is useful if you have many tests. There are two additional steps to do this:
 
 1. Create `jest.setup.js` in the root of your project. Provide `plugins` option to `getTestRule`/`getTestRuleConfigs`:
 
    ```js
-   const { getTestRule, getTestRuleConfigs } = require("jest-preset-stylelint");
+   import { getTestRule, getTestRuleConfigs } from "jest-preset-stylelint";
+   import myPlugin from "./my-plugin.js";
+
+   const plugins = [myPlugin];
 
-   global.testRule = getTestRule({ plugins: ["./"] });
-   global.testRuleConfigs = getTestRuleConfigs({ plugins: ["./"] });
+   global.testRule = getTestRule({ plugins });
+   global.testRuleConfigs = getTestRuleConfigs({ plugins });
    ```
 
 2. Add `jest.setup.js` to your `jest.config.js` or `jest` field in `package.json`:
@@ -39,10 +44,21 @@ This is useful if you have many tests. There are two additional steps to do this
    ```json
    {
      "preset": "jest-preset-stylelint",
-     "setupFiles": ["jest.setup.js"]
+     "setupFiles": ["<rootDir>/jest.setup.js"]
    }
    ```
 
+### Prevent segmentation fault
+
+If you get a segmentation fault while running the preset on Node.js 18, you can use [jest-light-runner](https://www.npmjs.com/package/jest-light-runner):
+
+```json
+{
+  "preset": "jest-preset-stylelint",
+  "runner": "jest-light-runner"
+}
+```
+
 ## Usage
 
 This preset exposes the following global functions as a helper.
@@ -57,10 +73,16 @@ For example, we can test a plugin that enforces and autofixes kebab-case class s
 
 ```js
 // my-plugin.test.js
-const { messages, ruleName } = require(".");
+import myPlugin from "./my-plugin.js";
+
+const plugins = [myPlugin];
+const {
+  ruleName,
+  rule: { messages }
+} = myPlugin;
 
 testRule({
-  plugins: ["."],
+  plugins,
   ruleName,
   config: [true, { type: "kebab" }],
   fix: true,
@@ -120,7 +142,7 @@ For example:
 
 ```js
 testRuleConfigs({
-  plugins: ["."],
+  plugins,
   ruleName,
 
   accept: [

package/getTestRule.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const util = require('util');
+const { inspect } = require('node:util');
 
 /**
  * @typedef {import('.').TestCase} TestCase
@@ -11,9 +11,11 @@ const util = require('util');
 module.exports = function getTestRule(options = {}) {
 	return function testRule(schema) {
 		const loadLint =
-			schema.loadLint || options.loadLint || (() => Promise.resolve(require('stylelint').lint)); // eslint-disable-line n/no-unpublished-require -- Avoid auto-install of `stylelint` peer dependency.
+			schema.loadLint ||
+			options.loadLint ||
+			(() => import('stylelint').then((m) => m.default.lint)); // eslint-disable-line n/no-unpublished-import -- Avoid auto-install of `stylelint` peer dependency.
 
-		/** @type {import('stylelint').lint} */
+		/** @type {import('stylelint').PublicApi['lint']} */
 		let lint;
 
 		beforeAll(async () => {
@@ -177,8 +179,8 @@ function setupTestCases({ name, cases, schema, comparisons }) {
 				if (testCase) {
 					const spec = testCase.only ? it.only : testCase.skip ? it.skip : it;
 
-					describe(`${util.inspect(schema.config)}`, () => {
-						describe(`${util.inspect(testCase.code)}`, () => {
+					describe(`${inspect(schema.config)}`, () => {
+						describe(`${inspect(testCase.code)}`, () => {
 							spec(testCase.description || 'no description', comparisons(testCase));
 						});
 					});

package/getTestRuleConfigs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { inspect } = require('util');
+const { inspect } = require('node:util');
 
 /** @type {import('.').getTestRuleConfigs} */
 module.exports = function getTestRuleConfigs(options = {}) {
@@ -18,9 +18,9 @@ module.exports = function getTestRuleConfigs(options = {}) {
 		}
 
 		const loadLint =
-			schemaLoadLint || options.loadLint || (() => Promise.resolve(require('stylelint').lint)); // eslint-disable-line n/no-unpublished-require -- Avoid auto-install of `stylelint` peer dependency.
+			schemaLoadLint || options.loadLint || (() => import('stylelint').then((m) => m.default.lint)); // eslint-disable-line n/no-unpublished-import -- Avoid auto-install of `stylelint` peer dependency.
 
-		/** @type {import('stylelint').lint} */
+		/** @type {import('stylelint').PublicApi['lint']} */
 		let lint;
 
 		beforeAll(async () => {

package/index.d.ts

@@ -115,7 +115,7 @@ export type TestSchema = {
 	 *
 	 * @see https://stylelint.io/user-guide/configure#plugins
 	 */
-	plugins?: string | string[];
+	plugins?: import('stylelint').Config['plugins'];
 
 	/**
 	 * Maps to Stylelint's `customSyntax` option.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-preset-stylelint",
-  "version": "6.3.2",
+  "version": "7.0.1",
   "description": "Jest preset for Stylelint plugins.",
   "keywords": [
     "stylelint",
@@ -9,6 +9,16 @@
     "preset"
   ],
   "repository": "stylelint/jest-preset-stylelint",
+  "funding": [
+    {
+      "type": "opencollective",
+      "url": "https://opencollective.com/stylelint"
+    },
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/stylelint"
+    }
+  ],
   "license": "MIT",
   "author": "stylelint",
   "main": "index.js",
@@ -30,9 +40,9 @@
     "lint:types": "tsc",
     "release": "np --no-release-draft",
     "pretest": "npm run lint",
-    "test": "jest",
-    "watch": "jest --watch",
-    "prepare": "husky install"
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "watch": "npm --ignore-scripts test -- --watch",
+    "prepare": "husky"
   },
   "lint-staged": {
     "*.js": "eslint --cache --fix",
@@ -58,29 +68,31 @@
   },
   "jest": {
     "preset": "./jest-preset.js",
-    "testRegex": ".*\\.test\\.js$"
+    "runner": "jest-light-runner",
+    "testRegex": ".*\\.test\\.m?js$"
   },
   "devDependencies": {
     "@stylelint/prettier-config": "^3.0.0",
-    "@stylelint/remark-preset": "^5.0.0",
-    "@types/jest": "^29.5.6",
-    "eslint": "^8.52.0",
-    "eslint-config-stylelint": "^20.0.0",
-    "eslint-plugin-jest": "^27.6.0",
-    "husky": "^8.0.3",
+    "@stylelint/remark-preset": "^5.1.0",
+    "@types/jest": "^29.5.12",
+    "eslint": "^8.57.0",
+    "eslint-config-stylelint": "^21.0.0",
+    "eslint-plugin-jest": "^28.5.0",
+    "husky": "^9.0.11",
     "jest": "^29.7.0",
-    "lint-staged": "^14.0.1",
-    "np": "^8.0.4",
+    "jest-light-runner": "^0.6.0",
+    "lint-staged": "^15.2.5",
+    "np": "^10.0.5",
     "npm-run-all": "^4.1.5",
-    "prettier": "^3.0.3",
-    "remark-cli": "^12.0.0",
-    "stylelint": "^15.11.0",
-    "typescript": "^5.2.2"
+    "prettier": "^3.3.0",
+    "remark-cli": "^12.0.1",
+    "stylelint": "^16.6.1",
+    "typescript": "^5.4.5"
   },
   "peerDependencies": {
     "jest": "^29.0.2"
   },
   "engines": {
-    "node": "^14.15.0 || >=16.10.0"
+    "node": ">=18.12.0"
   }
 }