gurkencheck 0.0.4

package/dist/gherkin/variables.js

@@ -0,0 +1,51 @@
+import { at } from '../util/location.js';
+/** `<name>` placeholders, as used in Scenario Outlines. */
+const VARIABLE = /<([^>]*)>/gu;
+function note(variable, position, into) {
+    const seen = into.get(variable);
+    if (seen === undefined) {
+        into.set(variable, [position]);
+        return;
+    }
+    const already = seen.some((p) => p.line === position.line && p.column === position.column);
+    if (!already) {
+        seen.push(position);
+    }
+}
+/** Records every `<variable>` in `text` against the node holding it. */
+function collect(text, position, into) {
+    if (text === undefined || text === '') {
+        return;
+    }
+    for (const match of text.matchAll(VARIABLE)) {
+        note(match[1], position, into);
+    }
+}
+/** Gathers the variables a Scenario Outline declares and the ones it uses. */
+export function variablesOf(scenario) {
+    const declared = new Map();
+    const used = new Map();
+    for (const examples of scenario.examples) {
+        for (const cell of examples.tableHeader?.cells ?? []) {
+            if (cell.value !== '') {
+                note(cell.value, at(cell.location), declared);
+            }
+        }
+    }
+    collect(scenario.name, at(scenario.location), used);
+    for (const step of scenario.steps) {
+        collect(step.text, at(step.location), used);
+        // Steps can carry a data table or a doc string, and both may contain
+        // variables. See https://cucumber.io/docs/gherkin/reference/
+        for (const row of step.dataTable?.rows ?? []) {
+            for (const cell of row.cells) {
+                collect(cell.value, at(cell.location), used);
+            }
+        }
+        if (step.docString !== undefined) {
+            collect(step.docString.content, at(step.location), used);
+        }
+    }
+    return { declared, used };
+}
+//# sourceMappingURL=variables.js.map

package/dist/gherkin/variables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"variables.js","sourceRoot":"","sources":["../../src/gherkin/variables.ts"],"names":[],"mappings":"AASA,OAAO,EAAC,EAAE,EAAC,MAAM,qBAAqB,CAAC;AAEvC,2DAA2D;AAC3D,MAAM,QAAQ,GAAG,aAAa,CAAC;AAmB/B,SAAS,IAAI,CAAC,QAAgB,EAAE,QAAkB,EAAE,IAAe;IACjE,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAChC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC/B,OAAO;IACT,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,IAAI,CAAC,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3F,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACtB,CAAC;AACH,CAAC;AAED,wEAAwE;AACxE,SAAS,OAAO,CAAC,IAAwB,EAAE,QAAkB,EAAE,IAAe;IAC5E,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;QACtC,OAAO;IACT,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5C,IAAI,CAAC,KAAK,CAAC,CAAC,CAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;IAClC,CAAC;AACH,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,WAAW,CAAC,QAAkB;IAC5C,MAAM,QAAQ,GAAc,IAAI,GAAG,EAAE,CAAC;IACtC,MAAM,IAAI,GAAc,IAAI,GAAG,EAAE,CAAC;IAElC,KAAK,MAAM,QAAQ,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACzC,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE,EAAE,CAAC;YACrD,IAAI,IAAI,CAAC,KAAK,KAAK,EAAE,EAAE,CAAC;gBACtB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;YAChD,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC;IAEpD,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;QAClC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC;QAE5C,qEAAqE;QACrE,6DAA6D;QAC7D,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,SAAS,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC;YAC7C,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;gBAC7B,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACjC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED,OAAO,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC;AAC1B,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+/**
+ * gurkencheck as a library.
+ *
+ * ```ts
+ * import {findFeatureFiles, lint, loadRules, readConfiguration} from 'gurkencheck';
+ *
+ * const rules = await loadRules();
+ * const config = readConfiguration('.gurkencheckrc', rules);
+ * if (config.ok) {
+ *   const {files} = findFeatureFiles(['features']);
+ *   const results = await lint(files, config.configuration, rules);
+ * }
+ * ```
+ */
+export { DEFAULT_CONFIG_FILE_NAME, readConfiguration } from './config-parser.ts';
+export type { ConfigurationResult } from './config-parser.ts';
+export { verifyConfiguration } from './config-verifier.ts';
+export { PRESETS, RECOMMENDED } from './presets.ts';
+export { DEFAULT_IGNORE_FILE_NAME, DEFAULT_IGNORED_PATTERNS, findFeatureFiles, readIgnorePatterns, } from './feature-finder.ts';
+export type { FeatureSearch } from './feature-finder.ts';
+export { DEFAULT_FORMAT, FORMATTERS, getFormatter, loadFormatter } from './formatters/index.ts';
+export type { Formatter } from './formatters/index.ts';
+export { toJson } from './formatters/json.ts';
+export { toSarif } from './formatters/sarif.ts';
+export { version } from './version.ts';
+export type { JsonMessage, JsonResult } from './formatters/json.ts';
+export { ALWAYS_ON_RULES, PARSER_RULES, parseFeature, readAndParseFile } from './gherkin/parse.ts';
+export type { ParseResult } from './gherkin/parse.ts';
+export { getNeutralKeyword, getNodeType } from './gherkin/keywords.ts';
+export { DEFAULT_LANGUAGE, detectLanguage, getDialect, isKnownLanguage } from './gherkin/dialects.ts';
+export { backgroundsOf, rulesOf, scenariosOf, stepContainersOf } from './gherkin/traverse.ts';
+export { countBySeverity, hasErrors, lint } from './linter.ts';
+export type { LintOptions } from './linter.ts';
+export { readSuppressions } from './suppressions.ts';
+export type { Suppressions } from './suppressions.ts';
+export { getRuleSettings, getRuleSeverity, isRuleEnabled, loadRules, resetRules, runEnabledRules, } from './rules.ts';
+export { BUILT_IN_RULES } from './rules/index.ts';
+export type { Configuration, FeatureFile, FileResult, LintRule, RuleConfig, RuleError, RuleRegistry, RuleState, Severity, } from './types.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,OAAO,EAAC,wBAAwB,EAAE,iBAAiB,EAAC,MAAM,oBAAoB,CAAC;AAC/E,YAAY,EAAC,mBAAmB,EAAC,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAC,mBAAmB,EAAC,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAC,OAAO,EAAE,WAAW,EAAC,MAAM,cAAc,CAAC;AAClD,OAAO,EACL,wBAAwB,EACxB,wBAAwB,EACxB,gBAAgB,EAChB,kBAAkB,GACnB,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EAAC,aAAa,EAAC,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAC,cAAc,EAAE,UAAU,EAAE,YAAY,EAAE,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAC9F,YAAY,EAAC,SAAS,EAAC,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAC,MAAM,EAAC,MAAM,sBAAsB,CAAC;AAC5C,OAAO,EAAC,OAAO,EAAC,MAAM,uBAAuB,CAAC;AAC9C,OAAO,EAAC,OAAO,EAAC,MAAM,cAAc,CAAC;AACrC,YAAY,EAAC,WAAW,EAAE,UAAU,EAAC,MAAM,sBAAsB,CAAC;AAClE,OAAO,EAAC,eAAe,EAAE,YAAY,EAAE,YAAY,EAAE,gBAAgB,EAAC,MAAM,oBAAoB,CAAC;AACjG,YAAY,EAAC,WAAW,EAAC,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAC,iBAAiB,EAAE,WAAW,EAAC,MAAM,uBAAuB,CAAC;AACrE,OAAO,EAAC,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAE,eAAe,EAAC,MAAM,uBAAuB,CAAC;AACpG,OAAO,EAAC,aAAa,EAAE,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAC,MAAM,uBAAuB,CAAC;AAC5F,OAAO,EAAC,eAAe,EAAE,SAAS,EAAE,IAAI,EAAC,MAAM,aAAa,CAAC;AAC7D,YAAY,EAAC,WAAW,EAAC,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAC,gBAAgB,EAAC,MAAM,mBAAmB,CAAC;AACnD,YAAY,EAAC,YAAY,EAAC,MAAM,mBAAmB,CAAC;AACpD,OAAO,EACL,eAAe,EACf,eAAe,EACf,aAAa,EACb,SAAS,EACT,UAAU,EACV,eAAe,GAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAC,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAChD,YAAY,EACV,aAAa,EACb,WAAW,EACX,UAAU,EACV,QAAQ,EACR,UAAU,EACV,SAAS,EACT,YAAY,EACZ,SAAS,EACT,QAAQ,GACT,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,31 @@
+/**
+ * gurkencheck as a library.
+ *
+ * ```ts
+ * import {findFeatureFiles, lint, loadRules, readConfiguration} from 'gurkencheck';
+ *
+ * const rules = await loadRules();
+ * const config = readConfiguration('.gurkencheckrc', rules);
+ * if (config.ok) {
+ *   const {files} = findFeatureFiles(['features']);
+ *   const results = await lint(files, config.configuration, rules);
+ * }
+ * ```
+ */
+export { DEFAULT_CONFIG_FILE_NAME, readConfiguration } from './config-parser.js';
+export { verifyConfiguration } from './config-verifier.js';
+export { PRESETS, RECOMMENDED } from './presets.js';
+export { DEFAULT_IGNORE_FILE_NAME, DEFAULT_IGNORED_PATTERNS, findFeatureFiles, readIgnorePatterns, } from './feature-finder.js';
+export { DEFAULT_FORMAT, FORMATTERS, getFormatter, loadFormatter } from './formatters/index.js';
+export { toJson } from './formatters/json.js';
+export { toSarif } from './formatters/sarif.js';
+export { version } from './version.js';
+export { ALWAYS_ON_RULES, PARSER_RULES, parseFeature, readAndParseFile } from './gherkin/parse.js';
+export { getNeutralKeyword, getNodeType } from './gherkin/keywords.js';
+export { DEFAULT_LANGUAGE, detectLanguage, getDialect, isKnownLanguage } from './gherkin/dialects.js';
+export { backgroundsOf, rulesOf, scenariosOf, stepContainersOf } from './gherkin/traverse.js';
+export { countBySeverity, hasErrors, lint } from './linter.js';
+export { readSuppressions } from './suppressions.js';
+export { getRuleSettings, getRuleSeverity, isRuleEnabled, loadRules, resetRules, runEnabledRules, } from './rules.js';
+export { BUILT_IN_RULES } from './rules/index.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,OAAO,EAAC,wBAAwB,EAAE,iBAAiB,EAAC,MAAM,oBAAoB,CAAC;AAE/E,OAAO,EAAC,mBAAmB,EAAC,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAC,OAAO,EAAE,WAAW,EAAC,MAAM,cAAc,CAAC;AAClD,OAAO,EACL,wBAAwB,EACxB,wBAAwB,EACxB,gBAAgB,EAChB,kBAAkB,GACnB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAC,cAAc,EAAE,UAAU,EAAE,YAAY,EAAE,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAE9F,OAAO,EAAC,MAAM,EAAC,MAAM,sBAAsB,CAAC;AAC5C,OAAO,EAAC,OAAO,EAAC,MAAM,uBAAuB,CAAC;AAC9C,OAAO,EAAC,OAAO,EAAC,MAAM,cAAc,CAAC;AAErC,OAAO,EAAC,eAAe,EAAE,YAAY,EAAE,YAAY,EAAE,gBAAgB,EAAC,MAAM,oBAAoB,CAAC;AAEjG,OAAO,EAAC,iBAAiB,EAAE,WAAW,EAAC,MAAM,uBAAuB,CAAC;AACrE,OAAO,EAAC,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAE,eAAe,EAAC,MAAM,uBAAuB,CAAC;AACpG,OAAO,EAAC,aAAa,EAAE,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAC,MAAM,uBAAuB,CAAC;AAC5F,OAAO,EAAC,eAAe,EAAE,SAAS,EAAE,IAAI,EAAC,MAAM,aAAa,CAAC;AAE7D,OAAO,EAAC,gBAAgB,EAAC,MAAM,mBAAmB,CAAC;AAEnD,OAAO,EACL,eAAe,EACf,eAAe,EACf,aAAa,EACb,SAAS,EACT,UAAU,EACV,eAAe,GAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAC,cAAc,EAAC,MAAM,kBAAkB,CAAC"}

package/dist/linter.d.ts

@@ -0,0 +1,23 @@
+import type { Configuration, FileResult, RuleRegistry } from './types.ts';
+export interface LintOptions {
+    /**
+     * The dialect to read a file in when it carries no `# language:` header,
+     * for projects written entirely in one language.
+     */
+    language?: string;
+}
+/**
+ * Lints every file and returns one result per file, in the order given.
+ *
+ * Files are read concurrently but checked one after another, because rules
+ * that look for duplicates across files need a predictable order.
+ */
+export declare function lint(files: readonly string[], configuration: Configuration, rules: RuleRegistry, options?: LintOptions): Promise<FileResult[]>;
+/** True when any file has a finding serious enough to fail the run. */
+export declare function hasErrors(results: readonly FileResult[]): boolean;
+/** How many findings there are of each severity. */
+export declare function countBySeverity(results: readonly FileResult[]): {
+    errors: number;
+    warnings: number;
+};
+//# sourceMappingURL=linter.d.ts.map

package/dist/linter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"linter.d.ts","sourceRoot":"","sources":["../src/linter.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAC,aAAa,EAAE,UAAU,EAAE,YAAY,EAAC,MAAM,YAAY,CAAC;AAGxE,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,wBAAsB,IAAI,CACxB,KAAK,EAAE,SAAS,MAAM,EAAE,EACxB,aAAa,EAAE,aAAa,EAC5B,KAAK,EAAE,YAAY,EACnB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,UAAU,EAAE,CAAC,CA4BvB;AAED,uEAAuE;AACvE,wBAAgB,SAAS,CAAC,OAAO,EAAE,SAAS,UAAU,EAAE,GAAG,OAAO,CAIjE;AAED,oDAAoD;AACpD,wBAAgB,eAAe,CAAC,OAAO,EAAE,SAAS,UAAU,EAAE,GAAG;IAC/D,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB,CAaA"}

package/dist/linter.js

@@ -0,0 +1,57 @@
+/**
+ * Running the rules over a set of feature files.
+ */
+import path from 'node:path';
+import { readAndParseFile } from './gherkin/parse.js';
+import { resetRules, runEnabledRules } from './rules.js';
+import { readSuppressions } from './suppressions.js';
+import { sortBy } from './util/collections.js';
+/**
+ * Lints every file and returns one result per file, in the order given.
+ *
+ * Files are read concurrently but checked one after another, because rules
+ * that look for duplicates across files need a predictable order.
+ */
+export async function lint(files, configuration, rules, options = {}) {
+    resetRules(rules);
+    const parsed = await Promise.all(files.map((file) => readAndParseFile(file, options.language)));
+    const results = [];
+    for (const result of parsed) {
+        // Parse errors are not suppressible: the file could not be read, so
+        // hiding the message would leave nothing in its place.
+        let errors = result.errors;
+        if (errors.length === 0) {
+            errors = await runEnabledRules(result.feature, result.file, configuration, rules);
+            const suppressions = readSuppressions(result.file.lines);
+            if (!suppressions.isEmpty) {
+                errors = errors.filter((error) => !suppressions.isSuppressed(error));
+            }
+        }
+        results.push({
+            filePath: path.resolve(result.file.relativePath),
+            errors: sortBy(errors, (error) => error.line),
+        });
+    }
+    return results;
+}
+/** True when any file has a finding serious enough to fail the run. */
+export function hasErrors(results) {
+    return results.some((result) => result.errors.some((error) => (error.severity ?? 'error') === 'error'));
+}
+/** How many findings there are of each severity. */
+export function countBySeverity(results) {
+    let errors = 0;
+    let warnings = 0;
+    for (const result of results) {
+        for (const error of result.errors) {
+            if ((error.severity ?? 'error') === 'warning') {
+                warnings++;
+            }
+            else {
+                errors++;
+            }
+        }
+    }
+    return { errors, warnings };
+}
+//# sourceMappingURL=linter.js.map

package/dist/linter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"linter.js","sourceRoot":"","sources":["../src/linter.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAC,gBAAgB,EAAC,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAC,UAAU,EAAE,eAAe,EAAC,MAAM,YAAY,CAAC;AACvD,OAAO,EAAC,gBAAgB,EAAC,MAAM,mBAAmB,CAAC;AAEnD,OAAO,EAAC,MAAM,EAAC,MAAM,uBAAuB,CAAC;AAU7C;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,KAAwB,EACxB,aAA4B,EAC5B,KAAmB,EACnB,OAAO,GAAgB,EAAE;IAEzB,UAAU,CAAC,KAAK,CAAC,CAAC;IAElB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9B,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAC9D,CAAC;IACF,MAAM,OAAO,GAAiB,EAAE,CAAC;IAEjC,KAAK,MAAM,MAAM,IAAI,MAAM,EAAE,CAAC;QAC5B,oEAAoE;QACpE,uDAAuD;QACvD,IAAI,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAE3B,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxB,MAAM,GAAG,MAAM,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;YAClF,MAAM,YAAY,GAAG,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACzD,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;gBAC1B,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;YACvE,CAAC;QACH,CAAC;QAED,OAAO,CAAC,IAAI,CAAC;YACX,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC;YAChD,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;SAC9C,CAAC,CAAC;IACL,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,uEAAuE;AACvE,MAAM,UAAU,SAAS,CAAC,OAA8B;IACtD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAC7B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,IAAI,OAAO,CAAC,KAAK,OAAO,CAAC,CACvE,CAAC;AACJ,CAAC;AAED,oDAAoD;AACpD,MAAM,UAAU,eAAe,CAAC,OAA8B;IAI5D,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAClC,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,OAAO,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC9C,QAAQ,EAAE,CAAC;YACb,CAAC;iBAAM,CAAC;gBACN,MAAM,EAAE,CAAC;YACX,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,EAAC,MAAM,EAAE,QAAQ,EAAC,CAAC;AAC5B,CAAC"}

package/dist/logger.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Console output. Colour is disabled when stderr is not a terminal, or when
+ * the NO_COLOR environment variable is set.
+ */
+/** Writes a red message to stderr. */
+export declare function error(message: string): void;
+/** Writes a bold red message to stderr. */
+export declare function boldError(message: string): void;
+/** Text decorations used by the stylish formatter. */
+export declare const style: {
+    gray: (text: string) => string;
+    underline: (text: string) => string;
+    /** Red for something that fails the run, yellow for something that does not. */
+    severity: (severity: string, text: string) => string;
+};
+//# sourceMappingURL=logger.d.ts.map

package/dist/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAaH,sCAAsC;AACtC,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAE3C;AAED,2CAA2C;AAC3C,wBAAgB,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAE/C;AAED,sDAAsD;AACtD,eAAO,MAAM,KAAK;IAChB,IAAI,SAAS,MAAM,KAAG,MAAM;IAC5B,SAAS,SAAS,MAAM,KAAG,MAAM;IACjC,gFAAgF;IAChF,QAAQ,aAAa,MAAM,QAAQ,MAAM,KAAG,MAAM;CAEnD,CAAC"}

package/dist/logger.js

@@ -0,0 +1,28 @@
+/**
+ * Console output. Colour is disabled when stderr is not a terminal, or when
+ * the NO_COLOR environment variable is set.
+ */
+const ESC = '\u001B[';
+const RESET = `${ESC}0m`;
+function useColor() {
+    return process.stderr.isTTY === true && !process.env['NO_COLOR'];
+}
+function paint(codes, message) {
+    return useColor() ? `${codes}${message}${RESET}` : message;
+}
+/** Writes a red message to stderr. */
+export function error(message) {
+    console.error(paint(`${ESC}31m`, message));
+}
+/** Writes a bold red message to stderr. */
+export function boldError(message) {
+    console.error(paint(`${ESC}31m${ESC}1m`, message));
+}
+/** Text decorations used by the stylish formatter. */
+export const style = {
+    gray: (text) => paint(`${ESC}38;5;243m`, text),
+    underline: (text) => (useColor() ? `${ESC}0;4m${text}${ESC}24m` : text),
+    /** Red for something that fails the run, yellow for something that does not. */
+    severity: (severity, text) => paint(severity === 'warning' ? `${ESC}33m` : `${ESC}31m`, text),
+};
+//# sourceMappingURL=logger.js.map

package/dist/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,GAAG,GAAG,SAAS,CAAC;AACtB,MAAM,KAAK,GAAG,GAAG,GAAG,IAAI,CAAC;AAEzB,SAAS,QAAQ;IACf,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;AACnE,CAAC;AAED,SAAS,KAAK,CAAC,KAAa,EAAE,OAAe;IAC3C,OAAO,QAAQ,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;AAC7D,CAAC;AAED,sCAAsC;AACtC,MAAM,UAAU,KAAK,CAAC,OAAe;IACnC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,GAAG,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;AAC7C,CAAC;AAED,2CAA2C;AAC3C,MAAM,UAAU,SAAS,CAAC,OAAe;IACvC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,GAAG,MAAM,GAAG,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;AACrD,CAAC;AAED,sDAAsD;AACtD,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,IAAI,EAAE,CAAC,IAAY,EAAU,EAAE,CAAC,KAAK,CAAC,GAAG,GAAG,WAAW,EAAE,IAAI,CAAC;IAC9D,SAAS,EAAE,CAAC,IAAY,EAAU,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,OAAO,IAAI,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IACvF,gFAAgF;IAChF,QAAQ,EAAE,CAAC,QAAgB,EAAE,IAAY,EAAU,EAAE,CACnD,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,EAAE,IAAI,CAAC;CAClE,CAAC"}

package/dist/main.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export declare function run(argv: readonly string[]): Promise<number>;
+//# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";AA6CA,wBAAsB,GAAG,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAqFlE"}

package/dist/main.js

@@ -0,0 +1,144 @@
+#!/usr/bin/env node
+/**
+ * The gurkencheck command line interface.
+ */
+import fs from 'node:fs';
+import { pathToFileURL } from 'node:url';
+import { parseArgs } from 'node:util';
+import { DEFAULT_CONFIG_FILE_NAME, readConfiguration } from './config-parser.js';
+import { DEFAULT_IGNORE_FILE_NAME, findFeatureFiles } from './feature-finder.js';
+import { DEFAULT_FORMAT, FORMATTERS, loadFormatter } from './formatters/index.js';
+import { isKnownLanguage } from './gherkin/dialects.js';
+import { hasErrors, lint } from './linter.js';
+import * as logger from './logger.js';
+import { loadRules } from './rules.js';
+import { version } from './version.js';
+/** Nothing to report. */
+const EXIT_OK = 0;
+/** At least one finding serious enough to fail the run. Warnings alone do not. */
+const EXIT_LINT_ERRORS = 1;
+/** The linter could not run: bad arguments, missing or invalid config. */
+const EXIT_USAGE = 2;
+function usage() {
+    return [
+        'Usage: gurkencheck [options] <feature-files>',
+        '',
+        'Lints Gherkin feature files against the rules in your configuration file.',
+        '',
+        'Options:',
+        `  -f, --format <format>   output format: ${Object.keys(FORMATTERS).join(', ')},`,
+        '                          or the path to a formatter of your own',
+        `                          (default: ${DEFAULT_FORMAT})`,
+        `  -c, --config <path>     configuration file (default: ${DEFAULT_CONFIG_FILE_NAME})`,
+        `  -i, --ignore <globs>    comma separated globs to skip, overriding ${DEFAULT_IGNORE_FILE_NAME}`,
+        '  -r, --rulesdir <dir>    directory of custom rules; may be given more than once',
+        '  -l, --language <code>   dialect for files with no "# language:" header',
+        '  -h, --help              show this message',
+        '  -v, --version           show the version number',
+        '',
+        'With no files given, the working directory is searched recursively.',
+        'Documentation: https://sebs.github.io/gurkencheck/',
+    ].join('\n');
+}
+export async function run(argv) {
+    let parsed;
+    try {
+        parsed = parseArgs({
+            args: [...argv],
+            options: {
+                format: { type: 'string', short: 'f' },
+                config: { type: 'string', short: 'c' },
+                ignore: { type: 'string', short: 'i' },
+                rulesdir: { type: 'string', short: 'r', multiple: true },
+                language: { type: 'string', short: 'l' },
+                help: { type: 'boolean', short: 'h' },
+                version: { type: 'boolean', short: 'v' },
+            },
+            allowPositionals: true,
+        });
+    }
+    catch (thrown) {
+        logger.boldError(thrown instanceof Error ? thrown.message : String(thrown));
+        console.error(usage());
+        return EXIT_USAGE;
+    }
+    const { values, positionals } = parsed;
+    if (values.help === true) {
+        console.log(usage());
+        return EXIT_OK;
+    }
+    if (values.version === true) {
+        console.log(version());
+        return EXIT_OK;
+    }
+    const additionalRulesDirs = values.rulesdir ?? [];
+    let rules;
+    try {
+        rules = await loadRules(additionalRulesDirs);
+    }
+    catch (thrown) {
+        logger.boldError(thrown instanceof Error ? thrown.message : String(thrown));
+        return EXIT_USAGE;
+    }
+    const configuration = await readConfiguration(values.config, rules);
+    if (!configuration.ok) {
+        logger.boldError(configuration.message);
+        for (const detail of configuration.details) {
+            logger.error(`- ${detail}`);
+        }
+        return EXIT_USAGE;
+    }
+    const ignore = values.ignore?.split(',').map((pattern) => pattern.trim());
+    const { files, invalidPatterns } = findFeatureFiles(positionals, ignore);
+    if (invalidPatterns.length > 0) {
+        for (const pattern of invalidPatterns) {
+            logger.boldError(`Invalid format of the feature file path/pattern: "${pattern}".`);
+        }
+        logger.error('To run the linter please specify an existing feature file, directory or glob.');
+        return EXIT_USAGE;
+    }
+    let formatter;
+    try {
+        formatter = await loadFormatter(values.format);
+    }
+    catch (thrown) {
+        logger.boldError(thrown instanceof Error ? thrown.message : String(thrown));
+        return EXIT_USAGE;
+    }
+    const language = values.language ?? configuration.language;
+    if (language !== undefined && !isKnownLanguage(language)) {
+        logger.boldError(`Unknown language "${language}". Use a Gherkin language code, such as "fr".`);
+        return EXIT_USAGE;
+    }
+    const results = await lint(files, configuration.configuration, rules, { language });
+    // A formatter may print the output itself or hand it back as a string.
+    const output = await formatter(results);
+    if (typeof output === 'string' && output !== '') {
+        console.log(output);
+    }
+    return hasErrors(results) ? EXIT_LINT_ERRORS : EXIT_OK;
+}
+/**
+ * True when this file is the script node was asked to run.
+ *
+ * npm installs the command as a symlink in `node_modules/.bin`, and on some
+ * systems the temporary and home directories are symlinked too, so both sides
+ * have to be resolved before they can be compared.
+ */
+function isMainModule() {
+    const entryPoint = process.argv[1];
+    if (entryPoint === undefined) {
+        return false;
+    }
+    try {
+        return import.meta.url === pathToFileURL(fs.realpathSync(entryPoint)).href;
+    }
+    catch {
+        return false;
+    }
+}
+// Only take over the process when run as a command, not when imported.
+if (isMainModule()) {
+    process.exitCode = await run(process.argv.slice(2));
+}
+//# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";AACA;;GAEG;AACH,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAC,aAAa,EAAC,MAAM,UAAU,CAAC;AACvC,OAAO,EAAC,SAAS,EAAC,MAAM,WAAW,CAAC;AACpC,OAAO,EAAC,wBAAwB,EAAE,iBAAiB,EAAC,MAAM,oBAAoB,CAAC;AAC/E,OAAO,EAAC,wBAAwB,EAAE,gBAAgB,EAAC,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAC,cAAc,EAAE,UAAU,EAAE,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAChF,OAAO,EAAC,eAAe,EAAC,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAC,SAAS,EAAE,IAAI,EAAC,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AACtC,OAAO,EAAC,SAAS,EAAC,MAAM,YAAY,CAAC;AACrC,OAAO,EAAC,OAAO,EAAC,MAAM,cAAc,CAAC;AAErC,yBAAyB;AACzB,MAAM,OAAO,GAAG,CAAC,CAAC;AAClB,kFAAkF;AAClF,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAC3B,0EAA0E;AAC1E,MAAM,UAAU,GAAG,CAAC,CAAC;AAErB,SAAS,KAAK;IACZ,OAAO;QACL,8CAA8C;QAC9C,EAAE;QACF,2EAA2E;QAC3E,EAAE;QACF,UAAU;QACV,4CAA4C,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;QACjF,kEAAkE;QAClE,uCAAuC,cAAc,GAAG;QACxD,0DAA0D,wBAAwB,GAAG;QACrF,uEAAuE,wBAAwB,EAAE;QACjG,kFAAkF;QAClF,0EAA0E;QAC1E,6CAA6C;QAC7C,mDAAmD;QACnD,EAAE;QACF,qEAAqE;QACrE,oDAAoD;KACrD,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,GAAG,CAAC,IAAuB;IAC/C,IAAI,MAAM,CAAC;IACX,IAAI,CAAC;QACH,MAAM,GAAG,SAAS,CAAC;YACjB,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;YACf,OAAO,EAAE;gBACP,MAAM,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAC;gBACpC,MAAM,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAC;gBACpC,MAAM,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAC;gBACpC,QAAQ,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAC;gBACtD,QAAQ,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAC;gBACtC,IAAI,EAAE,EAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAC;gBACnC,OAAO,EAAE,EAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAC;aACvC;YACD,gBAAgB,EAAE,IAAI;SACvB,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,MAAM,EAAE,CAAC;QAChB,MAAM,CAAC,SAAS,CAAC,MAAM,YAAY,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5E,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;QACvB,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,MAAM,EAAC,MAAM,EAAE,WAAW,EAAC,GAAG,MAAM,CAAC;IAErC,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QACzB,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;QACrB,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,IAAI,MAAM,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;QAC5B,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QACvB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,MAAM,mBAAmB,GAAG,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC;IAClD,IAAI,KAAK,CAAC;IACV,IAAI,CAAC;QACH,KAAK,GAAG,MAAM,SAAS,CAAC,mBAAmB,CAAC,CAAC;IAC/C,CAAC;IAAC,OAAO,MAAM,EAAE,CAAC;QAChB,MAAM,CAAC,SAAS,CAAC,MAAM,YAAY,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5E,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,MAAM,aAAa,GAAG,MAAM,iBAAiB,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACpE,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;QACtB,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACxC,KAAK,MAAM,MAAM,IAAI,aAAa,CAAC,OAAO,EAAE,CAAC;YAC3C,MAAM,CAAC,KAAK,CAAC,KAAK,MAAM,EAAE,CAAC,CAAC;QAC9B,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAC1E,MAAM,EAAC,KAAK,EAAE,eAAe,EAAC,GAAG,gBAAgB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAEvE,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/B,KAAK,MAAM,OAAO,IAAI,eAAe,EAAE,CAAC;YACtC,MAAM,CAAC,SAAS,CAAC,qDAAqD,OAAO,IAAI,CAAC,CAAC;QACrF,CAAC;QACD,MAAM,CAAC,KAAK,CAAC,+EAA+E,CAAC,CAAC;QAC9F,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,IAAI,SAAS,CAAC;IACd,IAAI,CAAC;QACH,SAAS,GAAG,MAAM,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC;IAAC,OAAO,MAAM,EAAE,CAAC;QAChB,MAAM,CAAC,SAAS,CAAC,MAAM,YAAY,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5E,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,aAAa,CAAC,QAAQ,CAAC;IAC3D,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC;QACzD,MAAM,CAAC,SAAS,CAAC,qBAAqB,QAAQ,+CAA+C,CAAC,CAAC;QAC/F,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,EAAE,aAAa,CAAC,aAAa,EAAE,KAAK,EAAE,EAAC,QAAQ,EAAC,CAAC,CAAC;IAElF,uEAAuE;IACvE,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC;IACxC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,EAAE,EAAE,CAAC;QAChD,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC;IAED,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC;AACzD,CAAC;AAED;;;;;;GAMG;AACH,SAAS,YAAY;IACnB,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACnC,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,CAAC;QACH,OAAO,OAAO,IAAI,CAAC,GAAG,KAAK,aAAa,CAAC,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7E,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,uEAAuE;AACvE,IAAI,YAAY,EAAE,EAAE,CAAC;IACnB,OAAO,CAAC,QAAQ,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AACtD,CAAC"}

package/dist/presets.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Ready-made configurations.
+ *
+ * `recommended` is what you get when there is no configuration file. It holds
+ * the rules that catch a mistake rather than express a preference: an empty
+ * file, a scenario with no name, a variable that will never be substituted.
+ * Nothing in it depends on how a team likes to lay a file out, so it should be
+ * quiet on a codebase that has never been linted.
+ *
+ * Rules about style - indentation, name length, which tags go where, whether
+ * repeated keywords become And - are deliberately left out. They are worth
+ * switching on, but that is a decision for a team to make rather than a
+ * default to inherit.
+ */
+import type { Configuration } from './types.ts';
+export declare const RECOMMENDED: Configuration;
+/** The presets that can be named in a configuration file. */
+export declare const PRESETS: Record<string, Configuration>;
+//# sourceMappingURL=presets.d.ts.map

package/dist/presets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"presets.d.ts","sourceRoot":"","sources":["../src/presets.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,YAAY,CAAC;AAE9C,eAAO,MAAM,WAAW,EAAE,aAkBzB,CAAC;AAEF,6DAA6D;AAC7D,eAAO,MAAM,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAEjD,CAAC"}

package/dist/presets.js

@@ -0,0 +1,24 @@
+export const RECOMMENDED = {
+    'new-line-at-eof': ['on', 'yes'],
+    'no-dupe-feature-names': 'on',
+    'no-dupe-scenario-names': 'on',
+    'no-duplicate-tags': 'on',
+    'no-empty-background': 'on',
+    'no-empty-file': 'on',
+    'no-examples-in-scenarios': 'on',
+    'no-files-without-scenarios': 'on',
+    'no-multiple-empty-lines': 'on',
+    'no-partially-commented-tag-lines': 'on',
+    'no-scenario-outlines-without-examples': 'on',
+    'no-trailing-spaces': 'on',
+    'no-undeclared-variables': 'on',
+    'no-unnamed-features': 'on',
+    'no-unnamed-scenarios': 'on',
+    'no-unused-variables': 'on',
+    'one-space-between-tags': 'on',
+};
+/** The presets that can be named in a configuration file. */
+export const PRESETS = {
+    'gurkencheck:recommended': RECOMMENDED,
+};
+//# sourceMappingURL=presets.js.map

package/dist/presets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"presets.js","sourceRoot":"","sources":["../src/presets.ts"],"names":[],"mappings":"AAgBA,MAAM,CAAC,MAAM,WAAW,GAAkB;IACxC,iBAAiB,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC;IAChC,uBAAuB,EAAE,IAAI;IAC7B,wBAAwB,EAAE,IAAI;IAC9B,mBAAmB,EAAE,IAAI;IACzB,qBAAqB,EAAE,IAAI;IAC3B,eAAe,EAAE,IAAI;IACrB,0BAA0B,EAAE,IAAI;IAChC,4BAA4B,EAAE,IAAI;IAClC,yBAAyB,EAAE,IAAI;IAC/B,kCAAkC,EAAE,IAAI;IACxC,uCAAuC,EAAE,IAAI;IAC7C,oBAAoB,EAAE,IAAI;IAC1B,yBAAyB,EAAE,IAAI;IAC/B,qBAAqB,EAAE,IAAI;IAC3B,sBAAsB,EAAE,IAAI;IAC5B,qBAAqB,EAAE,IAAI;IAC3B,wBAAwB,EAAE,IAAI;CAC/B,CAAC;AAEF,6DAA6D;AAC7D,MAAM,CAAC,MAAM,OAAO,GAAkC;IACpD,yBAAyB,EAAE,WAAW;CACvC,CAAC"}

package/dist/rules/allowed-tags.d.ts

@@ -0,0 +1,4 @@
+import type { LintRule } from '../types.ts';
+declare const rule: LintRule;
+export default rule;
+//# sourceMappingURL=allowed-tags.d.ts.map

package/dist/rules/allowed-tags.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"allowed-tags.d.ts","sourceRoot":"","sources":["../../src/rules/allowed-tags.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,QAAQ,EAAY,MAAM,aAAa,CAAC;AAerD,QAAA,MAAM,IAAI,EAAE,QA4BX,CAAC;eAEa,IAAI"}

package/dist/rules/allowed-tags.js

@@ -0,0 +1,34 @@
+import { getNodeType } from '../gherkin/keywords.js';
+import { taggedNodesOf } from '../gherkin/traverse.js';
+import { mergeDefaults } from '../util/collections.js';
+import { at } from '../util/location.js';
+const name = 'allowed-tags';
+const availableConfigs = { tags: [], patterns: [] };
+const rule = {
+    name,
+    availableConfigs,
+    run(feature, _file, configuration) {
+        if (feature === undefined) {
+            return [];
+        }
+        const config = mergeDefaults(availableConfigs, configuration);
+        const allowedTags = new Set(config.tags);
+        const allowedPatterns = config.patterns.map((pattern) => new RegExp(pattern));
+        const errors = [];
+        for (const { node } of taggedNodesOf(feature)) {
+            for (const tag of node.tags) {
+                const allowed = allowedTags.has(tag.name) || allowedPatterns.some((pattern) => pattern.test(tag.name));
+                if (!allowed) {
+                    errors.push({
+                        message: `Not allowed tag ${tag.name} on ${getNodeType(node, feature.language)}`,
+                        rule: name,
+                        ...at(tag.location),
+                    });
+                }
+            }
+        }
+        return errors;
+    },
+};
+export default rule;
+//# sourceMappingURL=allowed-tags.js.map

package/dist/rules/allowed-tags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"allowed-tags.js","sourceRoot":"","sources":["../../src/rules/allowed-tags.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAC,aAAa,EAAC,MAAM,wBAAwB,CAAC;AAErD,OAAO,EAAC,aAAa,EAAC,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAC,EAAE,EAAC,MAAM,qBAAqB,CAAC;AAEvC,MAAM,IAAI,GAAG,cAAc,CAAC;AAS5B,MAAM,gBAAgB,GAAsB,EAAC,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAC,CAAC;AAErE,MAAM,IAAI,GAAa;IACrB,IAAI;IACJ,gBAAgB;IAChB,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,aAAa;QAC/B,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,MAAM,GAAG,aAAa,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC;QAC9D,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,eAAe,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QAC9E,MAAM,MAAM,GAAgB,EAAE,CAAC;QAE/B,KAAK,MAAM,EAAC,IAAI,EAAC,IAAI,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5C,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBAC5B,MAAM,OAAO,GACX,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;gBACzF,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,MAAM,CAAC,IAAI,CAAC;wBACV,OAAO,EAAE,mBAAmB,GAAG,CAAC,IAAI,OAAO,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE;wBAChF,IAAI,EAAE,IAAI;wBACV,GAAG,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC;qBACpB,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/rules/file-name.d.ts

@@ -0,0 +1,4 @@
+import type { LintRule } from '../types.ts';
+declare const rule: LintRule;
+export default rule;
+//# sourceMappingURL=file-name.d.ts.map

package/dist/rules/file-name.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-name.d.ts","sourceRoot":"","sources":["../../src/rules/file-name.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,aAAa,CAAC;AAqB1C,QAAA,MAAM,IAAI,EAAE,QA0BX,CAAC;eAEa,IAAI"}

package/dist/rules/file-name.js

@@ -0,0 +1,41 @@
+import path from 'node:path';
+import { camelCase, kebabCase, pascalCase, snakeCase, titleCase } from '../util/case.js';
+import { mergeDefaults } from '../util/collections.js';
+const name = 'file-name';
+const STYLES = {
+    PascalCase: pascalCase,
+    'Title Case': titleCase,
+    camelCase,
+    'kebab-case': kebabCase,
+    snake_case: snakeCase,
+};
+const availableConfigs = {
+    /** One of PascalCase, Title Case, camelCase, kebab-case or snake_case. */
+    style: 'PascalCase',
+};
+const rule = {
+    name,
+    availableConfigs,
+    run(_feature, file, configuration) {
+        const { style } = mergeDefaults(availableConfigs, configuration);
+        const convert = STYLES[style];
+        if (convert === undefined) {
+            throw new Error(`style "${style}" is not supported by the ${name} rule. ` +
+                `Supported styles: ${Object.keys(STYLES).join(', ')}`);
+        }
+        const fileName = path.basename(file.relativePath, '.feature');
+        const expected = convert(fileName);
+        if (fileName === expected) {
+            return [];
+        }
+        return [
+            {
+                message: `File names should be written in ${style} e.g. "${expected}.feature"`,
+                rule: name,
+                line: 0,
+            },
+        ];
+    },
+};
+export default rule;
+//# sourceMappingURL=file-name.js.map

package/dist/rules/file-name.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-name.js","sourceRoot":"","sources":["../../src/rules/file-name.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAC,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAC,MAAM,iBAAiB,CAAC;AACvF,OAAO,EAAC,aAAa,EAAC,MAAM,wBAAwB,CAAC;AAErD,MAAM,IAAI,GAAG,WAAW,CAAC;AAEzB,MAAM,MAAM,GAAG;IACb,UAAU,EAAE,UAAU;IACtB,YAAY,EAAE,SAAS;IACvB,SAAS;IACT,YAAY,EAAE,SAAS;IACvB,UAAU,EAAE,SAAS;CACtB,CAAC;AAIF,MAAM,gBAAgB,GAAG;IACvB,0EAA0E;IAC1E,KAAK,EAAE,YAAqB;CAC7B,CAAC;AAEF,MAAM,IAAI,GAAa;IACrB,IAAI;IACJ,gBAAgB;IAChB,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,aAAa;QAC/B,MAAM,EAAC,KAAK,EAAC,GAAG,aAAa,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC;QAC/D,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9B,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,UAAU,KAAK,6BAA6B,IAAI,SAAS;gBACvD,qBAAqB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACxD,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QAC9D,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;QACnC,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC1B,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,OAAO;YACL;gBACE,OAAO,EAAE,mCAAmC,KAAK,UAAU,QAAQ,WAAW;gBAC9E,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,CAAC;aACR;SACF,CAAC;IACJ,CAAC;CACF,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/rules/indentation.d.ts

@@ -0,0 +1,4 @@
+import type { LintRule } from '../types.ts';
+declare const rule: LintRule;
+export default rule;
+//# sourceMappingURL=indentation.d.ts.map

package/dist/rules/indentation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indentation.d.ts","sourceRoot":"","sources":["../../src/rules/indentation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,QAAQ,EAAY,MAAM,aAAa,CAAC;AA0ErD,QAAA,MAAM,IAAI,EAAE,QAgHX,CAAC;eAEa,IAAI"}