Diff and check command line formatting - Githubissues

cucumber / gherkin-utils

API for working with Gherkin documents

MIT License

11 stars 4 forks source link

Diff and check command line formatting #76

Open kieran-ryan opened 5 months ago

kieran-ryan commented 5 months ago

🤔 What's changed?

Exit code 1 if files reformatted or would be reformatted
--check option to check whether reformatting would occur without writing changes
--diff option to check whether reformatting would occur without writing changes; and output diff
Support formatting against directories
Counts for failures, unchanged and formatted files

> npx @cucumber/gherkin-utils format features
❌ 7 files failed to format
🥒 14 files left unchanged
🥒 25 files reformatted

Debt

Prevent writing back to file if no changes to be made
Updated issues URL in parser error message from common repo to gherkin parser
Migrated from deprecated commander-js API to specify argument descriptions in .description rather .argument
Updated README from outdated --move API to --to-syntax

⚡️ What's your motivation?

Enables increased proliferation of Gherkin Utils across repositories containing feature files - for validating formatting in continous integration pipelines
Simplifies usage to run Gherkin Utils against directories containing feature files
Enables checking would formatting occur without writing changes
Counts provides much greater clarity on changes

Debt

Eliminate redundant write operations
Ensure parse error messages raised to correct repository
Ensure commander-js using latest APIs
Align docs with latest API

🏷️ What kind of change is this?

:zap: New feature (non-breaking change which adds new behaviour)

♻️ Anything particular you want feedback on?

Whether should default formatter to run against a features directory (e.g. npx @cucumber/gherkin-utils format) to simplify common usage
Whether can remove --from-syntax command line option. Not sure is required as syntax (gherkin or markdown) can be determined

📋 Checklist:

[x] I agree to respect and uphold the Cucumber Community Code of Conduct
[x] I've changed the behaviour of the code
- [ ] I have added/updated tests to cover my changes.
[x] My change requires a change to the documentation.
- [x] I have updated the documentation accordingly.
[x] Users should know about my change
- [ ] I have added an entry to the "Unreleased" section of the CHANGELOG, linking to this pull request.

This text was originally generated from a template, then edited by hand. You can modify the template here.