gurkencheck 0.0.4

package/dist/gherkin/dialects.d.ts

@@ -0,0 +1,31 @@
+/** The keyword lists for one language. */
+export interface Dialect {
+    name: string;
+    native: string;
+    feature: readonly string[];
+    rule: readonly string[];
+    background: readonly string[];
+    scenario: readonly string[];
+    scenarioOutline: readonly string[];
+    examples: readonly string[];
+    given: readonly string[];
+    when: readonly string[];
+    then: readonly string[];
+    and: readonly string[];
+    but: readonly string[];
+}
+export declare const DEFAULT_LANGUAGE = "en";
+/** The dialect for a language code, falling back to English. */
+export declare function getDialect(language: string | undefined): Dialect;
+/** True when `language` is one Gherkin knows about. */
+export declare function isKnownLanguage(language: string): boolean;
+/**
+ * Reads the `# language: xx` header from the top of a feature file. Only the
+ * leading comment and blank lines are inspected, which is where Gherkin
+ * itself expects the header to be.
+ *
+ * A file with no header is read in `fallback`, which lets a project written
+ * entirely in one language set it once instead of in every file.
+ */
+export declare function detectLanguage(lines: readonly string[], fallback?: string): string;
+//# sourceMappingURL=dialects.d.ts.map

package/dist/gherkin/dialects.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialects.d.ts","sourceRoot":"","sources":["../../src/gherkin/dialects.ts"],"names":[],"mappings":"AAKA,0CAA0C;AAC1C,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;IACxB,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;IAC9B,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,eAAe,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IACzB,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;IACxB,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;IACxB,GAAG,EAAE,SAAS,MAAM,EAAE,CAAC;IACvB,GAAG,EAAE,SAAS,MAAM,EAAE,CAAC;CACxB;AAID,eAAO,MAAM,gBAAgB,OAAO,CAAC;AAErC,gEAAgE;AAChE,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAEhE;AAED,uDAAuD;AACvD,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEzD;AAID;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,KAAK,EAAE,SAAS,MAAM,EAAE,EACxB,QAAQ,GAAE,MAAyB,GAClC,MAAM,CAeR"}

package/dist/gherkin/dialects.js

@@ -0,0 +1,40 @@
+/**
+ * Access to Gherkin's localised keywords.
+ */
+import { dialects } from '@cucumber/gherkin';
+const ALL_DIALECTS = dialects;
+export const DEFAULT_LANGUAGE = 'en';
+/** The dialect for a language code, falling back to English. */
+export function getDialect(language) {
+    return ALL_DIALECTS[language ?? DEFAULT_LANGUAGE] ?? ALL_DIALECTS[DEFAULT_LANGUAGE];
+}
+/** True when `language` is one Gherkin knows about. */
+export function isKnownLanguage(language) {
+    return language in ALL_DIALECTS;
+}
+const LANGUAGE_HEADER = /^\s*#\s*language\s*:\s*([\w-]+)\s*$/;
+/**
+ * Reads the `# language: xx` header from the top of a feature file. Only the
+ * leading comment and blank lines are inspected, which is where Gherkin
+ * itself expects the header to be.
+ *
+ * A file with no header is read in `fallback`, which lets a project written
+ * entirely in one language set it once instead of in every file.
+ */
+export function detectLanguage(lines, fallback = DEFAULT_LANGUAGE) {
+    for (const line of lines) {
+        const trimmed = line.trim();
+        if (trimmed === '') {
+            continue;
+        }
+        if (!trimmed.startsWith('#')) {
+            break;
+        }
+        const header = LANGUAGE_HEADER.exec(trimmed);
+        if (header?.[1] !== undefined && isKnownLanguage(header[1])) {
+            return header[1];
+        }
+    }
+    return isKnownLanguage(fallback) ? fallback : DEFAULT_LANGUAGE;
+}
+//# sourceMappingURL=dialects.js.map

package/dist/gherkin/dialects.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialects.js","sourceRoot":"","sources":["../../src/gherkin/dialects.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAC,QAAQ,EAAC,MAAM,mBAAmB,CAAC;AAmB3C,MAAM,YAAY,GAAG,QAA8C,CAAC;AAEpE,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAErC,gEAAgE;AAChE,MAAM,UAAU,UAAU,CAAC,QAA4B;IACrD,OAAO,YAAY,CAAC,QAAQ,IAAI,gBAAgB,CAAC,IAAI,YAAY,CAAC,gBAAgB,CAAE,CAAC;AACvF,CAAC;AAED,uDAAuD;AACvD,MAAM,UAAU,eAAe,CAAC,QAAgB;IAC9C,OAAO,QAAQ,IAAI,YAAY,CAAC;AAClC,CAAC;AAED,MAAM,eAAe,GAAG,qCAAqC,CAAC;AAE9D;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAC5B,KAAwB,EACxB,QAAQ,GAAW,gBAAgB;IAEnC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC5B,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;YACnB,SAAS;QACX,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,MAAM;QACR,CAAC;QACD,MAAM,MAAM,GAAG,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5D,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;QACnB,CAAC;IACH,CAAC;IACD,OAAO,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,gBAAgB,CAAC;AACjE,CAAC"}

package/dist/gherkin/keywords.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Turning a node's localised keyword back into a language-neutral one.
+ *
+ * The keyword is the only way to tell a Scenario from a Scenario Outline,
+ * because both arrive as a `scenario` node in the parsed document.
+ */
+import type { Background, Examples, Feature, Rule, Scenario, Step } from '@cucumber/messages';
+/** Any node that carries a Gherkin keyword. */
+export type KeywordNode = Feature | Rule | Background | Scenario | Examples | Step;
+/** The keyword categories used across the rules. */
+export type NeutralKeyword = 'feature' | 'rule' | 'background' | 'scenario' | 'scenariooutline' | 'examples' | 'given' | 'when' | 'then' | 'and' | 'but' | '';
+/**
+ * Maps a node's localised keyword (`Szenario`) onto the language-neutral name
+ * (`scenario`). Returns an empty string for keywords the dialect does not know.
+ */
+export declare function getNeutralKeyword(node: Pick<KeywordNode, 'keyword'>, language: string | undefined): NeutralKeyword;
+/** True when the keyword is a Given/When/Then/And/But step keyword. */
+export declare function isStepKeyword(keyword: NeutralKeyword): boolean;
+/** The display name for a node, as used in error messages. */
+export declare function getNodeType(node: Pick<KeywordNode, 'keyword'>, language: string | undefined): string;
+//# sourceMappingURL=keywords.d.ts.map

package/dist/gherkin/keywords.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keywords.d.ts","sourceRoot":"","sources":["../../src/gherkin/keywords.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,EAAC,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAC,MAAM,oBAAoB,CAAC;AAG5F,+CAA+C;AAC/C,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,IAAI,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,IAAI,CAAC;AAEnF,oDAAoD;AACpD,MAAM,MAAM,cAAc,GACtB,SAAS,GACT,MAAM,GACN,YAAY,GACZ,UAAU,GACV,iBAAiB,GACjB,UAAU,GACV,OAAO,GACP,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,EAAE,CAAC;AAkBP;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,EAClC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAC3B,cAAc,CAQhB;AAED,uEAAuE;AACvE,wBAAgB,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAE9D;AAED,8DAA8D;AAC9D,wBAAgB,WAAW,CACzB,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,EAClC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAC3B,MAAM,CAkBR"}

package/dist/gherkin/keywords.js

@@ -0,0 +1,53 @@
+import { getDialect } from './dialects.js';
+const KEYWORD_FIELDS = [
+    'feature',
+    'rule',
+    'background',
+    'scenario',
+    'scenarioOutline',
+    'examples',
+    'given',
+    'when',
+    'then',
+    'and',
+    'but',
+];
+const STEP_KEYWORDS = new Set(['given', 'when', 'then', 'and', 'but']);
+/**
+ * Maps a node's localised keyword (`Szenario`) onto the language-neutral name
+ * (`scenario`). Returns an empty string for keywords the dialect does not know.
+ */
+export function getNeutralKeyword(node, language) {
+    const dialect = getDialect(language);
+    for (const field of KEYWORD_FIELDS) {
+        if (dialect[field].includes(node.keyword)) {
+            return field.toLowerCase();
+        }
+    }
+    return '';
+}
+/** True when the keyword is a Given/When/Then/And/But step keyword. */
+export function isStepKeyword(keyword) {
+    return STEP_KEYWORDS.has(keyword);
+}
+/** The display name for a node, as used in error messages. */
+export function getNodeType(node, language) {
+    const keyword = getNeutralKeyword(node, language);
+    switch (keyword) {
+        case 'feature':
+            return 'Feature';
+        case 'rule':
+            return 'Rule';
+        case 'background':
+            return 'Background';
+        case 'scenario':
+            return 'Scenario';
+        case 'scenariooutline':
+            return 'Scenario Outline';
+        case 'examples':
+            return 'Examples';
+        default:
+            return isStepKeyword(keyword) ? 'Step' : '';
+    }
+}
+//# sourceMappingURL=keywords.js.map

package/dist/gherkin/keywords.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keywords.js","sourceRoot":"","sources":["../../src/gherkin/keywords.ts"],"names":[],"mappings":"AAOA,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AAoBzC,MAAM,cAAc,GAAG;IACrB,SAAS;IACT,MAAM;IACN,YAAY;IACZ,UAAU;IACV,iBAAiB;IACjB,UAAU;IACV,OAAO;IACP,MAAM;IACN,MAAM;IACN,KAAK;IACL,KAAK;CACG,CAAC;AAEX,MAAM,aAAa,GAAG,IAAI,GAAG,CAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;AAEvF;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAC/B,IAAkC,EAClC,QAA4B;IAE5B,MAAM,OAAO,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;IACrC,KAAK,MAAM,KAAK,IAAI,cAAc,EAAE,CAAC;QACnC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1C,OAAO,KAAK,CAAC,WAAW,EAAoB,CAAC;QAC/C,CAAC;IACH,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,uEAAuE;AACvE,MAAM,UAAU,aAAa,CAAC,OAAuB;IACnD,OAAO,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AACpC,CAAC;AAED,8DAA8D;AAC9D,MAAM,UAAU,WAAW,CACzB,IAAkC,EAClC,QAA4B;IAE5B,MAAM,OAAO,GAAG,iBAAiB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAClD,QAAQ,OAAO,EAAE,CAAC;QAChB,KAAK,SAAS;YACZ,OAAO,SAAS,CAAC;QACnB,KAAK,MAAM;YACT,OAAO,MAAM,CAAC;QAChB,KAAK,YAAY;YACf,OAAO,YAAY,CAAC;QACtB,KAAK,UAAU;YACb,OAAO,UAAU,CAAC;QACpB,KAAK,iBAAiB;YACpB,OAAO,kBAAkB,CAAC;QAC5B,KAAK,UAAU;YACb,OAAO,UAAU,CAAC;QACpB;YACE,OAAO,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IAChD,CAAC;AACH,CAAC"}

package/dist/gherkin/parse.d.ts

@@ -0,0 +1,32 @@
+import type { Feature } from '@cucumber/messages';
+import type { FeatureFile, RuleError } from '../types.ts';
+/**
+ * Rules the parser enforces on every file. They cannot be turned off, but
+ * they may be named in a configuration file, because they are documented
+ * alongside the rules that can.
+ */
+export declare const ALWAYS_ON_RULES: readonly ['no-tags-on-backgrounds', 'one-feature-per-file', 'up-to-one-background-per-file', 'background-before-scenarios', 'no-multiline-steps'];
+/** The rule names parse errors are reported under. */
+export declare const PARSER_RULES: readonly ["no-tags-on-backgrounds", "one-feature-per-file", "up-to-one-background-per-file", "background-before-scenarios", "no-multiline-steps", "unexpected-error"];
+/** The outcome of reading and parsing one feature file. */
+export interface ParseResult {
+    file: FeatureFile;
+    /** The parsed feature, or `undefined` when parsing failed or the file is empty. */
+    feature: Feature | undefined;
+    /** Fatal parse errors. When this is non-empty, no rules are run on the file. */
+    errors: RuleError[];
+}
+/** Splits source text into lines, accepting any of the three line endings. */
+export declare function toLines(source: string): string[];
+/**
+ * Parses feature file source. When the parser rejects the file, the returned
+ * `feature` is `undefined` and `errors` describes what went wrong.
+ *
+ * `defaultLanguage` is the dialect to read a file in when it carries no
+ * `# language:` header of its own, for projects written entirely in one
+ * language.
+ */
+export declare function parseFeature(relativePath: string, source: string, defaultLanguage?: string): ParseResult;
+/** Reads a feature file from disk and parses it. */
+export declare function readAndParseFile(relativePath: string, defaultLanguage?: string): Promise<ParseResult>;
+//# sourceMappingURL=parse.d.ts.map

package/dist/gherkin/parse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../src/gherkin/parse.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,oBAAoB,CAAC;AAEhD,OAAO,KAAK,EAAC,WAAW,EAAE,SAAS,EAAC,MAAM,aAAa,CAAC;AAIxD;;;;GAIG;AACH,eAAO,MAAM,eAAe,YAC1B,wBAAwB,EACxB,sBAAsB,EACtB,+BAA+B,EAC/B,6BAA6B,EAC7B,oBAAoB,CACZ,CAAC;AAEX,sDAAsD;AACtD,eAAO,MAAM,YAAY,uKAAoD,CAAC;AAE9E,2DAA2D;AAC3D,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,WAAW,CAAC;IAClB,mFAAmF;IACnF,OAAO,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B,gFAAgF;IAChF,MAAM,EAAE,SAAS,EAAE,CAAC;CACrB;AAmMD,8EAA8E;AAC9E,wBAAgB,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAEhD;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAC1B,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,EACd,eAAe,GAAE,MAAyB,GACzC,WAAW,CA8Cb;AAED,oDAAoD;AACpD,wBAAsB,gBAAgB,CACpC,YAAY,EAAE,MAAM,EACpB,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,WAAW,CAAC,CAGtB"}

package/dist/gherkin/parse.js

@@ -0,0 +1,236 @@
+/**
+ * Parsing feature files, and turning the parser's complaints into lint errors.
+ *
+ * A handful of Gherkin constructs are rejected by the parser itself rather
+ * than by a rule: a second Feature, a second Background, a tag on a
+ * Background, and a step continued onto the next line. Those show up here as
+ * parse failures, and this module maps them onto the rule names users see.
+ * Because the parser refuses to build a document for such a file, these
+ * checks cannot be switched off.
+ */
+import { AstBuilder, GherkinClassicTokenMatcher, Parser } from '@cucumber/gherkin';
+import { IdGenerator } from '@cucumber/messages';
+import { readFile } from 'node:fs/promises';
+import { DEFAULT_LANGUAGE, detectLanguage, getDialect } from './dialects.js';
+/**
+ * Rules the parser enforces on every file. They cannot be turned off, but
+ * they may be named in a configuration file, because they are documented
+ * alongside the rules that can.
+ */
+export const ALWAYS_ON_RULES = [
+    'no-tags-on-backgrounds',
+    'one-feature-per-file',
+    'up-to-one-background-per-file',
+    'background-before-scenarios',
+    'no-multiline-steps',
+];
+/** The rule names parse errors are reported under. */
+export const PARSER_RULES = [...ALWAYS_ON_RULES, 'unexpected-error'];
+const UNEXPECTED_TOKEN = /^\((\d+):(\d+)\): expected: (.*), got '([\s\S]*)'$/;
+const UNEXPECTED_EOF = /^\((\d+):(\d+)\): unexpected end of file, expected: (.*)$/;
+/** How many times a tag-on-background may be stripped before giving up. */
+const MAX_TAG_RECOVERIES = 20;
+function newParser(defaultLanguage) {
+    return new Parser(new AstBuilder(IdGenerator.uuid()), new GherkinClassicTokenMatcher(defaultLanguage));
+}
+function toComplaint(error) {
+    const raw = error instanceof Error ? error.message : String(error);
+    const location = error.location;
+    const unexpectedToken = UNEXPECTED_TOKEN.exec(raw);
+    if (unexpectedToken) {
+        return {
+            line: Number(unexpectedToken[1]),
+            column: Number(unexpectedToken[2]),
+            expected: unexpectedToken[3].split(', '),
+            got: unexpectedToken[4],
+            raw,
+        };
+    }
+    const unexpectedEof = UNEXPECTED_EOF.exec(raw);
+    if (unexpectedEof) {
+        return {
+            line: Number(unexpectedEof[1]),
+            column: Number(unexpectedEof[2]),
+            expected: unexpectedEof[3].split(', '),
+            got: undefined,
+            raw,
+        };
+    }
+    return {
+        line: location?.line ?? 0,
+        column: location?.column ?? 0,
+        expected: [],
+        got: undefined,
+        raw,
+    };
+}
+function parseSource(source, defaultLanguage) {
+    try {
+        const document = newParser(defaultLanguage).parse(source);
+        return { feature: document.feature ?? undefined, complaints: [] };
+    }
+    catch (thrown) {
+        const nested = thrown.errors;
+        const errors = Array.isArray(nested) && nested.length > 0 ? nested : [thrown];
+        return { feature: undefined, complaints: errors.map(toComplaint) };
+    }
+}
+/** True when the offending text opens a node of one of the given keywords. */
+function startsWithKeyword(text, keywords) {
+    return keywords.some((keyword) => text.startsWith(`${keyword.trim()}:`));
+}
+/**
+ * True when a Background is already open above `line`.
+ *
+ * The parser rejects a second Background and a Background written below a
+ * Scenario in exactly the same way, but they are different mistakes with
+ * different fixes, so the lines above are checked to tell them apart.
+ */
+function hasEarlierBackground(lines, line, dialect) {
+    return lines
+        .slice(0, Math.max(0, line - 1))
+        .some((text) => startsWithKeyword(text.trim(), dialect.background));
+}
+/** The step keywords of a dialect, without the `*` wildcard, for messages. */
+function stepKeywordsFor(dialect) {
+    return [dialect.given, dialect.when, dialect.then, dialect.and, dialect.but]
+        .map((keywords) => keywords.map((keyword) => keyword.trim()).find((keyword) => keyword !== '*'))
+        .filter((keyword) => keyword !== undefined);
+}
+/**
+ * A tag written directly above a Background. The parser reports this as
+ * "expected a tag line or a rule line" - it is still waiting for something a
+ * tag can attach to, and a Background is not one of those things.
+ */
+function isTagOnBackground(complaint, dialect) {
+    return (complaint.got !== undefined &&
+        complaint.expected.includes('#TagLine') &&
+        !complaint.expected.includes('#ScenarioLine') &&
+        !complaint.expected.includes('#StepLine') &&
+        startsWithKeyword(complaint.got, dialect.background));
+}
+/**
+ * Blanks the tag lines sitting above `line`, so the file can be parsed again
+ * to find the problems hiding behind the tag. Lines are blanked rather than
+ * removed so that every other line number stays correct.
+ *
+ * Returns `undefined` when there was no tag line to blank.
+ */
+function withoutTagsAbove(lines, line) {
+    const result = [...lines];
+    let index = line - 2;
+    let blanked = false;
+    while (index >= 0) {
+        const trimmed = result[index].trim();
+        if (trimmed.startsWith('@')) {
+            result[index] = '';
+            blanked = true;
+        }
+        else if (trimmed !== '' && !trimmed.startsWith('#')) {
+            break;
+        }
+        index--;
+    }
+    return blanked ? result : undefined;
+}
+function classify(complaint, dialect, lines) {
+    if (complaint.got !== undefined) {
+        if (startsWithKeyword(complaint.got, dialect.background)) {
+            return hasEarlierBackground(lines, complaint.line, dialect)
+                ? {
+                    message: 'Multiple "Background" definitions in the same file are disallowed',
+                    rule: 'up-to-one-background-per-file',
+                    line: complaint.line,
+                    column: complaint.column,
+                }
+                : {
+                    message: 'A "Background" must come before the Scenarios it applies to',
+                    rule: 'background-before-scenarios',
+                    line: complaint.line,
+                    column: complaint.column,
+                };
+        }
+        if (startsWithKeyword(complaint.got, dialect.feature)) {
+            return {
+                message: 'Multiple "Feature" definitions in the same file are disallowed',
+                rule: 'one-feature-per-file',
+                line: complaint.line,
+                column: complaint.column,
+            };
+        }
+        if (complaint.expected.includes('#StepLine') && complaint.expected.includes('#DocStringSeparator')) {
+            const keywords = stepKeywordsFor(dialect);
+            const last = keywords.pop();
+            const list = `${keywords.map((keyword) => `"${keyword}"`).join(', ')} or "${last}"`;
+            return {
+                message: `Steps should begin with ${list}. Multiline steps are disallowed`,
+                rule: 'no-multiline-steps',
+                line: complaint.line,
+                column: complaint.column,
+            };
+        }
+    }
+    return {
+        message: complaint.raw,
+        rule: 'unexpected-error',
+        line: complaint.line,
+        column: complaint.column,
+    };
+}
+/** Splits source text into lines, accepting any of the three line endings. */
+export function toLines(source) {
+    return source.split(/\r\n|\r|\n/);
+}
+/**
+ * Parses feature file source. When the parser rejects the file, the returned
+ * `feature` is `undefined` and `errors` describes what went wrong.
+ *
+ * `defaultLanguage` is the dialect to read a file in when it carries no
+ * `# language:` header of its own, for projects written entirely in one
+ * language.
+ */
+export function parseFeature(relativePath, source, defaultLanguage = DEFAULT_LANGUAGE) {
+    const lines = toLines(source);
+    const file = { relativePath, lines };
+    const dialect = getDialect(detectLanguage(lines, defaultLanguage));
+    const errors = [];
+    let workingLines = lines;
+    for (let attempt = 0; attempt <= MAX_TAG_RECOVERIES; attempt++) {
+        const { feature, complaints } = parseSource(workingLines.join('\n'), defaultLanguage);
+        if (complaints.length === 0) {
+            return { file, feature: errors.length > 0 ? undefined : feature, errors };
+        }
+        const first = complaints[0];
+        if (isTagOnBackground(first, dialect)) {
+            const recovered = withoutTagsAbove(workingLines, first.line);
+            if (recovered !== undefined) {
+                errors.push({
+                    message: 'Tags on Backgrounds are disallowed',
+                    rule: 'no-tags-on-backgrounds',
+                    line: first.line,
+                    column: first.column,
+                });
+                workingLines = recovered;
+                continue;
+            }
+        }
+        const classified = complaints.map((complaint) => classify(complaint, dialect, workingLines));
+        // A Background in the wrong place derails everything after it: each
+        // following line is rejected in turn, and none of those complaints tells
+        // the reader anything the first one did not. Report the cause on its own.
+        const misplacedBackground = classified[0];
+        if (misplacedBackground?.rule === 'background-before-scenarios') {
+            errors.push(misplacedBackground);
+            return { file, feature: undefined, errors };
+        }
+        errors.push(...classified);
+        return { file, feature: undefined, errors };
+    }
+    return { file, feature: undefined, errors };
+}
+/** Reads a feature file from disk and parses it. */
+export async function readAndParseFile(relativePath, defaultLanguage) {
+    const source = await readFile(relativePath, 'utf8');
+    return parseFeature(relativePath, source, defaultLanguage);
+}
+//# sourceMappingURL=parse.js.map

package/dist/gherkin/parse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse.js","sourceRoot":"","sources":["../../src/gherkin/parse.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAC,UAAU,EAAE,0BAA0B,EAAE,MAAM,EAAC,MAAM,mBAAmB,CAAC;AACjF,OAAO,EAAC,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAE/C,OAAO,EAAC,QAAQ,EAAC,MAAM,kBAAkB,CAAC;AAG1C,OAAO,EAAC,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAC,MAAM,eAAe,CAAC;AAE3E;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,wBAAwB;IACxB,sBAAsB;IACtB,+BAA+B;IAC/B,6BAA6B;IAC7B,oBAAoB;CACZ,CAAC;AAEX,sDAAsD;AACtD,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,GAAG,eAAe,EAAE,kBAAkB,CAAU,CAAC;AAuB9E,MAAM,gBAAgB,GAAG,oDAAoD,CAAC;AAC9E,MAAM,cAAc,GAAG,2DAA2D,CAAC;AAEnF,2EAA2E;AAC3E,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAE9B,SAAS,SAAS,CAAC,eAAuB;IACxC,OAAO,IAAI,MAAM,CACf,IAAI,UAAU,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,EAClC,IAAI,0BAA0B,CAAC,eAAe,CAAC,CAChD,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,KAAc;IACjC,MAAM,GAAG,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACnE,MAAM,QAAQ,GAAI,KAAuD,CAAC,QAAQ,CAAC;IAEnF,MAAM,eAAe,GAAG,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnD,IAAI,eAAe,EAAE,CAAC;QACpB,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;YAChC,MAAM,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;YAClC,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC,IAAI,CAAC;YACzC,GAAG,EAAE,eAAe,CAAC,CAAC,CAAE;YACxB,GAAG;SACJ,CAAC;IACJ,CAAC;IAED,MAAM,aAAa,GAAG,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/C,IAAI,aAAa,EAAE,CAAC;QAClB,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;YAC9B,MAAM,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;YAChC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC,IAAI,CAAC;YACvC,GAAG,EAAE,SAAS;YACd,GAAG;SACJ,CAAC;IACJ,CAAC;IAED,OAAO;QACL,IAAI,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC;QACzB,MAAM,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;QAC7B,QAAQ,EAAE,EAAE;QACZ,GAAG,EAAE,SAAS;QACd,GAAG;KACJ,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAClB,MAAc,EACd,eAAuB;IAEvB,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,SAAS,CAAC,eAAe,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC1D,OAAO,EAAC,OAAO,EAAE,QAAQ,CAAC,OAAO,IAAI,SAAS,EAAE,UAAU,EAAE,EAAE,EAAC,CAAC;IAClE,CAAC;IAAC,OAAO,MAAM,EAAE,CAAC;QAChB,MAAM,MAAM,GAAI,MAA+B,CAAC,MAAM,CAAC;QACvD,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAC9E,OAAO,EAAC,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,EAAC,CAAC;IACnE,CAAC;AACH,CAAC;AAED,8EAA8E;AAC9E,SAAS,iBAAiB,CAAC,IAAY,EAAE,QAA2B;IAClE,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;AAC3E,CAAC;AAED;;;;;;GAMG;AACH,SAAS,oBAAoB,CAC3B,KAAwB,EACxB,IAAY,EACZ,OAAgB;IAEhB,OAAO,KAAK;SACT,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC;SAC/B,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;AACxE,CAAC;AAED,8EAA8E;AAC9E,SAAS,eAAe,CAAC,OAAgB;IACvC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC;SACzE,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,GAAG,CAAC,CAAC;SAC/F,MAAM,CAAC,CAAC,OAAO,EAAqB,EAAE,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC;AACnE,CAAC;AAED;;;;GAIG;AACH,SAAS,iBAAiB,CAAC,SAA0B,EAAE,OAAgB;IACrE,OAAO,CACL,SAAS,CAAC,GAAG,KAAK,SAAS;QAC3B,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC;QACvC,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC;QAC7C,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC;QACzC,iBAAiB,CAAC,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,UAAU,CAAC,CACrD,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,KAAwB,EAAE,IAAY;IAC9D,MAAM,MAAM,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;IAC1B,IAAI,KAAK,GAAG,IAAI,GAAG,CAAC,CAAC;IACrB,IAAI,OAAO,GAAG,KAAK,CAAC;IAEpB,OAAO,KAAK,IAAI,CAAC,EAAE,CAAC;QAClB,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAE,CAAC,IAAI,EAAE,CAAC;QACtC,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;aAAM,IAAI,OAAO,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACtD,MAAM;QACR,CAAC;QACD,KAAK,EAAE,CAAC;IACV,CAAC;IAED,OAAO,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AACtC,CAAC;AAED,SAAS,QAAQ,CACf,SAA0B,EAC1B,OAAgB,EAChB,KAAwB;IAExB,IAAI,SAAS,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;QAChC,IAAI,iBAAiB,CAAC,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YACzD,OAAO,oBAAoB,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC;gBACzD,CAAC,CAAC;oBACE,OAAO,EAAE,mEAAmE;oBAC5E,IAAI,EAAE,+BAA+B;oBACrC,IAAI,EAAE,SAAS,CAAC,IAAI;oBACpB,MAAM,EAAE,SAAS,CAAC,MAAM;iBACzB;gBACH,CAAC,CAAC;oBACE,OAAO,EAAE,6DAA6D;oBACtE,IAAI,EAAE,6BAA6B;oBACnC,IAAI,EAAE,SAAS,CAAC,IAAI;oBACpB,MAAM,EAAE,SAAS,CAAC,MAAM;iBACzB,CAAC;QACR,CAAC;QACD,IAAI,iBAAiB,CAAC,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACtD,OAAO;gBACL,OAAO,EAAE,gEAAgE;gBACzE,IAAI,EAAE,sBAAsB;gBAC5B,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,MAAM,EAAE,SAAS,CAAC,MAAM;aACzB,CAAC;QACJ,CAAC;QACD,IAAI,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,CAAC;YACnG,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;YAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,GAAG,CAAC;YACpF,OAAO;gBACL,OAAO,EAAE,2BAA2B,IAAI,kCAAkC;gBAC1E,IAAI,EAAE,oBAAoB;gBAC1B,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,MAAM,EAAE,SAAS,CAAC,MAAM;aACzB,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO;QACL,OAAO,EAAE,SAAS,CAAC,GAAG;QACtB,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,SAAS,CAAC,IAAI;QACpB,MAAM,EAAE,SAAS,CAAC,MAAM;KACzB,CAAC;AACJ,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,OAAO,CAAC,MAAc;IACpC,OAAO,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAC1B,YAAoB,EACpB,MAAc,EACd,eAAe,GAAW,gBAAgB;IAE1C,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B,MAAM,IAAI,GAAgB,EAAC,YAAY,EAAE,KAAK,EAAC,CAAC;IAChD,MAAM,OAAO,GAAG,UAAU,CAAC,cAAc,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC;IAEnE,MAAM,MAAM,GAAgB,EAAE,CAAC;IAC/B,IAAI,YAAY,GAAsB,KAAK,CAAC;IAE5C,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAAC;QAC/D,MAAM,EAAC,OAAO,EAAE,UAAU,EAAC,GAAG,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,CAAC;QAEpF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,EAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,EAAE,MAAM,EAAC,CAAC;QAC1E,CAAC;QAED,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAE,CAAC;QAC7B,IAAI,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC;YACtC,MAAM,SAAS,GAAG,gBAAgB,CAAC,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YAC7D,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,MAAM,CAAC,IAAI,CAAC;oBACV,OAAO,EAAE,oCAAoC;oBAC7C,IAAI,EAAE,wBAAwB;oBAC9B,IAAI,EAAE,KAAK,CAAC,IAAI;oBAChB,MAAM,EAAE,KAAK,CAAC,MAAM;iBACrB,CAAC,CAAC;gBACH,YAAY,GAAG,SAAS,CAAC;gBACzB,SAAS;YACX,CAAC;QACH,CAAC;QAED,MAAM,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;QAE7F,oEAAoE;QACpE,yEAAyE;QACzE,0EAA0E;QAC1E,MAAM,mBAAmB,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QAC1C,IAAI,mBAAmB,EAAE,IAAI,KAAK,6BAA6B,EAAE,CAAC;YAChE,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACjC,OAAO,EAAC,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAC,CAAC;QAC5C,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC;QAC3B,OAAO,EAAC,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAC,CAAC;IAC5C,CAAC;IAED,OAAO,EAAC,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAC,CAAC;AAC5C,CAAC;AAED,oDAAoD;AACpD,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,YAAoB,EACpB,eAAwB;IAExB,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IACpD,OAAO,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC;AAC7D,CAAC"}

package/dist/gherkin/traverse.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Walking a parsed feature.
+ *
+ * A Feature's children are Backgrounds, Scenarios and Rules, and a Rule has
+ * Backgrounds and Scenarios of its own. These helpers flatten that nesting so
+ * rules do not each have to remember that Rules exist - several of the
+ * original rules did not, and crashed on any feature file using `Rule:`.
+ */
+import type { Background, Examples, Feature, Rule, Scenario } from '@cucumber/messages';
+/** A Background or Scenario, together with the Rule containing it, if any. */
+export interface StepContainer {
+    node: Background | Scenario;
+    rule: Rule | undefined;
+}
+/** Every Rule in the feature. */
+export declare function rulesOf(feature: Feature): Generator<Rule>;
+/** Every Scenario and Scenario Outline, including those inside Rules. */
+export declare function scenariosOf(feature: Feature): Generator<{
+    scenario: Scenario;
+    rule: Rule | undefined;
+}>;
+/** Every Background, including those inside Rules. */
+export declare function backgroundsOf(feature: Feature): Generator<{
+    background: Background;
+    rule: Rule | undefined;
+}>;
+/** Every node that holds steps: Backgrounds and Scenarios, Rules included. */
+export declare function stepContainersOf(feature: Feature): Generator<StepContainer>;
+/** Anything a tag may be written on. */
+export type TaggableNode = Feature | Rule | Scenario | Examples;
+/** A tagged node, with the nodes it sits inside, nearest ancestor first. */
+export interface TaggedNode {
+    node: TaggableNode;
+    /** Feature, and the Rule and Scenario Outline containing it, if any. */
+    ancestors: TaggableNode[];
+}
+/**
+ * Every node that can carry tags: the Feature, its Rules, every Scenario -
+ * inside a Rule or not - and every Examples table.
+ *
+ * Each one comes with its ancestors, so that a rule comparing a node's tags
+ * with the ones it inherits does not have to walk the tree itself.
+ */
+export declare function taggedNodesOf(feature: Feature): Generator<TaggedNode>;
+//# sourceMappingURL=traverse.d.ts.map

package/dist/gherkin/traverse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traverse.d.ts","sourceRoot":"","sources":["../../src/gherkin/traverse.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,KAAK,EAAC,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAC,MAAM,oBAAoB,CAAC;AAEtF,8EAA8E;AAC9E,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,UAAU,GAAG,QAAQ,CAAC;IAC5B,IAAI,EAAE,IAAI,GAAG,SAAS,CAAC;CACxB;AAED,iCAAiC;AACjC,wBAAiB,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,CAM1D;AAED,yEAAyE;AACzE,wBAAiB,WAAW,CAC1B,OAAO,EAAE,OAAO,GACf,SAAS,CAAC;IAAC,QAAQ,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,IAAI,GAAG,SAAS,CAAA;CAAC,CAAC,CAazD;AAED,sDAAsD;AACtD,wBAAiB,aAAa,CAC5B,OAAO,EAAE,OAAO,GACf,SAAS,CAAC;IAAC,UAAU,EAAE,UAAU,CAAC;IAAC,IAAI,EAAE,IAAI,GAAG,SAAS,CAAA;CAAC,CAAC,CAa7D;AAED,8EAA8E;AAC9E,wBAAiB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,CAAC,aAAa,CAAC,CAmB5E;AAED,wCAAwC;AACxC,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,IAAI,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEhE,4EAA4E;AAC5E,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,YAAY,CAAC;IACnB,wEAAwE;IACxE,SAAS,EAAE,YAAY,EAAE,CAAC;CAC3B;AAED;;;;;;GAMG;AACH,wBAAiB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,CAAC,UAAU,CAAC,CAuBtE"}

package/dist/gherkin/traverse.js

@@ -0,0 +1,89 @@
+/** Every Rule in the feature. */
+export function* rulesOf(feature) {
+    for (const child of feature.children) {
+        if (child.rule !== undefined) {
+            yield child.rule;
+        }
+    }
+}
+/** Every Scenario and Scenario Outline, including those inside Rules. */
+export function* scenariosOf(feature) {
+    for (const child of feature.children) {
+        if (child.scenario !== undefined) {
+            yield { scenario: child.scenario, rule: undefined };
+        }
+        if (child.rule !== undefined) {
+            for (const grandchild of child.rule.children) {
+                if (grandchild.scenario !== undefined) {
+                    yield { scenario: grandchild.scenario, rule: child.rule };
+                }
+            }
+        }
+    }
+}
+/** Every Background, including those inside Rules. */
+export function* backgroundsOf(feature) {
+    for (const child of feature.children) {
+        if (child.background !== undefined) {
+            yield { background: child.background, rule: undefined };
+        }
+        if (child.rule !== undefined) {
+            for (const grandchild of child.rule.children) {
+                if (grandchild.background !== undefined) {
+                    yield { background: grandchild.background, rule: child.rule };
+                }
+            }
+        }
+    }
+}
+/** Every node that holds steps: Backgrounds and Scenarios, Rules included. */
+export function* stepContainersOf(feature) {
+    for (const child of feature.children) {
+        if (child.background !== undefined) {
+            yield { node: child.background, rule: undefined };
+        }
+        if (child.scenario !== undefined) {
+            yield { node: child.scenario, rule: undefined };
+        }
+        if (child.rule !== undefined) {
+            for (const grandchild of child.rule.children) {
+                if (grandchild.background !== undefined) {
+                    yield { node: grandchild.background, rule: child.rule };
+                }
+                if (grandchild.scenario !== undefined) {
+                    yield { node: grandchild.scenario, rule: child.rule };
+                }
+            }
+        }
+    }
+}
+/**
+ * Every node that can carry tags: the Feature, its Rules, every Scenario -
+ * inside a Rule or not - and every Examples table.
+ *
+ * Each one comes with its ancestors, so that a rule comparing a node's tags
+ * with the ones it inherits does not have to walk the tree itself.
+ */
+export function* taggedNodesOf(feature) {
+    yield { node: feature, ancestors: [] };
+    function* scenarios(scenario, ancestors) {
+        yield { node: scenario, ancestors };
+        for (const examples of scenario.examples) {
+            yield { node: examples, ancestors: [scenario, ...ancestors] };
+        }
+    }
+    for (const child of feature.children) {
+        if (child.scenario !== undefined) {
+            yield* scenarios(child.scenario, [feature]);
+        }
+        if (child.rule !== undefined) {
+            yield { node: child.rule, ancestors: [feature] };
+            for (const grandchild of child.rule.children) {
+                if (grandchild.scenario !== undefined) {
+                    yield* scenarios(grandchild.scenario, [child.rule, feature]);
+                }
+            }
+        }
+    }
+}
+//# sourceMappingURL=traverse.js.map

package/dist/gherkin/traverse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"traverse.js","sourceRoot":"","sources":["../../src/gherkin/traverse.ts"],"names":[],"mappings":"AAgBA,iCAAiC;AACjC,MAAM,SAAS,CAAC,CAAC,OAAO,CAAC,OAAgB;IACvC,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrC,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,KAAK,CAAC,IAAI,CAAC;QACnB,CAAC;IACH,CAAC;AACH,CAAC;AAED,yEAAyE;AACzE,MAAM,SAAS,CAAC,CAAC,WAAW,CAC1B,OAAgB;IAEhB,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrC,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,EAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAC,CAAC;QACpD,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC7B,KAAK,MAAM,UAAU,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAC7C,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;oBACtC,MAAM,EAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAC,CAAC;gBAC1D,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,sDAAsD;AACtD,MAAM,SAAS,CAAC,CAAC,aAAa,CAC5B,OAAgB;IAEhB,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrC,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,EAAC,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,SAAS,EAAC,CAAC;QACxD,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC7B,KAAK,MAAM,UAAU,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAC7C,IAAI,UAAU,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;oBACxC,MAAM,EAAC,UAAU,EAAE,UAAU,CAAC,UAAU,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAC,CAAC;gBAC9D,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,8EAA8E;AAC9E,MAAM,SAAS,CAAC,CAAC,gBAAgB,CAAC,OAAgB;IAChD,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrC,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,EAAC,IAAI,EAAE,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,SAAS,EAAC,CAAC;QAClD,CAAC;QACD,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,EAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAC,CAAC;QAChD,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC7B,KAAK,MAAM,UAAU,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAC7C,IAAI,UAAU,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;oBACxC,MAAM,EAAC,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAC,CAAC;gBACxD,CAAC;gBACD,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;oBACtC,MAAM,EAAC,IAAI,EAAE,UAAU,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAC,CAAC;gBACtD,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAYD;;;;;;GAMG;AACH,MAAM,SAAS,CAAC,CAAC,aAAa,CAAC,OAAgB;IAC7C,MAAM,EAAC,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,EAAC,CAAC;IAErC,QAAQ,CAAC,CAAC,SAAS,CAAC,QAAkB,EAAE,SAAyB;QAC/D,MAAM,EAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAC,CAAC;QAClC,KAAK,MAAM,QAAQ,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;YACzC,MAAM,EAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,EAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAED,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrC,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACjC,KAAK,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;QAC9C,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,EAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,OAAO,CAAC,EAAC,CAAC;YAC/C,KAAK,MAAM,UAAU,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAC7C,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;oBACtC,KAAK,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;gBAC/D,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/gherkin/variables.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Finding the `<placeholder>` variables of a Scenario Outline.
+ *
+ * A Scenario Outline declares its variables as the columns of an Examples
+ * table, and uses them in step text, step arguments and its own name. Two
+ * rules care about the difference between the two sets, so the gathering is
+ * done once here.
+ */
+import type { Scenario } from '@cucumber/messages';
+/** Where a variable was seen: the node holding it. */
+export interface Position {
+    line: number;
+    column?: number;
+}
+/** Variable name -> every place it appears. */
+export type Sightings = Map<string, Position[]>;
+/** What a Scenario Outline declares, and what it actually uses. */
+export interface ScenarioVariables {
+    /** Column names, against the Examples header cells declaring them. */
+    declared: Sightings;
+    /** Variable names, against every node using them. */
+    used: Sightings;
+}
+/** Gathers the variables a Scenario Outline declares and the ones it uses. */
+export declare function variablesOf(scenario: Scenario): ScenarioVariables;
+//# sourceMappingURL=variables.d.ts.map

package/dist/gherkin/variables.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"variables.d.ts","sourceRoot":"","sources":["../../src/gherkin/variables.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,oBAAoB,CAAC;AAMjD,sDAAsD;AACtD,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,+CAA+C;AAC/C,MAAM,MAAM,SAAS,GAAG,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;AAEhD,mEAAmE;AACnE,MAAM,WAAW,iBAAiB;IAChC,sEAAsE;IACtE,QAAQ,EAAE,SAAS,CAAC;IACpB,qDAAqD;IACrD,IAAI,EAAE,SAAS,CAAC;CACjB;AAwBD,8EAA8E;AAC9E,wBAAgB,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,iBAAiB,CA8BjE"}