gurkencheck 0.0.4

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2016, Vasiliki Siakka
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,327 @@
+# gurkencheck
+
+[![CI](https://github.com/sebs/gurkencheck/actions/workflows/ci.yml/badge.svg)](https://github.com/sebs/gurkencheck/actions/workflows/ci.yml)
+[![npm](https://img.shields.io/npm/v/gurkencheck.svg)](https://www.npmjs.com/package/gurkencheck)
+
+A linter for Gherkin feature files. It reads your `.feature` files and tells you where
+they drift from the conventions your team has agreed on.
+
+**[Documentation](https://sebs.github.io/gurkencheck/)** — every rule has its own
+page with an example that passes and one that fails.
+
+## Install
+
+```sh
+npm install --save-dev gurkencheck
+```
+
+Requires Node.js 22 or newer.
+
+## Get started
+
+Just run it:
+
+```sh
+npx gurkencheck
+```
+
+With no configuration file, gurkencheck uses its **recommended** rules: the ones 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 that set depends on how you lay a file
+out, so it should be quiet on a codebase that has never been linted.
+
+When you want something different, create a `.gurkencheckrc` and list the rules you want. A
+configuration file replaces the recommended set rather than adding to it, so every rule is
+off until you switch it on:
+
+```jsonc
+{
+  "no-unnamed-features": "on",
+  "no-unnamed-scenarios": "on",
+  "no-trailing-spaces": "on",
+  "indentation": ["on", {"Feature": 0, "Scenario": 2, "Step": 4}]
+}
+```
+
+With no paths given it searches the current directory for `.feature` files.
+
+| Exit code | Meaning |
+|---|---|
+| `0` | Nothing worse than a warning |
+| `1` | At least one rule set to `"on"` was broken |
+| `2` | The linter could not run: bad arguments, or an invalid config |
+
+Findings go to **stdout**, so `gurkencheck > report.json` and `gurkencheck | less` work.
+Anything that stops the linter running — a bad option, an invalid config — goes to stderr.
+
+A rule is set to `"on"`, `"warn"` or `"off"`. `"warn"` reports exactly the same findings but
+does not fail the run — for a rule the team is working towards rather than enforcing:
+
+```json
+{"no-unnamed-scenarios": "on", "use-and": "warn"}
+```
+
+## Command line
+
+```
+gurkencheck [options] <feature-files>
+
+  -f, --format <format>   output format: stylish, json, junit, sarif, tap,
+                          or the path to a formatter of your own
+                          (default: stylish)
+  -c, --config <path>     configuration file (default: .gurkencheckrc)
+  -i, --ignore <globs>    comma separated globs to skip, overriding .gurkencheckignore
+  -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
+```
+
+## Rules
+
+There are 33 rules you switch on, covering naming, tags, indentation, structure and size,
+plus four that are always on because Gherkin itself refuses to read a file that breaks
+them. Each one is documented at
+**[sebs.github.io/gurkencheck](https://sebs.github.io/gurkencheck/)** with a
+good and a bad example.
+
+The configuration file is JSON and may contain comments. A rule is either a state:
+
+```json
+{"no-empty-file": "on"}
+```
+
+or a state plus that rule's own settings:
+
+```json
+{"name-length": ["on", {"Feature": 70, "Scenario": 70, "Step": 70}]}
+```
+
+Mistyped rule names and settings are reported before any file is read.
+
+## Reporting to GitHub code scanning
+
+`--format sarif` writes a SARIF 2.1.0 log, which GitHub reads directly:
+
+```yaml
+- run: npx gurkencheck --format sarif > gurkencheck.sarif
+  continue-on-error: true
+
+- uses: github/codeql-action/upload-sarif@v3
+  with:
+    sarif_file: gurkencheck.sarif
+```
+
+Paths in the log are relative to the directory gurkencheck ran in, which is what code
+scanning needs to match a finding to a file in the repository.
+
+## Switching a rule off for one place
+
+Write a comment in the feature file:
+
+```gherkin
+# gurkencheck-disable-next-line name-length
+  Scenario: A name that is long for a good reason and stays that way
+
+# gurkencheck-disable use-and, name-length
+  ... everything below here skips those two rules ...
+# gurkencheck-enable use-and
+
+# gurkencheck-disable-file no-trailing-spaces
+```
+
+| Directive | What it covers |
+|---|---|
+| `gurkencheck-disable-next-line` | The line directly below the comment |
+| `gurkencheck-disable` | From the comment to the end of the file, or to the next `gurkencheck-enable` |
+| `gurkencheck-enable` | Resumes the rules a `gurkencheck-disable` switched off |
+| `gurkencheck-disable-file` | The whole file, wherever the comment appears |
+
+Name the rules you mean, separated by commas or spaces; a directive naming no rules covers
+all of them. Comments inside a doc string are text and are left alone. The four always-on
+rules cannot be switched off this way — a file that breaks one of them cannot be read at
+all, so hiding the message would leave nothing in its place.
+
+## Feature files in another language
+
+Gherkin is translated into dozens of languages. A file says which one it is written in with
+a header on its first line:
+
+```gherkin
+# language: fr
+Fonctionnalité: Se déconnecter
+
+  Scénario: Se déconnecter
+    Quand Ulrick se déconnecte
+```
+
+If every file in your project is written in the same language, set it once instead — with
+`--language fr` or a `language` key in your configuration file. A header in a file always
+wins over that setting, so a project can be mostly one language with exceptions.
+
+## Sharing a configuration
+
+Build on top of another configuration with `extends`. What your file says wins over what it
+extends, and later entries in a list win over earlier ones.
+
+```jsonc
+{
+  "extends": "gurkencheck:recommended",
+  "indentation": ["on", {"Step": 4}],
+  "no-trailing-spaces": "off"
+}
+```
+
+| Entry | What it means |
+|---|---|
+| `gurkencheck:recommended` | The built-in recommended rules |
+| `./team/.gurkencheckrc` | Another file, resolved from the file doing the extending |
+| `@acme/gurkencheck-config` | An installed package exporting a configuration, as JSON or as a module |
+
+## Skipping files
+
+Put one glob per line in a `.gurkencheckignore` file, or pass `--ignore` on the command
+line. Without either, `node_modules` is skipped and everything else is checked.
+
+A pattern that matches a directory skips everything below it, as in `.gitignore` and
+`.eslintignore`, so `build` is enough and you do not have to write `build/**`. Blank lines
+and lines starting with `#` are ignored.
+
+## Custom formatters
+
+Pass a path or a package name to `--format`. The module exports a function taking the
+results; it may print the output itself, or return a string and let gurkencheck print it.
+
+```js
+// count.mjs
+export default function count(results) {
+  const findings = results.reduce((total, file) => total + file.errors.length, 0);
+  return `${findings} findings in ${results.length} files`;
+}
+```
+
+```sh
+npx gurkencheck --format ./count.mjs
+```
+
+Each result is `{filePath, errors}`, and each error is
+`{message, rule, line, column, severity}`. A default export, a `printResults` export, or a
+module that is itself the function all work.
+
+## Custom rules
+
+Point `--rulesdir` at a directory of your own modules. Each exports an object with a
+`name` and a `run` function, and is called once per file. CommonJS, ES modules and
+TypeScript all work.
+
+```js
+// rules/no-lorem.js
+const name = 'no-lorem';
+
+export default {
+  name,
+  run(feature, file) {
+    if (feature === undefined) return [];
+    return feature.children
+      .filter((child) => child.scenario?.name.includes('lorem'))
+      .map((child) => ({
+        message: 'Placeholder text left in a scenario name',
+        rule: name,
+        line: child.scenario.location.line,
+      }));
+  },
+};
+```
+
+```sh
+npx gurkencheck --rulesdir ./rules
+```
+
+A custom rule may reuse a built-in rule's name to replace it.
+
+`run` may also be `async` and return a promise, for a rule that has to wait for
+something — reading a file, or asking an issue tracker whether a tag refers to a real
+ticket. Files are checked one after another, so rules see a predictable order.
+
+## Using it 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);
+}
+```
+
+Each error carries `message`, `rule`, `line` and, where the rule knows one, `column` —
+both 1-based, so an editor can underline exactly the right text. Errors about a whole file
+or a whole line, such as a missing new line at the end of the file, have no `column`.
+
+Nothing in the library writes to the console or exits the process; that is the command
+line's job.
+
+## Developing
+
+The project is TypeScript with two runtime dependencies:
+[`@cucumber/gherkin`](https://github.com/cucumber/gherkin) and its own `@cucumber/messages`.
+Everything else — argument parsing, globbing, JSON-with-comments, XML output, the
+collection helpers — is plain TypeScript in `src/util`. Tests run on node's built-in test
+runner, straight off the sources using node's type stripping, so there is no build step
+to run before testing.
+
+```sh
+npm test              # node --test over test/**/*.test.ts
+npm run coverage      # the same, with node's coverage reporter
+npm run typecheck     # tsc over src, test, site and scripts
+npm run build         # compile src into dist
+npm run docs          # regenerate the documentation site into docs/
+npm run demo          # lint the deliberately broken files in examples/
+```
+
+### Releasing
+
+Versions are bumped and tagged locally; everything after that is a workflow.
+
+```sh
+npm version patch        # bumps package.json, commits, and tags v0.0.4
+git push --follow-tags
+```
+
+Pushing the tag runs two workflows:
+
+| Workflow | Trigger | What it does |
+|---|---|---|
+| **Release** | the tag | Checks the tag matches `package.json`, runs the tests, builds, and creates the GitHub release with the npm tarball attached |
+| **Pages** | the tag | Builds the documentation site from that version and deploys it |
+
+Publishing to npm is deliberately a separate step, so a release can be looked at before it
+goes out. Run the **Publish** workflow by hand and give it the version — it checks out that
+tag, re-runs the tests, and publishes with provenance. There is no `NPM_TOKEN` in the
+repository: npm Trusted Publishing mints a short-lived credential for the run.
+
+The site is not committed. `docs/` is generated during the Pages run, so the published site
+always matches the version it was built from. Run the Pages workflow by hand with a version
+to re-publish or to roll the site back; leave the version empty to publish from the branch
+you run it on, which is useful for previewing a docs change.
+
+### Adding a rule
+
+1. Add `src/rules/<name>.ts`, exporting a default object with `name` and `run`.
+2. Run `npm run generate:rules` to add it to the registry.
+3. Add `test/rules/<name>/<name>.test.ts` and its fixtures.
+4. Add an entry to `site/content.ts` and run `npm run docs`.
+
+Steps 2 and 4 are enforced by tests, so a rule cannot ship undocumented or unregistered.
+
+## History
+
+gurkencheck is a fork of [gherkin-lint](https://github.com/gherkin-lint/gherkin-lint),
+rewritten in TypeScript. See [MIGRATING.md](MIGRATING.md) if you are coming from it.
+
+## Licence
+
+ISC. See [LICENSE](LICENSE).

package/dist/config-parser.d.ts

@@ -0,0 +1,21 @@
+import type { Configuration, RuleRegistry } from './types.ts';
+/** The configuration file looked for when none is given on the command line. */
+export declare const DEFAULT_CONFIG_FILE_NAME = ".gurkencheckrc";
+/** Either a usable configuration, or the reason there isn't one. */
+export type ConfigurationResult = {
+    ok: true;
+    configuration: Configuration;
+    source: string;
+    language?: string;
+} | {
+    ok: false;
+    message: string;
+    details: string[];
+};
+/**
+ * Reads the configuration file at `configPath`, or the default file in the
+ * working directory when no path is given. With neither, the recommended
+ * rules are used.
+ */
+export declare function readConfiguration(configPath: string | undefined, rules: RuleRegistry): Promise<ConfigurationResult>;
+//# sourceMappingURL=config-parser.d.ts.map

package/dist/config-parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-parser.d.ts","sourceRoot":"","sources":["../src/config-parser.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAC,aAAa,EAAE,YAAY,EAAC,MAAM,YAAY,CAAC;AAG5D,gFAAgF;AAChF,eAAO,MAAM,wBAAwB,mBAAmB,CAAC;AAQzD,oEAAoE;AACpE,MAAM,MAAM,mBAAmB,GAC3B;IAAC,EAAE,EAAE,IAAI,CAAC;IAAC,aAAa,EAAE,aAAa,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAC,GAC3E;IAAC,EAAE,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,EAAE,CAAA;CAAC,CAAC;AA6HpD;;;;GAIG;AACH,wBAAsB,iBAAiB,CACrC,UAAU,EAAE,MAAM,GAAG,SAAS,EAC9B,KAAK,EAAE,YAAY,GAClB,OAAO,CAAC,mBAAmB,CAAC,CAqD9B"}

package/dist/config-parser.js

@@ -0,0 +1,171 @@
+var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExtension) || function (path, preserveJsx) {
+    if (typeof path === "string" && /^\.\.?\//.test(path)) {
+        return path.replace(/\.(tsx)$|((?:\.d)?)((?:\.[^./]+?)?)\.([cm]?)ts$/i, function (m, tsx, d, ext, cm) {
+            return tsx ? preserveJsx ? ".jsx" : ".js" : d && (!ext || !cm) ? m : (d + ext + "." + cm.toLowerCase() + "js");
+        });
+    }
+    return path;
+};
+/**
+ * Reading and validating the configuration file.
+ */
+import fs from 'node:fs';
+import { createRequire } from 'node:module';
+import path from 'node:path';
+import { pathToFileURL } from 'node:url';
+import { verifyConfiguration } from './config-verifier.js';
+import { PRESETS, RECOMMENDED } from './presets.js';
+import { stripJsonComments } from './util/json.js';
+/** The configuration file looked for when none is given on the command line. */
+export const DEFAULT_CONFIG_FILE_NAME = '.gurkencheckrc';
+/** The key naming the configurations to build on top of. */
+const EXTENDS = 'extends';
+/** The key setting the dialect for files with no `# language:` header. */
+const LANGUAGE = 'language';
+class ConfigurationError extends Error {
+}
+function isConfigurationObject(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+function parseFile(filePath) {
+    let parsed;
+    try {
+        parsed = JSON.parse(stripJsonComments(fs.readFileSync(filePath, 'utf8')));
+    }
+    catch (thrown) {
+        throw new ConfigurationError(`Could not parse "${filePath}": ${thrown instanceof Error ? thrown.message : String(thrown)}`);
+    }
+    if (!isConfigurationObject(parsed)) {
+        throw new ConfigurationError(`"${filePath}" must hold a JSON object mapping rule names to their settings.`);
+    }
+    return parsed;
+}
+/** The `extends` entries of a configuration, as a list. */
+function extendsList(configuration, source) {
+    const value = configuration[EXTENDS];
+    if (value === undefined) {
+        return [];
+    }
+    if (typeof value === 'string') {
+        return [value];
+    }
+    if (Array.isArray(value) && value.every((entry) => typeof entry === 'string')) {
+        return value;
+    }
+    throw new ConfigurationError(`"${EXTENDS}" in "${source}" must be a name or a list of names.`);
+}
+/**
+ * Loads what one `extends` entry refers to: a built-in preset, another
+ * configuration file, or a package.
+ *
+ * Packages and relative paths are resolved from the file doing the extending,
+ * so a shared configuration installed in a project is found where you would
+ * expect and a relative path means what it looks like.
+ */
+async function loadExtended(specifier, fromFile) {
+    const preset = PRESETS[specifier];
+    if (preset !== undefined) {
+        return { configuration: preset, source: specifier };
+    }
+    if (specifier.startsWith('gurkencheck:')) {
+        throw new ConfigurationError(`There is no built-in configuration called "${specifier}". Available: ${Object.keys(PRESETS).join(', ')}`);
+    }
+    const from = path.resolve(fromFile);
+    if (specifier.startsWith('.') || path.isAbsolute(specifier)) {
+        const resolved = path.resolve(path.dirname(from), specifier);
+        if (!fs.existsSync(resolved)) {
+            throw new ConfigurationError(`Could not find "${specifier}", extended from "${fromFile}".`);
+        }
+        return { configuration: parseFile(resolved), source: resolved };
+    }
+    let resolved;
+    try {
+        resolved = createRequire(pathToFileURL(from)).resolve(specifier);
+    }
+    catch {
+        throw new ConfigurationError(`Could not resolve the package "${specifier}", extended from "${fromFile}". Is it installed?`);
+    }
+    if (resolved.endsWith('.json')) {
+        return { configuration: parseFile(resolved), source: resolved };
+    }
+    const module = (await import(__rewriteRelativeImportExtension(pathToFileURL(resolved).href)));
+    const exported = module['default'] ?? module;
+    if (!isConfigurationObject(exported)) {
+        throw new ConfigurationError(`"${specifier}" does not export a configuration object.`);
+    }
+    return { configuration: exported, source: resolved };
+}
+/**
+ * Flattens a configuration and everything it extends into one object. What a
+ * file says wins over what it extends, and later entries in an `extends` list
+ * win over earlier ones.
+ */
+async function flatten(configuration, source, seen) {
+    if (seen.has(source)) {
+        throw new ConfigurationError(`"${source}" ends up extending itself.`);
+    }
+    seen.add(source);
+    let merged = {};
+    for (const specifier of extendsList(configuration, source)) {
+        const extended = await loadExtended(specifier, source);
+        merged = { ...merged, ...(await flatten(extended.configuration, extended.source, seen)) };
+    }
+    const own = { ...configuration };
+    delete own[EXTENDS];
+    return { ...merged, ...own };
+}
+/**
+ * Reads the configuration file at `configPath`, or the default file in the
+ * working directory when no path is given. With neither, the recommended
+ * rules are used.
+ */
+export async function readConfiguration(configPath, rules) {
+    if (configPath !== undefined) {
+        if (!fs.existsSync(configPath)) {
+            return {
+                ok: false,
+                message: `Could not find specified config file "${configPath}"`,
+                details: [],
+            };
+        }
+    }
+    else {
+        if (!fs.existsSync(DEFAULT_CONFIG_FILE_NAME)) {
+            // Nothing to read, so fall back to the recommended rules rather than
+            // refusing to run. Writing a configuration file is then a way to change
+            // the defaults, not a hurdle before the first run.
+            return { ok: true, configuration: RECOMMENDED, source: 'the recommended preset' };
+        }
+        configPath = DEFAULT_CONFIG_FILE_NAME;
+    }
+    let flattened;
+    try {
+        flattened = await flatten(parseFile(configPath), configPath, new Set());
+    }
+    catch (thrown) {
+        if (thrown instanceof ConfigurationError) {
+            return {
+                ok: false,
+                message: `Could not read config file "${configPath}"`,
+                details: [thrown.message],
+            };
+        }
+        throw thrown;
+    }
+    // "language" is a setting rather than a rule, so it is taken out before the
+    // rest is checked against the rule list.
+    const { [LANGUAGE]: language, ...configuration } = flattened;
+    if (language !== undefined && typeof language !== 'string') {
+        return {
+            ok: false,
+            message: `Could not read config file "${configPath}"`,
+            details: [`"${LANGUAGE}" must be a language code, such as "fr".`],
+        };
+    }
+    const errors = verifyConfiguration(configuration, rules);
+    if (errors.length > 0) {
+        return { ok: false, message: 'Error(s) in configuration file:', details: errors };
+    }
+    return { ok: true, configuration, source: configPath, ...(language === undefined ? {} : { language }) };
+}
+//# sourceMappingURL=config-parser.js.map

package/dist/config-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-parser.js","sourceRoot":"","sources":["../src/config-parser.ts"],"names":[],"mappings":";;;;;;;;AAAA;;GAEG;AACH,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAC,aAAa,EAAC,MAAM,aAAa,CAAC;AAC1C,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAC,aAAa,EAAC,MAAM,UAAU,CAAC;AACvC,OAAO,EAAC,mBAAmB,EAAC,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAC,OAAO,EAAE,WAAW,EAAC,MAAM,cAAc,CAAC;AAElD,OAAO,EAAC,iBAAiB,EAAC,MAAM,gBAAgB,CAAC;AAEjD,gFAAgF;AAChF,MAAM,CAAC,MAAM,wBAAwB,GAAG,gBAAgB,CAAC;AAEzD,4DAA4D;AAC5D,MAAM,OAAO,GAAG,SAAS,CAAC;AAE1B,0EAA0E;AAC1E,MAAM,QAAQ,GAAG,UAAU,CAAC;AAO5B,MAAM,kBAAmB,SAAQ,KAAK;CAAG;AAEzC,SAAS,qBAAqB,CAAC,KAAc;IAC3C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,SAAS,CAAC,QAAgB;IACjC,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAC5E,CAAC;IAAC,OAAO,MAAM,EAAE,CAAC;QAChB,MAAM,IAAI,kBAAkB,CAC1B,oBAAoB,QAAQ,MAAM,MAAM,YAAY,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAC9F,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,kBAAkB,CAC1B,IAAI,QAAQ,iEAAiE,CAC9E,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,2DAA2D;AAC3D,SAAS,WAAW,CAAC,aAAsC,EAAE,MAAc;IACzE,MAAM,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IACrC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,EAAE,CAAC;QAC9E,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,IAAI,kBAAkB,CAC1B,IAAI,OAAO,SAAS,MAAM,sCAAsC,CACjE,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,UAAU,YAAY,CACzB,SAAiB,EACjB,QAAgB;IAEhB,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAClC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,EAAC,aAAa,EAAE,MAAiC,EAAE,MAAM,EAAE,SAAS,EAAC,CAAC;IAC/E,CAAC;IACD,IAAI,SAAS,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,kBAAkB,CAC1B,8CAA8C,SAAS,iBAAiB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC1G,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEpC,IAAI,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,kBAAkB,CAC1B,mBAAmB,SAAS,qBAAqB,QAAQ,IAAI,CAC9D,CAAC;QACJ,CAAC;QACD,OAAO,EAAC,aAAa,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAC,CAAC;IAChE,CAAC;IAED,IAAI,QAAgB,CAAC;IACrB,IAAI,CAAC;QACH,QAAQ,GAAG,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACnE,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,kBAAkB,CAC1B,kCAAkC,SAAS,qBAAqB,QAAQ,qBAAqB,CAC9F,CAAC;IACJ,CAAC;IAED,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/B,OAAO,EAAC,aAAa,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAC,CAAC;IAChE,CAAC;IAED,MAAM,MAAM,GAAG,CAAC,MAAM,MAAM,kCAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAC,CAA4B,CAAC;IACvF,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,MAAM,CAAC;IAC7C,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,kBAAkB,CAC1B,IAAI,SAAS,2CAA2C,CACzD,CAAC;IACJ,CAAC;IACD,OAAO,EAAC,aAAa,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAC,CAAC;AACrD,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,OAAO,CACpB,aAAsC,EACtC,MAAc,EACd,IAAiB;IAEjB,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,kBAAkB,CAAC,IAAI,MAAM,6BAA6B,CAAC,CAAC;IACxE,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAEjB,IAAI,MAAM,GAAkB,EAAE,CAAC;IAC/B,KAAK,MAAM,SAAS,IAAI,WAAW,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC;QAC3D,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QACvD,MAAM,GAAG,EAAC,GAAG,MAAM,EAAE,GAAG,CAAC,MAAM,OAAO,CAAC,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EAAC,CAAC;IAC1F,CAAC;IAED,MAAM,GAAG,GAAG,EAAC,GAAG,aAAa,EAAC,CAAC;IAC/B,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC;IACpB,OAAO,EAAC,GAAG,MAAM,EAAE,GAAI,GAAqB,EAAC,CAAC;AAChD,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,UAA8B,EAC9B,KAAmB;IAEnB,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/B,OAAO;gBACL,EAAE,EAAE,KAAK;gBACT,OAAO,EAAE,yCAAyC,UAAU,GAAG;gBAC/D,OAAO,EAAE,EAAE;aACZ,CAAC;QACJ,CAAC;IACH,CAAC;SAAM,CAAC;QACN,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,wBAAwB,CAAC,EAAE,CAAC;YAC7C,qEAAqE;YACrE,wEAAwE;YACxE,mDAAmD;YACnD,OAAO,EAAC,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,EAAE,wBAAwB,EAAC,CAAC;QAClF,CAAC;QACD,UAAU,GAAG,wBAAwB,CAAC;IACxC,CAAC;IAED,IAAI,SAAwB,CAAC;IAC7B,IAAI,CAAC;QACH,SAAS,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,UAAU,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IAC1E,CAAC;IAAC,OAAO,MAAM,EAAE,CAAC;QAChB,IAAI,MAAM,YAAY,kBAAkB,EAAE,CAAC;YACzC,OAAO;gBACL,EAAE,EAAE,KAAK;gBACT,OAAO,EAAE,+BAA+B,UAAU,GAAG;gBACrD,OAAO,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC;aAC1B,CAAC;QACJ,CAAC;QACD,MAAM,MAAM,CAAC;IACf,CAAC;IAED,4EAA4E;IAC5E,yCAAyC;IACzC,MAAM,EAAC,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,GAAG,aAAa,EAAC,GAAG,SAEhD,CAAC;IAEF,IAAI,QAAQ,KAAK,SAAS,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC3D,OAAO;YACL,EAAE,EAAE,KAAK;YACT,OAAO,EAAE,+BAA+B,UAAU,GAAG;YACrD,OAAO,EAAE,CAAC,IAAI,QAAQ,0CAA0C,CAAC;SAClE,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAG,mBAAmB,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;IACzD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,EAAC,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,iCAAiC,EAAE,OAAO,EAAE,MAAM,EAAC,CAAC;IAClF,CAAC;IAED,OAAO,EAAC,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,QAAQ,EAAC,CAAC,EAAC,CAAC;AACtG,CAAC"}

package/dist/config-verifier.d.ts

@@ -0,0 +1,4 @@
+import type { Configuration, RuleRegistry } from './types.ts';
+/** Returns a list of problems; an empty list means the file is usable. */
+export declare function verifyConfiguration(configuration: Configuration, rules: RuleRegistry): string[];
+//# sourceMappingURL=config-verifier.d.ts.map

package/dist/config-verifier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-verifier.d.ts","sourceRoot":"","sources":["../src/config-verifier.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAC,aAAa,EAAE,YAAY,EAAC,MAAM,YAAY,CAAC;AAmD5D,0EAA0E;AAC1E,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,aAAa,EAAE,KAAK,EAAE,YAAY,GAAG,MAAM,EAAE,CA6C/F"}

package/dist/config-verifier.js

@@ -0,0 +1,81 @@
+/**
+ * Checking a configuration file before anything is linted, so that a typo in
+ * a rule name is reported once and clearly rather than silently ignored.
+ */
+import { ALWAYS_ON_RULES } from './gherkin/parse.js';
+const STATES = ['on', 'warn', 'off'];
+function describeAllowed(availableConfigs) {
+    if (Array.isArray(availableConfigs)) {
+        return availableConfigs.map((value) => `"${String(value)}"`).join(', ');
+    }
+    if (typeof availableConfigs === 'object' && availableConfigs !== null) {
+        return Object.keys(availableConfigs)
+            .map((key) => `"${key}"`)
+            .join(', ');
+    }
+    return '';
+}
+function verifySettings(ruleName, availableConfigs, settings, errors) {
+    const prefix = `Invalid rule configuration for "${ruleName}" - `;
+    if (availableConfigs === undefined) {
+        return;
+    }
+    if (Array.isArray(availableConfigs)) {
+        // The rule takes one value out of a fixed list, e.g. "yes" or "no".
+        if (!availableConfigs.includes(settings)) {
+            errors.push(`${prefix}"${String(settings)}" is not one of the allowed values: ${describeAllowed(availableConfigs)}`);
+        }
+        return;
+    }
+    if (typeof settings !== 'object' || settings === null || Array.isArray(settings)) {
+        errors.push(`${prefix}the settings should be an object with one or more of: ${describeAllowed(availableConfigs)}`);
+        return;
+    }
+    const allowedKeys = new Set(Object.keys(availableConfigs));
+    for (const key of Object.keys(settings)) {
+        if (!allowedKeys.has(key)) {
+            errors.push(`${prefix}the rule has no setting called "${key}". Available settings: ${describeAllowed(availableConfigs)}`);
+        }
+    }
+}
+/** Returns a list of problems; an empty list means the file is usable. */
+export function verifyConfiguration(configuration, rules) {
+    const errors = [];
+    for (const [ruleName, ruleConfig] of Object.entries(configuration)) {
+        const rule = rules.get(ruleName);
+        const prefix = `Invalid rule configuration for "${ruleName}" - `;
+        if (rule === undefined) {
+            // The rules the parser enforces are documented alongside the rest, so
+            // people reasonably list them. Naming one is harmless; asking for it to
+            // be off is the only thing worth saying something about.
+            if (ALWAYS_ON_RULES.includes(ruleName)) {
+                const state = Array.isArray(ruleConfig) ? ruleConfig[0] : ruleConfig;
+                if (state === 'off') {
+                    errors.push(`${prefix}this rule is always on. A file breaking it cannot be parsed at all, so there is nothing to switch off.`);
+                }
+                else if (!STATES.includes(state)) {
+                    errors.push(`${prefix}the config should be "on", "warn" or "off"`);
+                }
+                continue;
+            }
+            errors.push(`Rule "${ruleName}" does not exist`);
+            continue;
+        }
+        if (!Array.isArray(ruleConfig)) {
+            if (!STATES.includes(ruleConfig)) {
+                errors.push(`${prefix}the config should be "on", "warn" or "off"`);
+            }
+            continue;
+        }
+        if (!STATES.includes(ruleConfig[0])) {
+            errors.push(`${prefix}the first part of the config should be "on", "warn" or "off"`);
+        }
+        if (ruleConfig.length !== 2) {
+            errors.push(`${prefix}the config should have exactly 2 parts: a state and the rule's settings`);
+            continue;
+        }
+        verifySettings(ruleName, rule.availableConfigs, ruleConfig[1], errors);
+    }
+    return errors;
+}
+//# sourceMappingURL=config-verifier.js.map

package/dist/config-verifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-verifier.js","sourceRoot":"","sources":["../src/config-verifier.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAC,eAAe,EAAC,MAAM,oBAAoB,CAAC;AAGnD,MAAM,MAAM,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AAErC,SAAS,eAAe,CAAC,gBAAyB;IAChD,IAAI,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACpC,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1E,CAAC;IACD,IAAI,OAAO,gBAAgB,KAAK,QAAQ,IAAI,gBAAgB,KAAK,IAAI,EAAE,CAAC;QACtE,OAAO,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC;aACjC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,GAAG,GAAG,CAAC;aACxB,IAAI,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,cAAc,CACrB,QAAgB,EAChB,gBAAyB,EACzB,QAAiB,EACjB,MAAgB;IAEhB,MAAM,MAAM,GAAG,mCAAmC,QAAQ,MAAM,CAAC;IAEjE,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACnC,OAAO;IACT,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACpC,oEAAoE;QACpE,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzC,MAAM,CAAC,IAAI,CACT,GAAG,MAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,uCAAuC,eAAe,CAAC,gBAAgB,CAAC,EAAE,CACxG,CAAC;QACJ,CAAC;QACD,OAAO;IACT,CAAC;IAED,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjF,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,yDAAyD,eAAe,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QACnH,OAAO;IACT,CAAC;IAED,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,gBAA2C,CAAC,CAAC,CAAC;IACtF,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,mCAAmC,GAAG,0BAA0B,eAAe,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAC5H,CAAC;IACH,CAAC;AACH,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,mBAAmB,CAAC,aAA4B,EAAE,KAAmB;IACnF,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,KAAK,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;QACnE,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,mCAAmC,QAAQ,MAAM,CAAC;QAEjE,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,sEAAsE;YACtE,wEAAwE;YACxE,yDAAyD;YACzD,IAAK,eAAqC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC9D,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;gBACrE,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;oBACpB,MAAM,CAAC,IAAI,CACT,GAAG,MAAM,wGAAwG,CAClH,CAAC;gBACJ,CAAC;qBAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAe,CAAC,EAAE,CAAC;oBAC7C,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,4CAA4C,CAAC,CAAC;gBACrE,CAAC;gBACD,SAAS;YACX,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,SAAS,QAAQ,kBAAkB,CAAC,CAAC;YACjD,SAAS;QACX,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAoB,CAAC,EAAE,CAAC;gBAC3C,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,4CAA4C,CAAC,CAAC;YACrE,CAAC;YACD,SAAS;QACX,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAW,CAAC,EAAE,CAAC;YAC9C,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,8DAA8D,CAAC,CAAC;QACvF,CAAC;QACD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5B,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,yEAAyE,CAAC,CAAC;YAChG,SAAS;QACX,CAAC;QAED,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/feature-finder.d.ts

@@ -0,0 +1,18 @@
+/** The ignore file looked for when `--ignore` is not given. */
+export declare const DEFAULT_IGNORE_FILE_NAME = ".gurkencheckignore";
+/** Never worth linting, and expensive to walk into. */
+export declare const DEFAULT_IGNORED_PATTERNS: string[];
+export interface FeatureSearch {
+    /** Matching feature files, relative to the working directory. */
+    files: string[];
+    /** Arguments that were neither a feature file, a directory nor a glob. */
+    invalidPatterns: string[];
+}
+/** Reads the ignore file, one glob pattern per line, ignoring blank lines. */
+export declare function readIgnorePatterns(ignoreArgument: readonly string[] | undefined, ignoreFileName?: string): string[];
+/**
+ * Finds the feature files named by the given patterns. With no patterns, the
+ * working directory is searched recursively.
+ */
+export declare function findFeatureFiles(patterns: readonly string[], ignoreArgument?: readonly string[]): FeatureSearch;
+//# sourceMappingURL=feature-finder.d.ts.map

package/dist/feature-finder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feature-finder.d.ts","sourceRoot":"","sources":["../src/feature-finder.ts"],"names":[],"mappings":"AASA,+DAA+D;AAC/D,eAAO,MAAM,wBAAwB,uBAAuB,CAAC;AAE7D,uDAAuD;AACvD,eAAO,MAAM,wBAAwB,UAAsB,CAAC;AAE5D,MAAM,WAAW,aAAa;IAC5B,iEAAiE;IACjE,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,0EAA0E;IAC1E,eAAe,EAAE,MAAM,EAAE,CAAC;CAC3B;AA0BD,8EAA8E;AAC9E,wBAAgB,kBAAkB,CAChC,cAAc,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,EAC7C,cAAc,GAAE,MAAiC,GAChD,MAAM,EAAE,CAYV;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,SAAS,MAAM,EAAE,EAC3B,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,GACjC,aAAa,CAiBf"}