gurkencheck 0.0.6 → 0.0.7

package/dist/stats/command.js

@@ -0,0 +1,113 @@
+/**
+ * The `gurkencheck stats` subcommand.
+ *
+ * Statistics describe a suite rather than judge it, so this always exits 0
+ * once it has run: there is no threshold to fail, and nothing here should
+ * ever be the reason a build goes red. Only being unable to run at all -
+ * an option that makes no sense, a path that names nothing - fails.
+ */
+import { parseArgs } from 'node:util';
+import { EXIT_OK, EXIT_USAGE } from '../exit-codes.js';
+import { DEFAULT_IGNORE_FILE_NAME, findFeatureFiles } from '../feature-finder.js';
+import { isKnownLanguage } from '../gherkin/dialects.js';
+import { readAndParseFile } from '../gherkin/parse.js';
+import * as logger from '../logger.js';
+import { collectStatistics } from './collect.js';
+import { DEFAULT_STATS_FORMAT, DEFAULT_TOP, STATS_FORMATTERS, getStatsFormatter, } from './format/index.js';
+export function statsUsage() {
+    return [
+        'Usage: gurkencheck stats [options] <feature-files>',
+        '',
+        'Reports on the shape of your feature files: what is in them, how much of',
+        'the step vocabulary is shared, and where it has drifted apart.',
+        '',
+        'Options:',
+        `  -f, --format <format>   output format: ${Object.keys(STATS_FORMATTERS).join(', ')}`,
+        `                          (default: ${DEFAULT_STATS_FORMAT})`,
+        `  -i, --ignore <globs>    comma separated globs to skip, overriding ${DEFAULT_IGNORE_FILE_NAME}`,
+        '  -l, --language <code>   dialect for files with no "# language:" header',
+        `      --top <n>           how many entries each list shows (default: ${DEFAULT_TOP})`,
+        '  -h, --help              show this message',
+        '',
+        'With no files given, the working directory is searched recursively.',
+        'The report goes to stdout, and always exits 0: it describes the files',
+        'rather than judging them. Use the linter itself to fail a build.',
+    ].join('\n');
+}
+/** Reads and parses a file, turning a file that cannot be read into a result. */
+async function read(file, language) {
+    try {
+        return await readAndParseFile(file, language);
+    }
+    catch (thrown) {
+        return {
+            file: { relativePath: file, lines: [] },
+            feature: undefined,
+            errors: [
+                {
+                    message: thrown instanceof Error ? thrown.message : String(thrown),
+                    rule: 'unexpected-error',
+                    line: 0,
+                },
+            ],
+        };
+    }
+}
+export async function runStats(argv) {
+    let parsed;
+    try {
+        parsed = parseArgs({
+            args: [...argv],
+            options: {
+                format: { type: 'string', short: 'f' },
+                ignore: { type: 'string', short: 'i' },
+                language: { type: 'string', short: 'l' },
+                top: { type: 'string' },
+                help: { type: 'boolean', short: 'h' },
+            },
+            allowPositionals: true,
+        });
+    }
+    catch (thrown) {
+        logger.boldError(thrown instanceof Error ? thrown.message : String(thrown));
+        console.error(statsUsage());
+        return EXIT_USAGE;
+    }
+    const { values, positionals } = parsed;
+    if (values.help === true) {
+        console.log(statsUsage());
+        return EXIT_OK;
+    }
+    const formatter = getStatsFormatter(values.format);
+    if (formatter === undefined) {
+        logger.boldError(`Unsupported format "${values.format}". Use one of ${Object.keys(STATS_FORMATTERS).join(', ')}.`);
+        return EXIT_USAGE;
+    }
+    let top = DEFAULT_TOP;
+    if (values.top !== undefined) {
+        top = Number(values.top);
+        if (!Number.isInteger(top) || top < 1) {
+            logger.boldError(`--top needs a whole number of at least 1, not "${values.top}".`);
+            return EXIT_USAGE;
+        }
+    }
+    const language = values.language;
+    if (language !== undefined && !isKnownLanguage(language)) {
+        logger.boldError(`Unknown language "${language}". Use a Gherkin language code, such as "fr".`);
+        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;
+    }
+    const results = await Promise.all(files.map((file) => read(file, language)));
+    const statistics = collectStatistics(results);
+    console.log(formatter(statistics, { top }));
+    return EXIT_OK;
+}
+//# sourceMappingURL=command.js.map

package/dist/stats/command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.js","sourceRoot":"","sources":["../../src/stats/command.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EAAC,SAAS,EAAC,MAAM,WAAW,CAAC;AACpC,OAAO,EAAC,OAAO,EAAE,UAAU,EAAC,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAC,wBAAwB,EAAE,gBAAgB,EAAC,MAAM,sBAAsB,CAAC;AAChF,OAAO,EAAC,eAAe,EAAC,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAC,gBAAgB,EAAC,MAAM,qBAAqB,CAAC;AAErD,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AACvC,OAAO,EAAC,iBAAiB,EAAC,MAAM,cAAc,CAAC;AAC/C,OAAO,EACL,oBAAoB,EACpB,WAAW,EACX,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,mBAAmB,CAAC;AAE3B,MAAM,UAAU,UAAU;IACxB,OAAO;QACL,oDAAoD;QACpD,EAAE;QACF,0EAA0E;QAC1E,gEAAgE;QAChE,EAAE;QACF,UAAU;QACV,4CAA4C,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACtF,uCAAuC,oBAAoB,GAAG;QAC9D,uEAAuE,wBAAwB,EAAE;QACjG,0EAA0E;QAC1E,wEAAwE,WAAW,GAAG;QACtF,6CAA6C;QAC7C,EAAE;QACF,qEAAqE;QACrE,uEAAuE;QACvE,kEAAkE;KACnE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC;AAED,iFAAiF;AACjF,KAAK,UAAU,IAAI,CAAC,IAAY,EAAE,QAA4B;IAC5D,IAAI,CAAC;QACH,OAAO,MAAM,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAChD,CAAC;IAAC,OAAO,MAAM,EAAE,CAAC;QAChB,OAAO;YACL,IAAI,EAAE,EAAC,YAAY,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAC;YACrC,OAAO,EAAE,SAAS;YAClB,MAAM,EAAE;gBACN;oBACE,OAAO,EAAE,MAAM,YAAY,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;oBAClE,IAAI,EAAE,kBAAkB;oBACxB,IAAI,EAAE,CAAC;iBACR;aACF;SACF,CAAC;IACJ,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,IAAuB;IACpD,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,QAAQ,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAC;gBACtC,GAAG,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAC;gBACrB,IAAI,EAAE,EAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAC;aACpC;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,UAAU,EAAE,CAAC,CAAC;QAC5B,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,UAAU,EAAE,CAAC,CAAC;QAC1B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,MAAM,SAAS,GAAG,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACnD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,MAAM,CAAC,SAAS,CACd,uBAAuB,MAAM,CAAC,MAAM,iBAAiB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACjG,CAAC;QACF,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,IAAI,GAAG,GAAG,WAAW,CAAC;IACtB,IAAI,MAAM,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;QAC7B,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACzB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;YACtC,MAAM,CAAC,SAAS,CAAC,kDAAkD,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;YACnF,OAAO,UAAU,CAAC;QACpB,CAAC;IACH,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;IACjC,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,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,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC7E,MAAM,UAAU,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAE9C,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,EAAE,EAAC,GAAG,EAAC,CAAC,CAAC,CAAC;IAC1C,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/stats/format/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The formats `gurkencheck stats --format` accepts.
+ */
+import type { Statistics } from '../types.ts';
+import { toJson } from './json.ts';
+import { toMarkdown } from './markdown.ts';
+import { toText } from './text.ts';
+import type { StatsFormatOptions } from './shared.ts';
+/** Turns a finished statistics run into the text of a report. */
+export type StatsFormatter = (statistics: Statistics, options: StatsFormatOptions) => string;
+export declare const DEFAULT_STATS_FORMAT = "text";
+export declare const STATS_FORMATTERS: Record<string, StatsFormatter>;
+/**
+ * The formatter for a format name, or `undefined` when there is no such format.
+ *
+ * Asking the record for a key it does not have is not enough: every object
+ * inherits `constructor`, `toString` and the rest from its prototype, so
+ * `--format constructor` would come back with a function and be run as if it
+ * were a formatter.
+ */
+export declare function getStatsFormatter(format: string | undefined): StatsFormatter | undefined;
+export { toJson, toMarkdown, toText };
+export { DEFAULT_TOP } from './shared.ts';
+export type { StatsFormatOptions } from './shared.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/stats/format/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/stats/format/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAC,MAAM,EAAC,MAAM,WAAW,CAAC;AACjC,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AACzC,OAAO,EAAC,MAAM,EAAC,MAAM,WAAW,CAAC;AACjC,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,aAAa,CAAC;AAEpD,iEAAiE;AACjE,MAAM,MAAM,cAAc,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,kBAAkB,KAAK,MAAM,CAAC;AAE7F,eAAO,MAAM,oBAAoB,SAAS,CAAC;AAE3C,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAK3D,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,SAAS,CAGxF;AAED,OAAO,EAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAC,CAAC;AACpC,OAAO,EAAC,WAAW,EAAC,MAAM,aAAa,CAAC;AACxC,YAAY,EAAC,kBAAkB,EAAC,MAAM,aAAa,CAAC"}

package/dist/stats/format/index.js

@@ -0,0 +1,25 @@
+import { toJson } from './json.js';
+import { toMarkdown } from './markdown.js';
+import { toText } from './text.js';
+export const DEFAULT_STATS_FORMAT = 'text';
+export const STATS_FORMATTERS = {
+    text: toText,
+    json: toJson,
+    md: toMarkdown,
+    markdown: toMarkdown,
+};
+/**
+ * The formatter for a format name, or `undefined` when there is no such format.
+ *
+ * Asking the record for a key it does not have is not enough: every object
+ * inherits `constructor`, `toString` and the rest from its prototype, so
+ * `--format constructor` would come back with a function and be run as if it
+ * were a formatter.
+ */
+export function getStatsFormatter(format) {
+    const name = format ?? DEFAULT_STATS_FORMAT;
+    return Object.hasOwn(STATS_FORMATTERS, name) ? STATS_FORMATTERS[name] : undefined;
+}
+export { toJson, toMarkdown, toText };
+export { DEFAULT_TOP } from './shared.js';
+//# sourceMappingURL=index.js.map

package/dist/stats/format/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/stats/format/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,MAAM,EAAC,MAAM,WAAW,CAAC;AACjC,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AACzC,OAAO,EAAC,MAAM,EAAC,MAAM,WAAW,CAAC;AAMjC,MAAM,CAAC,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAE3C,MAAM,CAAC,MAAM,gBAAgB,GAAmC;IAC9D,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,EAAE,EAAE,UAAU;IACd,QAAQ,EAAE,UAAU;CACrB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAA0B;IAC1D,MAAM,IAAI,GAAG,MAAM,IAAI,oBAAoB,CAAC;IAC5C,OAAO,MAAM,CAAC,MAAM,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACpF,CAAC;AAED,OAAO,EAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAC,CAAC;AACpC,OAAO,EAAC,WAAW,EAAC,MAAM,aAAa,CAAC"}

package/dist/stats/format/json.d.ts

@@ -0,0 +1,10 @@
+/**
+ * The report as JSON.
+ *
+ * Nothing is cut short here: this is the format to keep alongside a build, so
+ * that a later run has something to be compared against.
+ */
+import type { Statistics } from '../types.ts';
+/** The whole report, indented so a diff of two runs is readable. */
+export declare function toJson(statistics: Statistics): string;
+//# sourceMappingURL=json.d.ts.map

package/dist/stats/format/json.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.d.ts","sourceRoot":"","sources":["../../../src/stats/format/json.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,aAAa,CAAC;AAE5C,oEAAoE;AACpE,wBAAgB,MAAM,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAErD"}

package/dist/stats/format/json.js

@@ -0,0 +1,5 @@
+/** The whole report, indented so a diff of two runs is readable. */
+export function toJson(statistics) {
+    return JSON.stringify(statistics, null, 2);
+}
+//# sourceMappingURL=json.js.map

package/dist/stats/format/json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.js","sourceRoot":"","sources":["../../../src/stats/format/json.ts"],"names":[],"mappings":"AAQA,oEAAoE;AACpE,MAAM,UAAU,MAAM,CAAC,UAAsB;IAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AAC7C,CAAC"}

package/dist/stats/format/markdown.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The report as Markdown, for pasting into a pull request or a wiki.
+ */
+import type { Statistics } from '../types.ts';
+import type { StatsFormatOptions } from './shared.ts';
+/** The report, as Markdown. */
+export declare function toMarkdown(statistics: Statistics, options: StatsFormatOptions): string;
+//# sourceMappingURL=markdown.d.ts.map

package/dist/stats/format/markdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../../src/stats/format/markdown.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAA0B,UAAU,EAAC,MAAM,aAAa,CAAC;AAErE,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,aAAa,CAAC;AA2CpD,+BAA+B;AAC/B,wBAAgB,UAAU,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAmLtF"}

package/dist/stats/format/markdown.js

@@ -0,0 +1,123 @@
+import { andMore, head, location, percent, plural, summarise } from './shared.js';
+/** A pipe inside a cell would start a column of its own. */
+function cell(text) {
+    return text.replace(/\|/gu, '\\|');
+}
+/** ``` `text` ```, so step text keeps its quotes and angle brackets. */
+function code(text) {
+    return `\`${cell(text)}\``;
+}
+function table(headings, alignments, rows) {
+    return [
+        `| ${headings.join(' | ')} |`,
+        `|${alignments.map((alignment) => (alignment === 'right' ? '---:' : '---')).join('|')}|`,
+        ...rows.map((row) => `| ${row.join(' | ')} |`),
+    ];
+}
+function more(hidden, singular) {
+    return hidden === 0 ? [] : ['', `_${andMore(hidden, singular)}._`];
+}
+function stepRows(entries, counted = true) {
+    return entries.map((entry) => [
+        code(entry.text),
+        ...(counted ? [String(entry.count)] : []),
+        cell(location(entry.file, entry.line)),
+    ]);
+}
+function similarRows(groups) {
+    return groups.flatMap((group, index) => group.members.map((member, position) => [
+        position === 0 ? String(index + 1) : '',
+        code(member.text),
+        String(member.count),
+        cell(location(member.file, member.line)),
+    ]));
+}
+/** The report, as Markdown. */
+export function toMarkdown(statistics, options) {
+    const { files, inventory, scenarios, steps, tags, languages } = statistics;
+    if (files.total === 0) {
+        return '# Feature file statistics\n\nNo feature files found.';
+    }
+    const counted = files.unreadable.length === 0
+        ? plural(files.parsed, 'file')
+        : `${files.parsed} of ${plural(files.total, 'file')}`;
+    const lines = [
+        '# Feature file statistics',
+        '',
+        [counted, plural(inventory.features, 'feature'), plural(scenarios.effective, 'test case')].join(', '),
+    ];
+    lines.push('', '## Inventory', '', ...table(['', 'Count'], ['left', 'right'], [
+        ['Features', String(inventory.features)],
+        ['Rules', String(inventory.rules)],
+        ['Backgrounds', String(inventory.backgrounds)],
+        ['Scenarios', String(inventory.scenarios)],
+        ['Scenario Outlines', String(inventory.scenarioOutlines)],
+        ['Examples tables', String(inventory.examplesTables)],
+        ['Examples rows', String(inventory.examplesRows)],
+        ['Steps, as written', String(inventory.steps)],
+        ['Data tables', String(inventory.dataTables)],
+        ['Doc strings', String(inventory.docStrings)],
+    ]));
+    lines.push('', '## Scenarios', '', `**${scenarios.effective}** test cases: one per Scenario, one per Examples row.`, '', `Steps per scenario, Background steps excluded: ${summarise(scenarios.stepsPerScenario)}`);
+    const largest = head(scenarios.largest, options.top);
+    if (largest.shown.length > 0) {
+        lines.push('', '### Longest scenarios', '', ...table(['Scenario', 'Steps', 'Where'], ['left', 'right', 'left'], largest.shown.map((scenario) => [
+            cell(scenario.name === '' ? '(unnamed)' : scenario.name),
+            String(scenario.steps),
+            cell(location(scenario.file, scenario.line)),
+        ])), ...more(largest.hidden, 'scenario'));
+    }
+    const { given, when, then, other } = steps.keywords;
+    lines.push('', '## Steps', '', ...table(['', 'Count', 'Share'], ['left', 'right', 'right'], [
+        ['Written, Background steps included', String(steps.total), ''],
+        ['Distinct after normalisation', String(steps.unique), percent(steps.unique, steps.total)],
+        ['Written exactly once', String(steps.usedOnce), percent(steps.usedOnce, steps.unique)],
+        ['Given', String(given), percent(given, steps.total)],
+        ['When', String(when), percent(when, steps.total)],
+        ['Then', String(then), percent(then, steps.total)],
+        ...(other === 0 ? [] : [['Unresolved And or But', String(other), percent(other, steps.total)]]),
+    ]));
+    lines.push('', `Words per step: ${summarise(steps.wordsPerStep)}`);
+    const mostUsed = head(steps.vocabulary.filter((entry) => entry.count > 1), options.top);
+    if (mostUsed.shown.length > 0) {
+        lines.push('', '### Most used steps', '', ...table(['Step', 'Uses', 'First seen'], ['left', 'right', 'left'], stepRows(mostUsed.shown)), ...more(mostUsed.hidden, 'step'));
+    }
+    const once = head(steps.vocabulary.filter((entry) => entry.count === 1).sort((a, b) => (a.text < b.text ? -1 : 1)), options.top);
+    if (once.shown.length > 0) {
+        lines.push('', '### Steps written exactly once', '', ...table(['Step', 'Where'], ['left', 'left'], stepRows(once.shown, false)), ...more(once.hidden, 'step'));
+    }
+    const similar = head(steps.similar, options.top);
+    if (similar.shown.length > 0) {
+        lines.push('', '### Nearly the same step, written more than one way', '', ...table(['Group', 'Step', 'Uses', 'Where'], ['right', 'left', 'right', 'left'], similarRows(similar.shown)), ...more(similar.hidden, 'group'));
+    }
+    const untagged = inventory.scenarios + inventory.scenarioOutlines;
+    lines.push('', '## Tags', '', ...table(['', 'Count'], ['left', 'right'], [
+        ['Written', String(tags.total)],
+        ['Distinct', String(tags.unique)],
+        ['Written exactly once', String(tags.usedOnce.length)],
+        [
+            'Scenarios with no tag, inherited or their own',
+            `${tags.untaggedScenarios} (${percent(tags.untaggedScenarios, untagged)})`,
+        ],
+    ]));
+    const tagsUsed = head(tags.vocabulary.filter((entry) => entry.count > 1), options.top);
+    if (tagsUsed.shown.length > 0) {
+        lines.push('', '### Most used tags', '', ...table(['Tag', 'Uses'], ['left', 'right'], tagsUsed.shown.map((tag) => [code(tag.name), String(tag.count)])), ...more(tagsUsed.hidden, 'tag'));
+    }
+    if (tags.usedOnce.length > 0) {
+        const tagsOnce = head(tags.usedOnce, options.top);
+        lines.push('', '### Tags written exactly once', '', tagsOnce.shown.map(code).join(', '), ...more(tagsOnce.hidden, 'tag'));
+    }
+    if (languages.length > 1) {
+        lines.push('', '## Languages', '', ...table(['Dialect', 'Files'], ['left', 'right'], languages.map((language) => [code(language.code), String(language.files)])));
+    }
+    if (files.unreadable.length > 0) {
+        const unreadable = head(files.unreadable, options.top);
+        lines.push('', `## Could not be read (${plural(files.unreadable.length, 'file')})`, '', 'Nothing in these files is counted above.', '', ...table(['File', 'Why'], ['left', 'left'], unreadable.shown.map((file) => [
+            cell(location(file.file, file.line)),
+            cell(file.reason),
+        ])), ...more(unreadable.hidden, 'file'));
+    }
+    return lines.join('\n');
+}
+//# sourceMappingURL=markdown.js.map

package/dist/stats/format/markdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.js","sourceRoot":"","sources":["../../../src/stats/format/markdown.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAC,MAAM,aAAa,CAAC;AAGhF,4DAA4D;AAC5D,SAAS,IAAI,CAAC,IAAY;IACxB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AACrC,CAAC;AAED,wEAAwE;AACxE,SAAS,IAAI,CAAC,IAAY;IACxB,OAAO,KAAK,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AAC7B,CAAC;AAED,SAAS,KAAK,CAAC,QAA2B,EAAE,UAA6B,EAAE,IAAyB;IAClG,OAAO;QACL,KAAK,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI;QAC7B,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,SAAS,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG;QACxF,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;KAC/C,CAAC;AACJ,CAAC;AAED,SAAS,IAAI,CAAC,MAAc,EAAE,QAAgB;IAC5C,OAAO,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;AACrE,CAAC;AAED,SAAS,QAAQ,CAAC,OAA6B,EAAE,OAAO,GAAG,IAAI;IAC7D,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;QAC5B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;QAChB,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACzC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;KACvC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,WAAW,CAAC,MAA+B;IAClD,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CACrC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CAAC;QACtC,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;QACvC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QACjB,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;QACpB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;KACzC,CAAC,CACH,CAAC;AACJ,CAAC;AAED,+BAA+B;AAC/B,MAAM,UAAU,UAAU,CAAC,UAAsB,EAAE,OAA2B;IAC5E,MAAM,EAAC,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAC,GAAG,UAAU,CAAC;IAEzE,IAAI,KAAK,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,sDAAsD,CAAC;IAChE,CAAC;IAED,MAAM,OAAO,GACX,KAAK,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC;QAC3B,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC;QAC9B,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC;IAE1D,MAAM,KAAK,GAAa;QACtB,2BAA2B;QAC3B,EAAE;QACF,CAAC,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC,IAAI,CAC7F,IAAI,CACL;KACF,CAAC;IAEF,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,GAAG,KAAK,CACzC,CAAC,EAAE,EAAE,OAAO,CAAC,EACb,CAAC,MAAM,EAAE,OAAO,CAAC,EACjB;QACE,CAAC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACxC,CAAC,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAClC,CAAC,aAAa,EAAE,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAC9C,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC1C,CAAC,mBAAmB,EAAE,MAAM,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QACzD,CAAC,iBAAiB,EAAE,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QACrD,CAAC,eAAe,EAAE,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACjD,CAAC,mBAAmB,EAAE,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC9C,CAAC,aAAa,EAAE,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAC7C,CAAC,aAAa,EAAE,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;KAC9C,CACF,CAAC,CAAC;IAEH,KAAK,CAAC,IAAI,CACR,EAAE,EACF,cAAc,EACd,EAAE,EACF,KAAK,SAAS,CAAC,SAAS,wDAAwD,EAChF,EAAE,EACF,kDAAkD,SAAS,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,CAC1F,CAAC;IAEF,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACrD,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,uBAAuB,EAAE,EAAE,EAAE,GAAG,KAAK,CAClD,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,EAC9B,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EACzB,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;YAC9B,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;YACxD,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;YACtB,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;SAC7C,CAAC,CACH,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,EAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAC,GAAG,KAAK,CAAC,QAAQ,CAAC;IAClD,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,GAAG,KAAK,CACrC,CAAC,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,EACtB,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,EAC1B;QACE,CAAC,oCAAoC,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;QAC/D,CAAC,8BAA8B,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1F,CAAC,sBAAsB,EAAE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACvF,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;QACrD,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;QAClD,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;QAClD,GAAG,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,uBAAuB,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;KAChG,CACF,CAAC,CAAC;IACH,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,mBAAmB,SAAS,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IAEnE,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACxF,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9B,KAAK,CAAC,IAAI,CACR,EAAE,EACF,qBAAqB,EACrB,EAAE,EACF,GAAG,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAC7F,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CACjC,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,CACf,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAChG,OAAO,CAAC,GAAG,CACZ,CAAC;IACF,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,KAAK,CAAC,IAAI,CACR,EAAE,EACF,gCAAgC,EAChC,EAAE,EACF,GAAG,KAAK,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,EAC1E,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAC7B,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACjD,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,KAAK,CAAC,IAAI,CACR,EAAE,EACF,qDAAqD,EACrD,EAAE,EACF,GAAG,KAAK,CACN,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAClC,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAClC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAC3B,EACD,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CACjC,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG,SAAS,CAAC,SAAS,GAAG,SAAS,CAAC,gBAAgB,CAAC;IAClE,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,KAAK,CACpC,CAAC,EAAE,EAAE,OAAO,CAAC,EACb,CAAC,MAAM,EAAE,OAAO,CAAC,EACjB;QACE,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjC,CAAC,sBAAsB,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACtD;YACE,+CAA+C;YAC/C,GAAG,IAAI,CAAC,iBAAiB,KAAK,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,GAAG;SAC3E;KACF,CACF,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACvF,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,oBAAoB,EAAE,EAAE,EAAE,GAAG,KAAK,CAC/C,CAAC,KAAK,EAAE,MAAM,CAAC,EACf,CAAC,MAAM,EAAE,OAAO,CAAC,EACjB,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CACjE,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IACtC,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;QAClD,KAAK,CAAC,IAAI,CACR,EAAE,EACF,+BAA+B,EAC/B,EAAE,EACF,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EACnC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAChC,CAAC;IACJ,CAAC;IAED,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzB,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,GAAG,KAAK,CACzC,CAAC,SAAS,EAAE,OAAO,CAAC,EACpB,CAAC,MAAM,EAAE,OAAO,CAAC,EACjB,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAC3E,CAAC,CAAC;IACL,CAAC;IAED,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;QACvD,KAAK,CAAC,IAAI,CACR,EAAE,EACF,yBAAyB,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,EACnE,EAAE,EACF,0CAA0C,EAC1C,EAAE,EACF,GAAG,KAAK,CACN,CAAC,MAAM,EAAE,KAAK,CAAC,EACf,CAAC,MAAM,EAAE,MAAM,CAAC,EAChB,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;YAC7B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACpC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;SAClB,CAAC,CACH,EACD,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CACnC,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC"}

package/dist/stats/format/shared.d.ts

@@ -0,0 +1,34 @@
+/**
+ * The bits of formatting the reports have in common.
+ */
+import type { Distribution } from '../types.ts';
+/** How many entries a list in a report shows before it is cut short. */
+export declare const DEFAULT_TOP = 10;
+/** What a report needs to know beyond the numbers themselves. */
+export interface StatsFormatOptions {
+    /** How many entries each list shows. */
+    top: number;
+}
+/** `64%`, and `0%` rather than `NaN%` when there is nothing to divide. */
+export declare function percent(part: number, whole: number): string;
+/** A number with one decimal, and none at all when it is a round one. */
+export declare function decimal(value: number): string;
+/** `min 1  median 5  p90 11  max 27  mean 5.5` */
+export declare function summarise(distribution: Distribution): string;
+/** `features/login.feature:12` */
+export declare function location(file: string, line: number): string;
+/** `1 file` / `3 files` */
+export declare function plural(count: number, singular: string, many?: string): string;
+/** `… and 1 more scenario` / `… and 3 more scenarios` */
+export declare function andMore(hidden: number, singular: string, many?: string): string;
+/**
+ * The first `top` entries, and how many were left out.
+ *
+ * Every list in a report is the head of a longer one, and a reader who is not
+ * told that draws conclusions from a list they think is complete.
+ */
+export declare function head<T>(values: readonly T[], top: number): {
+    shown: T[];
+    hidden: number;
+};
+//# sourceMappingURL=shared.d.ts.map

package/dist/stats/format/shared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../../src/stats/format/shared.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAE9C,wEAAwE;AACxE,eAAO,MAAM,WAAW,KAAK,CAAC;AAE9B,iEAAiE;AACjE,MAAM,WAAW,kBAAkB;IACjC,wCAAwC;IACxC,GAAG,EAAE,MAAM,CAAC;CACb;AAED,0EAA0E;AAC1E,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAE3D;AAED,yEAAyE;AACzE,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE7C;AAED,kDAAkD;AAClD,wBAAgB,SAAS,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAG5D;AAED,kCAAkC;AAClC,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAE3D;AAED,2BAA2B;AAC3B,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,SAAiB,GAAG,MAAM,CAErF;AAED,yDAAyD;AACzD,wBAAgB,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,SAAiB,GAAG,MAAM,CAEvF;AAED;;;;;GAKG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,EAAE,GAAG,EAAE,MAAM,GAAG;IAAC,KAAK,EAAE,CAAC,EAAE,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAC,CAEvF"}

package/dist/stats/format/shared.js

@@ -0,0 +1,37 @@
+/** How many entries a list in a report shows before it is cut short. */
+export const DEFAULT_TOP = 10;
+/** `64%`, and `0%` rather than `NaN%` when there is nothing to divide. */
+export function percent(part, whole) {
+    return `${whole === 0 ? 0 : Math.round((part / whole) * 100)}%`;
+}
+/** A number with one decimal, and none at all when it is a round one. */
+export function decimal(value) {
+    return Number.isInteger(value) ? String(value) : value.toFixed(1);
+}
+/** `min 1  median 5  p90 11  max 27  mean 5.5` */
+export function summarise(distribution) {
+    const { min, median, p90, max, mean } = distribution;
+    return `min ${min}   median ${median}   p90 ${p90}   max ${max}   mean ${decimal(mean)}`;
+}
+/** `features/login.feature:12` */
+export function location(file, line) {
+    return `${file}:${line}`;
+}
+/** `1 file` / `3 files` */
+export function plural(count, singular, many = `${singular}s`) {
+    return `${count} ${count === 1 ? singular : many}`;
+}
+/** `… and 1 more scenario` / `… and 3 more scenarios` */
+export function andMore(hidden, singular, many = `${singular}s`) {
+    return `… and ${hidden} more ${hidden === 1 ? singular : many}`;
+}
+/**
+ * The first `top` entries, and how many were left out.
+ *
+ * Every list in a report is the head of a longer one, and a reader who is not
+ * told that draws conclusions from a list they think is complete.
+ */
+export function head(values, top) {
+    return { shown: values.slice(0, top), hidden: Math.max(0, values.length - top) };
+}
+//# sourceMappingURL=shared.js.map

package/dist/stats/format/shared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.js","sourceRoot":"","sources":["../../../src/stats/format/shared.ts"],"names":[],"mappings":"AAKA,wEAAwE;AACxE,MAAM,CAAC,MAAM,WAAW,GAAG,EAAE,CAAC;AAQ9B,0EAA0E;AAC1E,MAAM,UAAU,OAAO,CAAC,IAAY,EAAE,KAAa;IACjD,OAAO,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC;AAClE,CAAC;AAED,yEAAyE;AACzE,MAAM,UAAU,OAAO,CAAC,KAAa;IACnC,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACpE,CAAC;AAED,kDAAkD;AAClD,MAAM,UAAU,SAAS,CAAC,YAA0B;IAClD,MAAM,EAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAC,GAAG,YAAY,CAAC;IACnD,OAAO,OAAO,GAAG,aAAa,MAAM,UAAU,GAAG,UAAU,GAAG,WAAW,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;AAC3F,CAAC;AAED,kCAAkC;AAClC,MAAM,UAAU,QAAQ,CAAC,IAAY,EAAE,IAAY;IACjD,OAAO,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC;AAC3B,CAAC;AAED,2BAA2B;AAC3B,MAAM,UAAU,MAAM,CAAC,KAAa,EAAE,QAAgB,EAAE,IAAI,GAAG,GAAG,QAAQ,GAAG;IAC3E,OAAO,GAAG,KAAK,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AACrD,CAAC;AAED,yDAAyD;AACzD,MAAM,UAAU,OAAO,CAAC,MAAc,EAAE,QAAgB,EAAE,IAAI,GAAG,GAAG,QAAQ,GAAG;IAC7E,OAAO,SAAS,MAAM,SAAS,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAClE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,IAAI,CAAI,MAAoB,EAAE,GAAW;IACvD,OAAO,EAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,EAAC,CAAC;AACjF,CAAC"}

package/dist/stats/format/text.d.ts

@@ -0,0 +1,5 @@
+import type { Statistics } from '../types.ts';
+import type { StatsFormatOptions } from './shared.ts';
+/** The report, as a block of text. */
+export declare function toText(statistics: Statistics, options: StatsFormatOptions): string;
+//# sourceMappingURL=text.d.ts.map

package/dist/stats/format/text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../../src/stats/format/text.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAA0B,UAAU,EAAC,MAAM,aAAa,CAAC;AAErE,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,aAAa,CAAC;AAuFpD,sCAAsC;AACtC,wBAAgB,MAAM,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAqLlF"}

package/dist/stats/format/text.js

@@ -0,0 +1,175 @@
+/**
+ * The report as something to read in a terminal.
+ *
+ * Every list here is the head of a longer one held in the JSON report, cut to
+ * `--top` entries and marked with how many were left out.
+ */
+import { style } from '../../logger.js';
+import { andMore, head, location, percent, plural, summarise } from './shared.js';
+/** Longer than this and a step is a paragraph; the report shows the start. */
+const TEXT_WIDTH = 90;
+function truncate(text, width = TEXT_WIDTH) {
+    return text.length <= width ? text : `${text.slice(0, width - 1)}…`;
+}
+/** Lays out a block so the numbers line up under each other. */
+function block(entries) {
+    const labelWidth = entries.reduce((widest, row) => Math.max(widest, row.label.length), 0);
+    const valueWidth = entries.reduce((widest, row) => (row.wide === true ? widest : Math.max(widest, row.value.length)), 0);
+    return entries.map((row) => {
+        const value = row.wide === true ? row.value : row.value.padStart(valueWidth);
+        const line = `  ${row.label.padEnd(labelWidth)}   ${value}`;
+        return row.note === undefined ? line : `${line}   ${style.gray(row.note)}`;
+    });
+}
+/** A list of `count  text  where` lines, with each column lined up. */
+function listing(entries, indent = '    ') {
+    const countWidth = entries.reduce((widest, entry) => Math.max(widest, entry.count === undefined ? 0 : String(entry.count).length), 0);
+    const prefix = countWidth === 0 ? indent : `${indent}${' '.repeat(countWidth + 2)}`;
+    const textWidth = entries.reduce((widest, entry) => Math.max(widest, truncate(entry.text).length), 0);
+    return entries.map((entry) => {
+        const counted = entry.count === undefined
+            ? `${prefix}${truncate(entry.text)}`
+            : `${indent}${String(entry.count).padStart(countWidth)}  ${truncate(entry.text)}`;
+        if (entry.where === undefined) {
+            return counted;
+        }
+        return `${counted.padEnd(prefix.length + textWidth)}  ${style.gray(entry.where)}`;
+    });
+}
+function more(hidden, singular) {
+    return hidden === 0 ? [] : [style.gray(`    ${andMore(hidden, singular)}`)];
+}
+function stepLines(entries, counted = true) {
+    return listing(entries.map((entry) => ({
+        ...(counted ? { count: entry.count } : {}),
+        text: entry.text,
+        where: location(entry.file, entry.line),
+    })));
+}
+function similarLines(groups) {
+    return groups.flatMap((group, index) => [...(index === 0 ? [] : ['']), ...stepLines(group.members)]);
+}
+/** The report, as a block of text. */
+export function toText(statistics, options) {
+    const { files, inventory, scenarios, steps, tags, languages } = statistics;
+    if (files.total === 0) {
+        return 'No feature files found.';
+    }
+    const counted = files.unreadable.length === 0
+        ? plural(files.parsed, 'file')
+        : `${files.parsed} of ${plural(files.total, 'file')}`;
+    const lines = [
+        [counted, plural(inventory.features, 'feature'), plural(scenarios.effective, 'test case')].join(', '),
+    ];
+    lines.push('', 'Inventory', ...block([
+        { label: 'Features', value: String(inventory.features) },
+        { label: 'Rules', value: String(inventory.rules) },
+        { label: 'Backgrounds', value: String(inventory.backgrounds) },
+        { label: 'Scenarios', value: String(inventory.scenarios) },
+        { label: 'Scenario Outlines', value: String(inventory.scenarioOutlines) },
+        {
+            label: 'Examples tables',
+            value: String(inventory.examplesTables),
+            note: plural(inventory.examplesRows, 'row'),
+        },
+        { label: 'Steps', value: String(inventory.steps), note: 'as written' },
+        { label: 'Data tables', value: String(inventory.dataTables) },
+        { label: 'Doc strings', value: String(inventory.docStrings) },
+    ]));
+    const largest = head(scenarios.largest, options.top);
+    lines.push('', 'Scenarios', ...block([
+        {
+            label: 'Test cases',
+            value: String(scenarios.effective),
+            note: 'one per Scenario, one per Examples row',
+        },
+        {
+            label: 'Steps per scenario',
+            value: summarise(scenarios.stepsPerScenario),
+            note: 'Background steps excluded',
+            wide: true,
+        },
+    ]));
+    if (largest.shown.length > 0) {
+        lines.push('', '  Longest', ...listing(largest.shown.map((scenario) => ({
+            count: scenario.steps,
+            text: scenario.name === '' ? '(unnamed)' : scenario.name,
+            where: location(scenario.file, scenario.line),
+        }))), ...more(largest.hidden, 'scenario'));
+    }
+    const { given, when, then, other } = steps.keywords;
+    const mix = [
+        `Given ${given} (${percent(given, steps.total)})`,
+        `When ${when} (${percent(when, steps.total)})`,
+        `Then ${then} (${percent(then, steps.total)})`,
+        ...(other === 0 ? [] : [`unresolved ${other}`]),
+    ].join('   ');
+    lines.push('', 'Steps', ...block([
+        { label: 'Written', value: String(steps.total), note: 'Background steps included' },
+        {
+            label: 'Distinct',
+            value: String(steps.unique),
+            note: `${percent(steps.unique, steps.total)} of all steps - lower is more reuse`,
+        },
+        {
+            label: 'Written once',
+            value: String(steps.usedOnce),
+            note: `${percent(steps.usedOnce, steps.unique)} of distinct steps`,
+        },
+        { label: 'Words per step', value: summarise(steps.wordsPerStep), wide: true },
+        {
+            label: 'Keywords',
+            value: mix,
+            note: 'And and But resolved to what they follow',
+            wide: true,
+        },
+    ]));
+    const mostUsed = head(steps.vocabulary.filter((entry) => entry.count > 1), options.top);
+    if (mostUsed.shown.length > 0) {
+        lines.push('', '  Most used', ...stepLines(mostUsed.shown), ...more(mostUsed.hidden, 'step'));
+    }
+    const once = head([...steps.vocabulary].filter((entry) => entry.count === 1).sort((a, b) => (a.text < b.text ? -1 : 1)), options.top);
+    if (once.shown.length > 0) {
+        lines.push('', '  Written once', ...stepLines(once.shown, false), ...more(once.hidden, 'step'));
+    }
+    const similar = head(steps.similar, options.top);
+    if (similar.shown.length > 0) {
+        lines.push('', `  Nearly the same (${plural(steps.similar.length, 'group')})`, ...similarLines(similar.shown), ...more(similar.hidden, 'group'));
+    }
+    const untagged = inventory.scenarios + inventory.scenarioOutlines;
+    lines.push('', 'Tags', ...block([
+        { label: 'Written', value: String(tags.total) },
+        { label: 'Distinct', value: String(tags.unique) },
+        {
+            label: 'Written once',
+            value: String(tags.usedOnce.length),
+            note: tags.usedOnce.length === 0 ? undefined : 'a tag written once is often a typo of one written often',
+        },
+        {
+            label: 'Untagged scenarios',
+            value: String(tags.untaggedScenarios),
+            note: `${percent(tags.untaggedScenarios, untagged)} of scenarios, counting inherited tags`,
+        },
+    ]));
+    const tagsUsed = head(tags.vocabulary.filter((entry) => entry.count > 1), options.top);
+    if (tagsUsed.shown.length > 0) {
+        lines.push('', '  Most used', ...listing(tagsUsed.shown.map((tag) => ({ count: tag.count, text: tag.name }))), ...more(tagsUsed.hidden, 'tag'));
+    }
+    const tagsOnce = head(tags.usedOnce, options.top);
+    if (tagsOnce.shown.length > 0) {
+        lines.push('', '  Written once', `    ${tagsOnce.shown.join(', ')}`, ...more(tagsOnce.hidden, 'tag'));
+    }
+    if (languages.length > 1) {
+        lines.push('', 'Languages', ...block(languages.map((language) => ({
+            label: language.code,
+            value: String(language.files),
+            note: language.files === 1 ? 'file' : 'files',
+        }))));
+    }
+    if (files.unreadable.length > 0) {
+        const unreadable = head(files.unreadable, options.top);
+        lines.push('', `Could not be read (${plural(files.unreadable.length, 'file')}, not counted above)`, ...unreadable.shown.map((file) => `    ${location(file.file, file.line)}  ${style.gray(file.reason)}`), ...more(unreadable.hidden, 'file'));
+    }
+    return lines.join('\n');
+}
+//# sourceMappingURL=text.js.map