DefinitelyTyped/types/stylelint/stylelint-tests.ts

import {
    LinterOptions,
    FormatterType,
    SyntaxType,
    lint,
    LintResult,
    LinterResult,
    createPlugin,
    utils,
    createRuleTester,
    RuleTesterContext,
    RuleTesterResult,
    Plugin,
    Warning,
} from 'stylelint';

const options: Partial<LinterOptions> = {
    code: "div { color: red }",
    files: ["**/**.scss"],
    formatter: "json",
    cache: true,
    cacheLocation: "./stylelint.cache.json",
    ignoreDisables: true,
    reportNeedlessDisables: true,
    ignorePath: 'foo',
    syntax: "scss"
};

lint(options).then((x: LinterResult) => {
    const err: boolean = x.errored;
    const output: string = x.output;
    const results: LintResult[] = x.results;
    if (results.length > 0) {
        const warnings: Warning[] = results[0].warnings;
    }
});

const formatter: FormatterType = "json";

const syntax: SyntaxType = "scss";

const ruleName = "sample-rule";
const messages = utils.ruleMessages(ruleName, {
    violation: "This a rule violation message",
    warning: (reason: string) => `This is not allowed because ${reason}`,
});

const testPlugin: Plugin = (options) => {
    return (root, result) => {
        const validOptions = utils.validateOptions(result, ruleName, { actual: options });
        if (!validOptions) {
            return;
        }

        utils.checkAgainstRule({
            ruleName: "at-rule-empty-line-before",
            ruleSettings: ["always"],
            root,
        }, warning => {
            utils.report({
                ruleName,
                result,
                message: messages.warning(warning),
                node: root,
                index: 1,
                word: "foo",
                line: 2,
            });
        });
    };
};

createPlugin(ruleName, testPlugin);

const tester = createRuleTester(
    (result: Promise<RuleTesterResult[]>, context: RuleTesterContext) => {
        return;
    }
);

tester(testPlugin, {
    ruleName: 'foo',
    config: [true, 1],
    accept: [
        { code: 'test' },
        { code: 'test2', description: 'testing' }
    ],
    reject: [
        { code: 'testreject', line: 1, column: 1 },
        { code: 'test2reject', message: 'x', line: 1, column: 1 }
    ]
});