{"id":27627045,"url":"https://github.com/gplint/gplint","last_synced_at":"2025-04-23T13:20:57.310Z","repository":{"id":36982426,"uuid":"409184479","full_name":"gplint/gplint","owner":"gplint","description":"A Gherkin/Pickle linter written in javascript","archived":false,"fork":false,"pushed_at":"2025-04-15T02:58:18.000Z","size":3015,"stargazers_count":6,"open_issues_count":11,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-15T16:38:35.076Z","etag":null,"topics":["cucumber","gherkin","lint","linter","linting","pickle","testing"],"latest_commit_sha":null,"homepage":"https://gplint.github.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gplint.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"ko_fi":"nyaran","custom":["https://www.buymeacoffee.com/nyaran"]}},"created_at":"2021-09-22T11:51:37.000Z","updated_at":"2025-04-08T07:24:31.000Z","dependencies_parsed_at":"2023-10-20T09:57:36.740Z","dependency_job_id":"bfd65880-416c-4209-a9f1-376ab0904683","html_url":"https://github.com/gplint/gplint","commit_stats":{"total_commits":989,"total_committers":46,"mean_commits":21.5,"dds":0.506572295247725,"last_synced_commit":"5d5e0c8e7133227a21dc94e70add66e8add28d31"},"previous_names":["gplint/gplint"],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gplint%2Fgplint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gplint%2Fgplint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gplint%2Fgplint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gplint%2Fgplint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gplint","download_url":"https://codeload.github.com/gplint/gplint/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250439370,"owners_count":21430839,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cucumber","gherkin","lint","linter","linting","pickle","testing"],"created_at":"2025-04-23T13:20:56.697Z","updated_at":"2025-04-23T13:20:57.301Z","avatar_url":"https://github.com/gplint.png","language":"TypeScript","funding_links":["https://ko-fi.com/nyaran","https://www.buymeacoffee.com/nyaran"],"categories":[],"sub_categories":[],"readme":"# GPLint (Gherkin/Pickle Linter)\n\n[![Test](https://github.com/gplint/gplint/actions/workflows/test.yml/badge.svg)](https://github.com/gplint/gplint/actions/workflows/test.yml)\n[![codecov](https://codecov.io/gh/gplint/gplint/branch/main/graph/badge.svg?token=JAAQ2DCW9D)](https://codecov.io/gh/gplint/gplint)\n[![npm](https://img.shields.io/npm/dw/gplint)](https://www.npmjs.com/package/gplint)\n\nUses [Gherkin](https://github.com/cucumber/gherkin-javascript) to parse feature files and runs linting against the\ndefault rules, and the optional rules you specified in your `.gplintrc` file.\n\nForked from [gherkin-lint](https://github.com/vsiakka/gherkin-lint)\n\n## Documentation\n\nAccess to the documentation site to know how to use GPLint: https://gplint.github.io/\n\n## Quickstart\n\nWe encourage to check the site for complete documentation, but as quick start you can follow this:\n\n### Installation\n\nInstall as development dependency:\n\n```shell\nnpm install --save-dev gplint\n```\n\n### Create basic configuration\n\nSet some basic rules to validate your gherkin files, to do that, create a file called `.gplintrc` with the following\ncontent:\n\n#### **`.gplintrc`**\n\n```json\n{\n  \"allow-all-caps\": [\n    \"error\",\n    {\n      \"Global\": false,\n      \"Description\": false,\n      \"ExampleHeader\": true,\n      \"ExampleBody\": true\n    }\n  ],\n  \"allow-all-lowercase\": [\n    \"error\",\n    {\n      \"Global\": false,\n      \"Description\": false,\n      \"Step\": true,\n      \"ExampleHeader\": true,\n      \"ExampleBody\": true\n    }\n  ],\n  \"file-name\": [\n    \"warn\",\n    {\n      \"style\": \"camelCase\",\n      \"allowAcronyms\": true\n    }\n  ],\n  \"keywords-in-logical-order\": [\n    \"error\",\n    {\n      \"detectMissingKeywords\": true\n    }\n  ],\n  \"no-superfluous-tags\": \"warn\",\n  \"no-unnamed-features\": \"error\",\n  \"no-unnamed-scenarios\": \"error\",\n  \"no-unused-variables\": \"warn\"\n}\n```\n\n### Run it!\n\nRun it, checking the Gherkin files you have on `test/features` folder.\n\n```shell\ngplint tests/features\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgplint%2Fgplint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgplint%2Fgplint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgplint%2Fgplint/lists"}