gurkencheck 0.0.6 → 0.0.9

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"text.js","sourceRoot":"","sources":["../../../src/stats/format/text.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAC;AAEtC,OAAO,EAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAC,MAAM,aAAa,CAAC;AAGhF,8EAA8E;AAC9E,MAAM,UAAU,GAAG,EAAE,CAAC;AAEtB,SAAS,QAAQ,CAAC,IAAY,EAAE,KAAK,GAAG,UAAU;IAChD,OAAO,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC;AACtE,CAAC;AAeD,gEAAgE;AAChE,SAAS,KAAK,CAAC,OAAuB;IACpC,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1F,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,CAC/B,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAClF,CAAC,CACF,CAAC;IAEF,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACzB,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC7E,MAAM,IAAI,GAAG,KAAK,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,KAAK,EAAE,CAAC;QAC5D,OAAO,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;IAC7E,CAAC,CAAC,CAAC;AACL,CAAC;AAUD,uEAAuE;AACvE,SAAS,OAAO,CAAC,OAAyB,EAAE,MAAM,GAAG,MAAM;IACzD,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,CAC/B,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,EAC/F,CAAC,CACF,CAAC;IACF,MAAM,MAAM,GAAG,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC,EAAE,CAAC;IACpF,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAC9B,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,EAChE,CAAC,CACF,CAAC;IAEF,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAC3B,MAAM,OAAO,GACX,KAAK,CAAC,KAAK,KAAK,SAAS;YACvB,CAAC,CAAC,GAAG,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YACpC,CAAC,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,KAAK,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACtF,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;IACpF,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,IAAI,CAAC,MAAc,EAAE,QAAgB;IAC5C,OAAO,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,SAAS,CAAC,OAA6B,EAAE,OAAO,GAAG,IAAI;IAC9D,OAAO,OAAO,CACZ,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACtB,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAC,KAAK,EAAE,KAAK,CAAC,KAAK,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACxC,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;KACxC,CAAC,CAAC,CACJ,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,MAA+B;IACnD,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACvG,CAAC;AAED,sCAAsC;AACtC,MAAM,UAAU,MAAM,CAAC,UAAsB,EAAE,OAA2B;IACxE,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,yBAAyB,CAAC;IACnC,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,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,WAAW,EAAE,GAAG,KAAK,CAAC;QACnC,EAAC,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAC;QACtD,EAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAC;QAChD,EAAC,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,EAAC;QAC5D,EAAC,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,EAAC;QACxD,EAAC,KAAK,EAAE,mBAAmB,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAC;QACvE;YACE,KAAK,EAAE,iBAAiB;YACxB,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC;YACvC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,YAAY,EAAE,KAAK,CAAC;SAC5C;QACD,EAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,YAAY,EAAC;QACpE,EAAC,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,EAAC;QAC3D,EAAC,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,EAAC;KAC5D,CAAC,CAAC,CAAC;IAEJ,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACrD,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC;QACnC;YACE,KAAK,EAAE,YAAY;YACnB,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC;YAClC,IAAI,EAAE,wCAAwC;SAC/C;QACD;YACE,KAAK,EAAE,oBAAoB;YAC3B,KAAK,EAAE,SAAS,CAAC,SAAS,CAAC,gBAAgB,CAAC;YAC5C,IAAI,EAAE,2BAA2B;YACjC,IAAI,EAAE,IAAI;SACX;KACF,CAAC,CAAC,CAAC;IACJ,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,KAAK,CAAC,IAAI,CACR,EAAE,EACF,WAAW,EACX,GAAG,OAAO,CACR,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAC/B,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,IAAI,EAAE,QAAQ,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI;YACxD,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC;SAC9C,CAAC,CAAC,CACJ,EACD,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,CACpC,CAAC;IACJ,CAAC;IAED,MAAM,EAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAC,GAAG,KAAK,CAAC,QAAQ,CAAC;IAClD,MAAM,GAAG,GAAG;QACV,SAAS,KAAK,KAAK,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG;QACjD,QAAQ,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG;QAC9C,QAAQ,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG;QAC9C,GAAG,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,cAAc,KAAK,EAAE,CAAC,CAAC;KAChD,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAEd,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;QAC/B,EAAC,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,2BAA2B,EAAC;QACjF;YACE,KAAK,EAAE,UAAU;YACjB,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;YAC3B,IAAI,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,qCAAqC;SACjF;QACD;YACE,KAAK,EAAE,cAAc;YACrB,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC7B,IAAI,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,oBAAoB;SACnE;QACD,EAAC,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,IAAI,EAAC;QAC3E;YACE,KAAK,EAAE,UAAU;YACjB,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,0CAA0C;YAChD,IAAI,EAAE,IAAI;SACX;KACF,CAAC,CAAC,CAAC;IAEJ,MAAM,QAAQ,GAAG,IAAI,CACnB,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,EACnD,OAAO,CAAC,GAAG,CACZ,CAAC;IACF,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,aAAa,EAAE,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAChG,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,CACf,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,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,EACrG,OAAO,CAAC,GAAG,CACZ,CAAC;IACF,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,KAAK,CAAC,IAAI,CACR,EAAE,EACF,gBAAgB,EAChB,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,EAC/B,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,sBAAsB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAC9D,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,EAC9B,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,MAAM,EAAE,GAAG,KAAK,CAAC;QAC9B,EAAC,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAC;QAC7C,EAAC,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAC;QAC/C;YACE,KAAK,EAAE,cAAc;YACrB,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;YACnC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,yDAAyD;SACzG;QACD;YACE,KAAK,EAAE,oBAAoB;YAC3B,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC;YACrC,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,wCAAwC;SAC3F;KACF,CAAC,CAAC,CAAC;IAEJ,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,CACR,EAAE,EACF,aAAa,EACb,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAC,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAC,CAAC,CAAC,CAAC,EAC7E,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAChC,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IAClD,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,gBAAgB,EAAE,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IACxG,CAAC;IAED,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzB,KAAK,CAAC,IAAI,CACR,EAAE,EACF,WAAW,EACX,GAAG,KAAK,CACN,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAC3B,KAAK,EAAE,QAAQ,CAAC,IAAI;YACpB,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;YAC7B,IAAI,EAAE,QAAQ,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO;SAC9C,CAAC,CAAC,CACJ,CACF,CAAC;IACJ,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,sBAAsB,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,sBAAsB,EACnF,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CACrB,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAC9E,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/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Statistics: what is in a set of feature files, rather than what is wrong
+ * with them.
+ *
+ * ```ts
+ * import {collectStatistics, readAndParseFile, toText} from 'gurkencheck';
+ *
+ * const parsed = await Promise.all(files.map((file) => readAndParseFile(file)));
+ * console.log(toText(collectStatistics(parsed), {top: 10}));
+ * ```
+ */
+export { collectStatistics, distribution } from './collect.ts';
+export type { CollectOptions } from './collect.ts';
+export { DEFAULT_SIMILARITY, boundedEditDistance, groupSimilar } from './similar.ts';
+export type { SimilarityOptions } from './similar.ts';
+export { NUMBER_MARKER, PLACEHOLDER_MARKER, STRING_MARKER, countWords, normaliseStepText, } from './normalise.ts';
+export { DEFAULT_STATS_FORMAT, DEFAULT_TOP, STATS_FORMATTERS, getStatsFormatter, toJson as statisticsToJson, toMarkdown, toText, } from './format/index.ts';
+export type { StatsFormatOptions, StatsFormatter } from './format/index.ts';
+export { runStats, statsUsage } from './command.ts';
+export type * from './types.ts';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/stats/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,EAAC,iBAAiB,EAAE,YAAY,EAAC,MAAM,cAAc,CAAC;AAC7D,YAAY,EAAC,cAAc,EAAC,MAAM,cAAc,CAAC;AACjD,OAAO,EAAC,kBAAkB,EAAE,mBAAmB,EAAE,YAAY,EAAC,MAAM,cAAc,CAAC;AACnF,YAAY,EAAC,iBAAiB,EAAC,MAAM,cAAc,CAAC;AACpD,OAAO,EACL,aAAa,EACb,kBAAkB,EAClB,aAAa,EACb,UAAU,EACV,iBAAiB,GAClB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,oBAAoB,EACpB,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,MAAM,IAAI,gBAAgB,EAC1B,UAAU,EACV,MAAM,GACP,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EAAC,kBAAkB,EAAE,cAAc,EAAC,MAAM,mBAAmB,CAAC;AAC1E,OAAO,EAAC,QAAQ,EAAE,UAAU,EAAC,MAAM,cAAc,CAAC;AAClD,mBAAmB,YAAY,CAAC"}

package/dist/stats/index.js

@@ -0,0 +1,17 @@
+/**
+ * Statistics: what is in a set of feature files, rather than what is wrong
+ * with them.
+ *
+ * ```ts
+ * import {collectStatistics, readAndParseFile, toText} from 'gurkencheck';
+ *
+ * const parsed = await Promise.all(files.map((file) => readAndParseFile(file)));
+ * console.log(toText(collectStatistics(parsed), {top: 10}));
+ * ```
+ */
+export { collectStatistics, distribution } from './collect.js';
+export { DEFAULT_SIMILARITY, boundedEditDistance, groupSimilar } from './similar.js';
+export { NUMBER_MARKER, PLACEHOLDER_MARKER, STRING_MARKER, countWords, normaliseStepText, } from './normalise.js';
+export { DEFAULT_STATS_FORMAT, DEFAULT_TOP, STATS_FORMATTERS, getStatsFormatter, toJson as statisticsToJson, toMarkdown, toText, } from './format/index.js';
+export { runStats, statsUsage } from './command.js';
+//# sourceMappingURL=index.js.map

package/dist/stats/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/stats/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,EAAC,iBAAiB,EAAE,YAAY,EAAC,MAAM,cAAc,CAAC;AAE7D,OAAO,EAAC,kBAAkB,EAAE,mBAAmB,EAAE,YAAY,EAAC,MAAM,cAAc,CAAC;AAEnF,OAAO,EACL,aAAa,EACb,kBAAkB,EAClB,aAAa,EACb,UAAU,EACV,iBAAiB,GAClB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,oBAAoB,EACpB,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,MAAM,IAAI,gBAAgB,EAC1B,UAAU,EACV,MAAM,GACP,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,QAAQ,EAAE,UAAU,EAAC,MAAM,cAAc,CAAC"}

package/dist/stats/normalise.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Deciding when two steps are the same step.
+ *
+ * `I have 3 items in my cart` and `I have 7 items in my cart` are one step
+ * behind one step definition, and counting them as two would make every
+ * measure of reuse meaningless. So the parts a step definition captures as
+ * arguments - numbers, quoted strings, Scenario Outline placeholders - are
+ * replaced by a marker before two steps are compared.
+ *
+ * The keyword is not part of the text: the Gherkin parser hands it over
+ * separately, and `Given I am logged in` and `And I am logged in` are the
+ * same step written in two places.
+ *
+ * Each kind of argument keeps a marker of its own, so a placeholder and a
+ * value written in its place stay apart: `I have <count> items` does not
+ * become `I have 0 items`. That understates reuse a little in an outline
+ * heavy suite, and it is the trade worth making, because the normalised text
+ * is what the report shows a reader - and a `0` in a step that has no number
+ * in it would be a lie about the file. The two are put back together by the
+ * near-duplicate report in `similar.ts`, which is a couple of edits apart.
+ */
+/** Stands in for a Scenario Outline placeholder, whatever it was called. */
+export declare const PLACEHOLDER_MARKER = "<>";
+/** Stands in for a double quoted string, whatever it contained. */
+export declare const STRING_MARKER = "\"\"";
+/** Stands in for a number, whatever its value. */
+export declare const NUMBER_MARKER = "0";
+/**
+ * The form of a step text used to decide whether two steps are the same one.
+ *
+ * Single quotes are deliberately left alone: `the user's cart is 'empty'` has
+ * three of them, and a rule masking whatever sits between a pair would eat
+ * half the sentence. Cucumber's own expressions quote with `"` anyway.
+ */
+export declare function normaliseStepText(text: string): string;
+/** How many words a step is made of, counted before normalisation. */
+export declare function countWords(text: string): number;
+//# sourceMappingURL=normalise.d.ts.map

package/dist/stats/normalise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalise.d.ts","sourceRoot":"","sources":["../../src/stats/normalise.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,4EAA4E;AAC5E,eAAO,MAAM,kBAAkB,OAAO,CAAC;AAEvC,mEAAmE;AACnE,eAAO,MAAM,aAAa,SAAO,CAAC;AAElC,kDAAkD;AAClD,eAAO,MAAM,aAAa,MAAM,CAAC;AAiBjC;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAatD;AAED,sEAAsE;AACtE,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAG/C"}

package/dist/stats/normalise.js

@@ -0,0 +1,65 @@
+/**
+ * Deciding when two steps are the same step.
+ *
+ * `I have 3 items in my cart` and `I have 7 items in my cart` are one step
+ * behind one step definition, and counting them as two would make every
+ * measure of reuse meaningless. So the parts a step definition captures as
+ * arguments - numbers, quoted strings, Scenario Outline placeholders - are
+ * replaced by a marker before two steps are compared.
+ *
+ * The keyword is not part of the text: the Gherkin parser hands it over
+ * separately, and `Given I am logged in` and `And I am logged in` are the
+ * same step written in two places.
+ *
+ * Each kind of argument keeps a marker of its own, so a placeholder and a
+ * value written in its place stay apart: `I have <count> items` does not
+ * become `I have 0 items`. That understates reuse a little in an outline
+ * heavy suite, and it is the trade worth making, because the normalised text
+ * is what the report shows a reader - and a `0` in a step that has no number
+ * in it would be a lie about the file. The two are put back together by the
+ * near-duplicate report in `similar.ts`, which is a couple of edits apart.
+ */
+/** Stands in for a Scenario Outline placeholder, whatever it was called. */
+export const PLACEHOLDER_MARKER = '<>';
+/** Stands in for a double quoted string, whatever it contained. */
+export const STRING_MARKER = '""';
+/** Stands in for a number, whatever its value. */
+export const NUMBER_MARKER = '0';
+const PLACEHOLDER = /<[^<>]*>/gu;
+const QUOTED = /"[^"]*"/gu;
+/**
+ * A whole number or decimal standing on its own. The word boundaries keep
+ * `1st` and `v2` intact, where the digits are part of a name rather than a
+ * value a step definition would capture.
+ */
+const NUMBER = /\b\d+(?:[.,]\d+)*\b/gu;
+const WHITESPACE = /\s+/gu;
+/** A full stop or exclamation mark at the end, which changes nothing. */
+const TRAILING_PUNCTUATION = /[\s.!]*[.!]$/u;
+/**
+ * The form of a step text used to decide whether two steps are the same one.
+ *
+ * Single quotes are deliberately left alone: `the user's cart is 'empty'` has
+ * three of them, and a rule masking whatever sits between a pair would eat
+ * half the sentence. Cucumber's own expressions quote with `"` anyway.
+ */
+export function normaliseStepText(text) {
+    return text
+        .replace(PLACEHOLDER, PLACEHOLDER_MARKER)
+        .replace(QUOTED, STRING_MARKER)
+        .replace(NUMBER, NUMBER_MARKER)
+        .toLowerCase()
+        .replace(WHITESPACE, ' ')
+        .trim()
+        // Whatever sat in front of the full stop goes with it: `I own it .` and
+        // `I own it` are one step, and a step text ending in a space is not one
+        // anybody would recognise in the report.
+        .replace(TRAILING_PUNCTUATION, '')
+        .trim();
+}
+/** How many words a step is made of, counted before normalisation. */
+export function countWords(text) {
+    const trimmed = text.trim();
+    return trimmed === '' ? 0 : trimmed.split(WHITESPACE).length;
+}
+//# sourceMappingURL=normalise.js.map

package/dist/stats/normalise.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalise.js","sourceRoot":"","sources":["../../src/stats/normalise.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,4EAA4E;AAC5E,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,CAAC;AAEvC,mEAAmE;AACnE,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,CAAC;AAElC,kDAAkD;AAClD,MAAM,CAAC,MAAM,aAAa,GAAG,GAAG,CAAC;AAEjC,MAAM,WAAW,GAAG,YAAY,CAAC;AACjC,MAAM,MAAM,GAAG,WAAW,CAAC;AAE3B;;;;GAIG;AACH,MAAM,MAAM,GAAG,uBAAuB,CAAC;AAEvC,MAAM,UAAU,GAAG,OAAO,CAAC;AAE3B,yEAAyE;AACzE,MAAM,oBAAoB,GAAG,eAAe,CAAC;AAE7C;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAY;IAC5C,OAAO,IAAI;SACR,OAAO,CAAC,WAAW,EAAE,kBAAkB,CAAC;SACxC,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC;SAC9B,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC;SAC9B,WAAW,EAAE;SACb,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC;SACxB,IAAI,EAAE;QACP,wEAAwE;QACxE,wEAAwE;QACxE,yCAAyC;SACxC,OAAO,CAAC,oBAAoB,EAAE,EAAE,CAAC;SACjC,IAAI,EAAE,CAAC;AACZ,CAAC;AAED,sEAAsE;AACtE,MAAM,UAAU,UAAU,CAAC,IAAY;IACrC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC5B,OAAO,OAAO,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC;AAC/D,CAAC"}

package/dist/stats/similar.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Finding steps that are nearly, but not quite, the same step.
+ *
+ * `I am logged in` and `I'm logged in` are one behaviour written twice, and
+ * they cost two step definitions. Normalisation cannot join them - they
+ * really are different sentences - so they are grouped by how many single
+ * character edits it takes to turn one into the other.
+ *
+ * Edit distance is quadratic in the number of distinct steps, which on a
+ * large suite is millions of comparisons, so two cheap tests run first. Both
+ * are lower bounds on the distance, never overestimates, so a pair they
+ * reject could not have been close enough anyway:
+ *
+ * - two strings are at least as far apart as their lengths differ;
+ * - every edit changes the tally of characters by at most two, so half the
+ *   difference between two tallies is a floor on the distance as well.
+ */
+/** How alike two steps have to be before they are reported together. */
+export interface SimilarityOptions {
+    /**
+     * `1 - distance / length`, against the longer of the two steps. At 0.85 a
+     * forty character step may differ by six edits.
+     */
+    ratio: number;
+    /**
+     * Steps shorter than this are left out. `I wait` and `I wait 0` are two
+     * edits apart, and at that length almost everything looks like everything.
+     */
+    minLength: number;
+    /**
+     * Edits never allowed beyond, however long the steps are.
+     *
+     * The ratio on its own lets a long step drift a long way: six edits turn
+     * `the customer opens the order in bulk` into `the customer opens the cart
+     * in bulk`, which is a different step rather than the same one spelled two
+     * ways. What this report is for is the small differences - an apostrophe, a
+     * plural, a missing article - and three edits covers those.
+     *
+     * It is also what keeps the search quick: with a low cap two steps have to
+     * be within a few characters in length before they are compared at all.
+     */
+    maxEdits: number;
+}
+export declare const DEFAULT_SIMILARITY: SimilarityOptions;
+/**
+ * The Levenshtein distance between two strings, giving up as soon as it is
+ * certain to exceed `limit` and returning `limit + 1` in that case.
+ *
+ * Every value in a row of the table is a lower bound on everything below it,
+ * so once the whole row is past the limit there is no way back.
+ */
+export declare function boundedEditDistance(left: string, right: string, limit: number): number;
+/**
+ * Groups entries whose text is close enough to be the same step written two
+ * ways. Entries that are close to nothing are left out, so every group
+ * returned has at least two members, in the order they were given in.
+ */
+export declare function groupSimilar<T extends {
+    text: string;
+}>(entries: readonly T[], options?: SimilarityOptions): T[][];
+//# sourceMappingURL=similar.d.ts.map

package/dist/stats/similar.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"similar.d.ts","sourceRoot":"","sources":["../../src/stats/similar.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,wEAAwE;AACxE,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;;;;;;;;OAWG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,eAAO,MAAM,kBAAkB,EAAE,iBAA4D,CAAC;AAwC9F;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAsCtF;AAgCD;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC,EACnD,OAAO,EAAE,SAAS,CAAC,EAAE,EACrB,OAAO,GAAE,iBAAsC,GAC9C,CAAC,EAAE,EAAE,CAsDP"}