gurkencheck 0.0.9 → 0.1.0

package/dist/presets.js

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

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

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

package/dist/rules/allowed-tags.js

@@ -2,11 +2,13 @@ import { getNodeType } from '../gherkin/keywords.js';
 import { taggedNodesOf } from '../gherkin/traverse.js';
 import { mergeDefaults } from '../util/collections.js';
 import { at } from '../util/location.js';
+import { invalidPatterns } from '../util/patterns.js';
 const name = 'allowed-tags';
 const availableConfigs = { tags: [], patterns: [] };
 const rule = {
     name,
     availableConfigs,
+    verifySettings: (settings) => invalidPatterns('patterns', settings['patterns']),
     run(feature, _file, configuration) {
         if (feature === undefined) {
             return [];
@@ -31,4 +33,3 @@ const rule = {
     },
 };
 export default rule;
-//# sourceMappingURL=allowed-tags.js.map

package/dist/rules/background-setup-only.d.ts

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

package/dist/rules/background-setup-only.js

@@ -29,4 +29,3 @@ const rule = {
     },
 };
 export default rule;
-//# sourceMappingURL=background-setup-only.js.map

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

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

package/dist/rules/file-name.js

@@ -16,6 +16,16 @@ const availableConfigs = {
 const rule = {
     name,
     availableConfigs,
+    verifySettings(settings) {
+        const style = settings['style'];
+        return style === undefined || Object.hasOwn(STYLES, style)
+            ? []
+            : [
+                `"style" should be one of ${Object.keys(STYLES)
+                    .map((known) => `"${known}"`)
+                    .join(', ')}, not ${JSON.stringify(style)}`,
+            ];
+    },
     run(_feature, file, configuration) {
         const { style } = mergeDefaults(availableConfigs, configuration);
         const convert = STYLES[style];
@@ -38,4 +48,3 @@ const rule = {
     },
 };
 export default rule;
-//# sourceMappingURL=file-name.js.map

package/dist/rules/indentation.d.ts

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

package/dist/rules/indentation.js

@@ -29,7 +29,9 @@ const availableConfigs = {
     'feature tag': -1,
     'rule tag': -1,
     'scenario tag': -1,
+    'examples tag': -1,
     docstring: -1,
+    datatable: -1,
     /** One of "any", "space" or "tab". */
     character: 'any',
 };
@@ -43,12 +45,15 @@ function resolveConfig(configuration) {
         typeof configuration['scenario tag'] === 'number'
             ? configuration['scenario tag']
             : merged.Scenario;
-    // A doc string belongs to its step and is conventionally indented one level
-    // further in, so it follows the Step setting unless it is set on its own.
-    merged.docstring =
-        typeof configuration['docstring'] === 'number'
-            ? configuration['docstring']
-            : merged.Step + 2;
+    merged['examples tag'] =
+        typeof configuration['examples tag'] === 'number'
+            ? configuration['examples tag']
+            : merged.Examples;
+    // A doc string or a data table belongs to its step and is conventionally
+    // indented one level further in, so unless it is set on its own it follows
+    // the step it belongs to; -1 stands for that here.
+    merged.docstring = typeof configuration['docstring'] === 'number' ? configuration['docstring'] : -1;
+    merged.datatable = typeof configuration['datatable'] === 'number' ? configuration['datatable'] : -1;
     merged.character =
         configuration['character'] === 'space' || configuration['character'] === 'tab'
             ? configuration['character']
@@ -58,6 +63,12 @@ function resolveConfig(configuration) {
 const rule = {
     name,
     availableConfigs,
+    verifySettings(settings) {
+        const character = settings['character'];
+        return character === undefined || ['any', 'space', 'tab'].includes(character)
+            ? []
+            : [`"character" should be "any", "space" or "tab", not ${JSON.stringify(character)}`];
+    },
     run(feature, file, configuration) {
         if (feature === undefined) {
             return [];
@@ -82,11 +93,10 @@ const rule = {
                 });
             }
         };
-        const test = (location, type) => {
+        const test = (location, type, expected = config[type]) => {
             testCharacter(location, type);
             // Columns are 1-based, indentation is counted from 0.
             const actual = (location.column ?? 1) - 1;
-            const expected = config[type];
             if (actual !== expected) {
                 errors.push({
                     message: `Wrong indentation for "${type}", expected indentation level of ${expected}, but got ${actual}`,
@@ -100,8 +110,12 @@ const rule = {
             // A step only uses its own keyword's setting when the user set one.
             const type = keyword !== '' && keyword in raw ? keyword : 'Step';
             test(step.location, type);
+            const underStep = config[type] + 2;
             if (step.docString !== undefined) {
-                test(step.docString.location, 'docstring');
+                test(step.docString.location, 'docstring', config.docstring === -1 ? underStep : config.docstring);
+            }
+            for (const row of step.dataTable?.rows ?? []) {
+                test(row.location, 'datatable', config.datatable === -1 ? underStep : config.datatable);
             }
         };
         const testTags = (tags, type) => {
@@ -125,6 +139,7 @@ const rule = {
                 child.scenario.steps.forEach(testStep);
                 for (const examples of child.scenario.examples) {
                     test(examples.location, 'Examples');
+                    testTags(examples.tags, 'examples tag');
                     if (examples.tableHeader !== undefined) {
                         test(examples.tableHeader.location, 'example');
                         for (const row of examples.tableBody) {
@@ -150,4 +165,3 @@ const rule = {
     },
 };
 export default rule;
-//# sourceMappingURL=indentation.js.map

package/dist/rules/index.d.ts

@@ -10,4 +10,3 @@
 import type { LintRule } from '../types.ts';
 /** Every rule shipped with gurkencheck, in alphabetical order. */
 export declare const BUILT_IN_RULES: readonly LintRule[];
-//# sourceMappingURL=index.d.ts.map

package/dist/rules/index.js

@@ -73,4 +73,3 @@ export const BUILT_IN_RULES = [
     scenarioSize,
     useAnd,
 ];
-//# sourceMappingURL=index.js.map

package/dist/rules/keywords-in-logical-order.d.ts

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

package/dist/rules/keywords-in-logical-order.js

@@ -34,4 +34,3 @@ const rule = {
     },
 };
 export default rule;
-//# sourceMappingURL=keywords-in-logical-order.js.map

package/dist/rules/max-scenarios-per-file.d.ts

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

package/dist/rules/max-scenarios-per-file.js

@@ -39,4 +39,3 @@ const rule = {
     },
 };
 export default rule;
-//# sourceMappingURL=max-scenarios-per-file.js.map

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

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

package/dist/rules/name-length.js

@@ -20,11 +20,14 @@ const rule = {
         const errors = [];
         const test = (text, location, type) => {
             const maximum = config[type];
+            // Characters, not the UTF-16 units .length counts: an emoji is one
+            // character to the person reading the name, not two.
+            const length = [...text].length;
             // A limit of 0 turns the check off for that kind of name, for teams that
             // want a limit on scenario names but not on step text, or the reverse.
-            if (maximum > 0 && text !== '' && text.length > maximum) {
+            if (maximum > 0 && text !== '' && length > maximum) {
                 errors.push({
-                    message: `${type} name is too long. Length of ${text.length} is longer than the maximum allowed: ${maximum}`,
+                    message: `${type} name is too long. Length of ${length} is longer than the maximum allowed: ${maximum}`,
                     rule: name,
                     ...at(location),
                 });
@@ -47,4 +50,3 @@ const rule = {
     },
 };
 export default rule;
-//# sourceMappingURL=name-length.js.map

package/dist/rules/new-line-at-eof.d.ts

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

package/dist/rules/new-line-at-eof.js

@@ -1,3 +1,4 @@
+import { contentLines } from '../util/lines.js';
 const name = 'new-line-at-eof';
 /** Whether a trailing new line is required (`yes`) or forbidden (`no`). */
 const availableConfigs = ['yes', 'no'];
@@ -10,6 +11,12 @@ const rule = {
     availableConfigs,
     run(_feature, file, configuration) {
         const setting = toSetting(configuration);
+        // An empty file has no line for a new line to end, so there is nothing to
+        // require or forbid. Splitting it gives a single empty entry, which would
+        // otherwise read as a new line at the end.
+        if (file.lines.length === 1 && file.lines[0] === '') {
+            return [];
+        }
         // Splitting on line breaks leaves a trailing empty entry when the file
         // ends with one.
         const hasNewLineAtEof = file.lines.at(-1) === '';
@@ -23,8 +30,9 @@ const rule = {
         if (message === '') {
             return [];
         }
-        return [{ message, rule: name, line: file.lines.length }];
+        // The last line of the file: the one the new line ends, or the one
+        // missing it. contentLines leaves out the empty entry after a new line.
+        return [{ message, rule: name, line: contentLines(file).length }];
     },
 };
 export default rule;
-//# sourceMappingURL=new-line-at-eof.js.map

package/dist/rules/no-background-only-scenario.d.ts

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

package/dist/rules/no-background-only-scenario.js

@@ -40,4 +40,3 @@ const rule = {
     },
 };
 export default rule;
-//# sourceMappingURL=no-background-only-scenario.js.map

package/dist/rules/no-dupe-feature-names.d.ts

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

package/dist/rules/no-dupe-feature-names.js

@@ -6,6 +6,11 @@ const rule = {
         if (feature === undefined) {
             return [];
         }
+        // A feature with no name is no-unnamed-features' finding, not a clash
+        // between every file that forgot one.
+        if (feature.name.trim() === '') {
+            return [];
+        }
         const seen = context.state(() => new Map());
         const sightings = seen.get(feature.name) ?? [];
         sightings.push({ filePath: file.relativePath, at: at(feature.location) });
@@ -35,4 +40,3 @@ const rule = {
     },
 };
 export default rule;
-//# sourceMappingURL=no-dupe-feature-names.js.map

package/dist/rules/no-dupe-file-names.d.ts

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

package/dist/rules/no-dupe-file-names.js

@@ -40,4 +40,3 @@ const rule = {
     },
 };
 export default rule;
-//# sourceMappingURL=no-dupe-file-names.js.map

package/dist/rules/no-dupe-scenario-names.d.ts

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

package/dist/rules/no-dupe-scenario-names.js

@@ -13,6 +13,10 @@ const rule = {
         const seen = context.state(() => new Map());
         const withinOneFile = configuration === 'in-feature';
         for (const { scenario } of scenariosOf(feature)) {
+            // A scenario with no name is no-unnamed-scenarios' finding, not a clash.
+            if (scenario.name.trim() === '') {
+                continue;
+            }
             // Told to look within each file, a name only clashes with the same name
             // in the same file - so which file it is in is part of what makes a
             // name that name. A newline cannot appear in either half, so the two
@@ -50,4 +54,3 @@ const rule = {
     },
 };
 export default rule;
-//# sourceMappingURL=no-dupe-scenario-names.js.map

package/dist/rules/no-duplicate-tags.d.ts

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

package/dist/rules/no-duplicate-tags.js

@@ -35,4 +35,3 @@ const rule = {
     },
 };
 export default rule;
-//# sourceMappingURL=no-duplicate-tags.js.map

package/dist/rules/no-empty-background.d.ts

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

package/dist/rules/no-empty-background.js

@@ -21,4 +21,3 @@ const rule = {
     },
 };
 export default rule;
-//# sourceMappingURL=no-empty-background.js.map

package/dist/rules/no-empty-file.d.ts

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

package/dist/rules/no-empty-file.js

@@ -9,4 +9,3 @@ const rule = {
     },
 };
 export default rule;
-//# sourceMappingURL=no-empty-file.js.map

package/dist/rules/no-examples-in-scenarios.d.ts

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

package/dist/rules/no-examples-in-scenarios.js

@@ -22,4 +22,3 @@ const rule = {
     },
 };
 export default rule;
-//# sourceMappingURL=no-examples-in-scenarios.js.map

package/dist/rules/no-files-without-scenarios.d.ts

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

package/dist/rules/no-files-without-scenarios.js

@@ -15,4 +15,3 @@ const rule = {
     },
 };
 export default rule;
-//# sourceMappingURL=no-files-without-scenarios.js.map

package/dist/rules/no-homogenous-tags.d.ts

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

package/dist/rules/no-homogenous-tags.js

@@ -51,4 +51,3 @@ const rule = {
     },
 };
 export default rule;
-//# sourceMappingURL=no-homogenous-tags.js.map

package/dist/rules/no-multiple-empty-lines.d.ts

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

package/dist/rules/no-multiple-empty-lines.js

@@ -13,10 +13,10 @@ function messageFor(max) {
 const rule = {
     name,
     availableConfigs,
-    run(_feature, file, configuration) {
+    run(feature, file, configuration) {
         const { max } = mergeDefaults(availableConfigs, configuration);
         const lines = contentLines(file);
-        const inDocString = markDocStrings(lines);
+        const inDocString = markDocStrings(lines, feature);
         const message = messageFor(max);
         const errors = [];
         let blanksInARow = 0;
@@ -41,4 +41,3 @@ const rule = {
     },
 };
 export default rule;
-//# sourceMappingURL=no-multiple-empty-lines.js.map

package/dist/rules/no-partially-commented-tag-lines.d.ts

@@ -1,4 +1,3 @@
 import type { LintRule } from '../types.ts';
 declare const rule: LintRule;
 export default rule;
-//# sourceMappingURL=no-partially-commented-tag-lines.d.ts.map

package/dist/rules/no-partially-commented-tag-lines.js

@@ -1,5 +1,5 @@
 import { taggedNodesOf } from '../gherkin/traverse.js';
-import { atLineColumn } from '../util/location.js';
+import { atLineColumn, columnOf } from '../util/location.js';
 const name = 'no-partially-commented-tag-lines';
 /**
  * A `#` on a tag line comments out everything after it. That is easy to do by
@@ -27,13 +27,16 @@ const rule = {
         }
         const errors = [];
         for (const line of [...tagLines].sort((a, b) => a - b)) {
-            const comment = file.lines[line - 1]?.indexOf('#') ?? -1;
-            if (comment !== -1) {
+            // As in Gherkin itself, only a # after whitespace starts a comment;
+            // one inside a tag, as in @issue#123, is part of the tag.
+            const text = file.lines[line - 1] ?? '';
+            const comment = /\s#/u.exec(text);
+            if (comment !== null) {
                 errors.push({
                     message: 'Partially commented tag lines not allowed',
                     rule: name,
                     // Point at the '#' itself: that is the character to remove.
-                    ...atLineColumn(line, comment + 1),
+                    ...atLineColumn(line, columnOf(text, comment.index + 1)),
                 });
             }
         }
@@ -41,4 +44,3 @@ const rule = {
     },
 };
 export default rule;
-//# sourceMappingURL=no-partially-commented-tag-lines.js.map

package/dist/rules/no-restricted-patterns.d.ts

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

package/dist/rules/no-restricted-patterns.js

@@ -2,6 +2,7 @@ import { getNeutralKeyword, getNodeType } from '../gherkin/keywords.js';
 import { rulesOf, stepContainersOf } from '../gherkin/traverse.js';
 import { mergeDefaults } from '../util/collections.js';
 import { at } from '../util/location.js';
+import { invalidPatterns } from '../util/patterns.js';
 const name = 'no-restricted-patterns';
 /**
  * Patterns are grouped by where they apply. `Global` applies everywhere; the
@@ -51,51 +52,95 @@ function toCheckableStrings(property, value) {
 const rule = {
     name,
     availableConfigs,
-    run(feature, _file, configuration) {
+    verifySettings: (settings) => Object.entries(settings).flatMap(([key, patterns]) => invalidPatterns(key, patterns, 'i')),
+    run(feature, file, configuration) {
         if (feature === undefined) {
             return [];
         }
         const patterns = compilePatterns(mergeDefaults(availableConfigs, configuration));
         const language = feature.language;
         const errors = [];
-        const check = (node, property, value, applicable) => {
+        /** Reports every pattern the text matches, at the given position. */
+        const report = (type, property, text, applicable, position) => {
+            for (const pattern of applicable) {
+                if (pattern.test(text)) {
+                    errors.push({
+                        message: `${type} ${property}: "${text}" matches restricted pattern "${pattern}"`,
+                        rule: name,
+                        ...position,
+                    });
+                }
+            }
+        };
+        const check = (node, property, value, applicable, location = node.location) => {
             if (value === undefined || value === '') {
                 return;
             }
+            // Names may be padded with whitespace; steps are not.
+            report(getNodeType(node, language), property, value.trim(), applicable, at(location));
+        };
+        /**
+         * A description, line by line, each reported on the line it is written
+         * on. The description starts below the keyword line, and a comment
+         * between its lines is left out of it, so each line is looked for in the
+         * file rather than counted.
+         */
+        const checkDescription = (node, applicable) => {
+            if (node.description === undefined || node.description === '') {
+                return;
+            }
             const type = getNodeType(node, language);
-            for (const pattern of applicable) {
-                for (const candidate of toCheckableStrings(property, value)) {
-                    // Names and descriptions may be padded with whitespace; steps are not.
-                    const text = candidate.trim();
-                    if (pattern.test(text)) {
-                        errors.push({
-                            message: `${type} ${property}: "${text}" matches restricted pattern "${pattern}"`,
-                            rule: name,
-                            ...at(node.location),
-                        });
-                    }
-                }
+            let searchFrom = node.location.line;
+            for (const candidate of toCheckableStrings('description', node.description)) {
+                const text = candidate.trim();
+                if (text === '')
+                    continue;
+                const index = file.lines.findIndex((line, lineIndex) => lineIndex >= searchFrom && line.trim() === text);
+                const line = index === -1 ? node.location.line : index + 1;
+                if (index !== -1)
+                    searchFrom = index + 1;
+                report(type, 'description', text, applicable, { line });
             }
         };
         const patternsFor = (node) => patterns.get(getNeutralKeyword(node, language)) ?? [];
         check(feature, 'name', feature.name, patternsFor(feature));
-        check(feature, 'description', feature.description, patternsFor(feature));
+        checkDescription(feature, patternsFor(feature));
         for (const featureRule of rulesOf(feature)) {
             const applicable = patternsFor(featureRule);
             check(featureRule, 'name', featureRule.name, applicable);
-            check(featureRule, 'description', featureRule.description, applicable);
+            checkDescription(featureRule, applicable);
         }
         for (const { node } of stepContainersOf(feature)) {
             const applicable = patternsFor(node);
             check(node, 'name', node.name, applicable);
-            check(node, 'description', node.description, applicable);
-            // Steps are checked against the patterns of the block they sit in.
+            checkDescription(node, applicable);
+            // Steps, and what they carry, are checked against the patterns of the
+            // block they sit in.
             for (const step of node.steps) {
                 check(step, 'text', step.text, applicable);
+                for (const row of step.dataTable?.rows ?? []) {
+                    for (const cell of row.cells) {
+                        if (cell.value.trim() !== '') {
+                            report('Step', 'data table', cell.value.trim(), applicable, at(cell.location));
+                        }
+                    }
+                }
+                if (step.docString !== undefined) {
+                    const { content, location } = step.docString;
+                    content.split('\n').forEach((line, index) => {
+                        if (line.trim() !== '') {
+                            report('Step', 'doc string', line.trim(), applicable, { line: location.line + 1 + index });
+                        }
+                    });
+                }
+            }
+            // An outline's Examples belong to it, and take its patterns.
+            for (const examples of 'examples' in node ? node.examples : []) {
+                check(examples, 'name', examples.name, applicable);
+                checkDescription(examples, applicable);
             }
         }
         return errors;
     },
 };
 export default rule;
-//# sourceMappingURL=no-restricted-patterns.js.map

package/dist/rules/no-restricted-tags.d.ts

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