@jhae/stylelint-config-verifier 1.3.0 → 2.0.0

package/README.md

@@ -134,8 +134,9 @@ new ConfigVerifier().verify('at-rule-disallowed-list', {
 
 ### Specifying the Stylelint configuration file
 
-By default, the config verifier looks for a `.stylelintrc.yaml` configuration file. If a different location or file name
-is used, the path to it can be specified as a constructor argument.
+By default, the Stylelint configuration file is detected automatically as described in
+the [Stylelint documentation](https://stylelint.io/user-guide/configure). If needed, you can override this behavior by
+passing the path to the configuration file to the constructor.
 
 ```javascript
 import { ConfigVerifier } from '@jhae/stylelint-config-verifier';
@@ -143,14 +144,6 @@ import { ConfigVerifier } from '@jhae/stylelint-config-verifier';
 new ConfigVerifier('path/to/stylelint.config.js').verify();
 ```
 
-### Importing into CommonJS
-
-```javascript
-const { ConfigVerifier } = require('@jhae/stylelint-config-verifier');
-
-new ConfigVerifier().verify();
-```
-
 ---
 
 Check out the [Standard SCSS Stylelint Config](https://github.com/jhae-de/stylelint-config-standard-scss) tests for more

package/dist/{esm/config-verifier.js → config-verifier.js}

@@ -43,9 +43,9 @@ export class ConfigVerifier {
     /**
      * Creates a new `ConfigVerifier` object.
      *
-     * @param {string} configFile - The path to the Stylelint config file whose rules should be verified
+     * @param {string | undefined} configFile - The path to the Stylelint config file whose rules should be verified
      */
-    constructor(configFile = '.stylelintrc.yaml') {
+    constructor(configFile) {
         this.configFile = configFile;
     }
     /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jhae/stylelint-config-verifier",
   "description": "A Stylelint configuration tester for Jest that helps you verify your defined rules.",
-  "version": "1.3.0",
+  "version": "2.0.0",
   "license": "MIT",
   "author": {
     "name": "JHAE",
@@ -13,24 +13,24 @@
     "type": "git"
   },
   "type": "module",
-  "main": "./dist/cjs/config-verifier.js",
-  "module": "./dist/esm/config-verifier.js",
-  "types": "./types/index.d.ts",
   "exports": {
     "types": "./types/index.d.ts",
-    "require": "./dist/cjs/config-verifier.js",
-    "default": "./dist/esm/config-verifier.js"
+    "default": "./dist/config-verifier.js"
   },
+  "files": [
+    "./dist/",
+    "./types/"
+  ],
   "scripts": {
     "build": "npm run-script build:package && npm run-script build:types",
     "build:package": "./bin/build-package",
     "build:types": "./bin/build-types",
     "fix": "npm run-script fix:prettier && npm run-script fix:eslint",
     "fix:eslint": "eslint --fix .",
-    "fix:prettier": "prettier . --write",
+    "fix:prettier": "prettier --write .",
     "lint": "npm run-script lint:prettier && npm run-script lint:eslint",
     "lint:eslint": "eslint .",
-    "lint:prettier": "prettier . --check",
+    "lint:prettier": "prettier --check .",
     "prepack": "npm run-script build",
     "test": "jest",
     "test:coverage": "npm run-script test -- --coverage",
@@ -45,13 +45,16 @@
     "eslint-plugin-prettier": "^5.1",
     "jest": "^30.0",
     "prettier": "^3.0",
-    "stylelint": "^16.0",
+    "stylelint": "^17.0",
     "ts-jest": "^29.2",
     "typescript": "^5.0",
-    "typescript-eslint": "^8.0"
+    "typescript-eslint": "^8.42"
   },
   "peerDependencies": {
-    "stylelint": "^16.0"
+    "stylelint": "^17.0"
+  },
+  "engines": {
+    "node": ">=20.0"
   },
   "keywords": [
     "config",

package/types/config-verifier.d.ts

@@ -28,9 +28,9 @@ export declare class ConfigVerifier {
   /**
    * Creates a new `ConfigVerifier` object.
    *
-   * @param {string} configFile - The path to the Stylelint config file whose rules should be verified
+   * @param {string | undefined} configFile - The path to the Stylelint config file whose rules should be verified
    */
-  constructor(configFile?: string);
+  constructor(configFile?: string | undefined);
   /**
    * Verifies a rule configuration.
    *

package/dist/cjs/config-verifier.js

@@ -1,149 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigVerifier = void 0;
-const stylelint_1 = __importDefault(require("stylelint"));
-/**
- * The `ConfigVerifier` class verifies the rules of a Stylelint configuration. It runs Stylelint for a given test case
- * and compares the linter result with the expected result. The test case contains the code that should be linted and
- * the expected result. The expected result contains the expected error status, messages, and severities.
- *
- * @example
- * ```javascript
- * new ConfigVerifier().verify(
- *   'at-rule-disallowed-list',
- *   {
- *     name: 'Disallow @debug rule',
- *     code: '@debug "";',
- *     expect: {
- *       errored: true,
- *       messages: ['Unexpected at-rule "debug"'],
- *       severities: ['error'],
- *     },
- *   },
- *   {
- *     name: 'Allow @use rule',
- *     code: '@use "test.scss";',
- *   },
- * );
- * ```
- */
-class ConfigVerifier {
-    configFile;
-    /**
-     * The default test case expectation
-     *
-     * This expectation occurs if Stylelint reports no problems and is used if no expectation was defined in a test case.
-     *
-     * @type {TestCaseExpectation}
-     *
-     * @internal
-     */
-    defaultExpectation = {
-        errored: false,
-        messages: [],
-        severities: [],
-    };
-    /**
-     * Creates a new `ConfigVerifier` object.
-     *
-     * @param {string} configFile - The path to the Stylelint config file whose rules should be verified
-     */
-    constructor(configFile = '.stylelintrc.yaml') {
-        this.configFile = configFile;
-    }
-    /**
-     * Verifies a rule configuration.
-     *
-     * @param {string} ruleName - The name of the rule
-     * @param {TestCase[]} testCases - The test cases
-     */
-    verify(ruleName, ...testCases) {
-        describe(`Rule '${ruleName}'`, () => {
-            test.each(testCases)('$name', async (testCase) => {
-                const warnings = this.getWarnings(ruleName, await this.getLinterResult(testCase));
-                const { expect: expectation = this.defaultExpectation } = testCase;
-                expect(this.getErrored(warnings)).toBe(expectation.errored);
-                expect(this.getMessages(warnings)).toStrictEqual(expectation.messages.map((message) => `${message} (${ruleName})`));
-                expect(this.getSeverities(warnings)).toStrictEqual(expectation.severities);
-            });
-        });
-    }
-    /**
-     * Runs Stylelint for the given test case and returns a Promise that resolves to the linter result.
-     *
-     * @internal
-     *
-     * @param {TestCase} testCase - The test case
-     *
-     * @returns {Promise<LinterResult>} A Promise that resolves to the linter result
-     *
-     * @throws {Error} If both `file` and `code` are defined or undefined
-     */
-    getLinterResult({ file, code }) {
-        if ([file, code].filter((value) => value === undefined).length !== 1) {
-            throw new Error('Though both "file" and "code" are optional, you must have one and cannot have both.');
-        }
-        return stylelint_1.default.lint({
-            configFile: this.configFile,
-            files: file,
-            code,
-        });
-    }
-    /**
-     * Returns the warnings for a rule from the given linter result.
-     *
-     * @internal
-     *
-     * @param {string} ruleName - The name of the rule
-     * @param {LinterResult} linterResult - The linter result
-     *
-     * @returns {Warning[]} The warnings for the rule
-     */
-    getWarnings(ruleName, { results: lintResults }) {
-        return lintResults
-            .map(({ warnings }) => warnings)
-            .reduce((previous, current) => previous.concat(current), [])
-            .filter((warning) => warning.rule === ruleName);
-    }
-    /**
-     * Returns true if the given lint warnings contain an error, otherwise false.
-     *
-     * @internal
-     *
-     * @param {Warning[]} warnings - The lint warnings
-     *
-     * @returns {boolean} True if the warnings contain an error, otherwise false
-     */
-    getErrored(warnings) {
-        return this.getSeverities(warnings).some((severity) => severity === 'error');
-    }
-    /**
-     * Returns the messages of the given lint warnings.
-     *
-     * @internal
-     *
-     * @param {Warning[]} warnings - The lint warnings
-     *
-     * @returns {string[]} The messages of the warnings
-     */
-    getMessages(warnings) {
-        return warnings.map(({ text }) => text);
-    }
-    /**
-     * Returns the severities of the given lint warnings.
-     *
-     * @internal
-     *
-     * @param {Warning[]} warnings - The lint warnings
-     *
-     * @returns {Severity[]} The severities of the warnings
-     */
-    getSeverities(warnings) {
-        return warnings.map(({ severity }) => severity);
-    }
-}
-exports.ConfigVerifier = ConfigVerifier;
-exports.default = ConfigVerifier;

package/dist/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/dist/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}