Setup using node:test

---

node:test - Node's built-in test runner.

TIP

You can see the described example as a code in the repository here.

Author's Note

Running tests written with TypeScript using a native test runner is a bit of an adventure, and here we describe a use case with JavaScript.

DX of an error output also leaves a lot to be desired compared to other platforms, but the obvious advantage of node:test is the lack of third-party dependencies, if that's important to you.

Note

This section shows the minimal configuration - for full features and nice defaults, check out the API Reference section or inspect all the options inline using editor's suggestions.

Create a node.test.setup.js file with the following content:

node.test.setup.js

// 1. Import testing functions
import * as assert from 'node:assert/strict';
import { describe, it } from 'node:test';

// 2. Import the factory that will create functions bound to Node test runner
import { createTestUtils } from '@morev/stylelint-testing-library';

// 3. Import all the rules you want to test - this is usually
// the file that is the default export of your package.
// This step is generally optional - you can do it later,
// but it's recommended, as it reduces the amount of boilerplate code.
import plugins from './index.js';

// 4. Create testing functions
// To see all available `createTestUtils` options, please
// refer to the `API Reference` section of this documentation
// or use inline IDE suggestions.
const { createTestRule, createTestRuleConfig } = createTestUtils({
  testFunctions: { it, describe, assert },
  plugins,
});

// 5. Make these functions globally available
// If you don't like to declare test functions globally -
// you should export these functions from a file
// and import it in each test.
globalThis.createTestRule = createTestRule;
globalThis.createTestRuleConfig = createTestRuleConfig;

node.test.setup.js (without comments)

import * as assert from 'node:assert/strict';
import { describe, it } from 'node:test';
import { createTestUtils } from '@morev/stylelint-testing-library';
import plugins from './index.js';

const { createTestRule, createTestRuleConfig } = createTestUtils({
  testFunctions: { it, describe, assert },
});

globalThis.createTestRule = createTestRule;
globalThis.createTestRuleConfig = createTestRuleConfig;

index.js

// All the rules that your plugin provides.
// This file is usually the default export of your package.
import lowercaseSelectorsRule from './rules/lowercase-selectors.js';

export default [
  lowercaseSelectorsRule,
];

---

Specify the types for these global functions if you need to (strongly recommended):

global.d.ts

import type { CreateTestRule, CreateTestRuleConfig } from '@morev/stylelint-testing-library';

declare global {
  var createTestRule: CreateTestRule;
  var createTestRuleConfig: CreateTestRuleConfig;
}

export {};

tsconfig.json

{
  "compilerOptions": {
    "strictNullChecks": true,
    "allowJs": true,
    "types": ["./global.d.ts"],
  },
}

---

Next, create a script for testing in your package.json:

package.json

{
  "name": "your-awesome-stylelint-plugin",
  "scripts": {
    "test": "node --import ./node.test.setup.js --test"
  },
}

and you are ready to test your rules using the npm run test command.

---

We're all set!
Next, follow the instructions on the Usage page.