cypress-xray-plugin/src/hooks/preprocessor/commands/parsing/gherkin.d.ts

A Cypress plugin for uploading test results to Xray (test management for Jira)

import type { GherkinDocument } from "@cucumber/messages";
/**
 * Parses a Gherkin document (feature file) and returns the information contained within.
 *
 * @param file - the path to the feature file
 * @param encoding - the file's encoding
 * @returns an object containing the data of the feature file
 * @example
 *   const data = parseFeatureFile("myTetest.feature")
 *   console.log(data.feature.children[0].scenario); // steps, name, ...
 * @see https://github.com/cucumber/messages/blob/main/javascript/src/messages.ts
 */
export declare function parseFeatureFile(file: string, encoding?: BufferEncoding): GherkinDocument;