{ "info": { "author": "Duc-Minh Phan", "author_email": "alephvn@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3 :: Only", "Topic :: Software Development :: Quality Assurance" ], "description": "# Reformat-gherkin\n\n[![Build Status](https://dev.azure.com/alephvn/reformat-gherkin/_apis/build/status/ducminh-phan.reformat-gherkin?branchName=master)](https://dev.azure.com/alephvn/reformat-gherkin/_build/latest?definitionId=1&branchName=master)   [![Build Status](https://travis-ci.com/ducminh-phan/reformat-gherkin.svg?branch=master)](https://travis-ci.com/ducminh-phan/reformat-gherkin)   [![Coverage Status](https://coveralls.io/repos/github/ducminh-phan/reformat-gherkin/badge.svg?branch=master)](https://coveralls.io/github/ducminh-phan/reformat-gherkin?branch=master)\n\n[![Maintainability](https://api.codeclimate.com/v1/badges/16718a231901c293215d/maintainability)](https://codeclimate.com/github/ducminh-phan/reformat-gherkin/maintainability)   [![Codacy Badge](https://api.codacy.com/project/badge/Grade/e675ca51b6ac436a980facbcf04b8e5a)](https://www.codacy.com/app/ducminh-phan/reformat-gherkin)\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)   [![PyPI](https://img.shields.io/pypi/v/reformat-gherkin.svg)](https://pypi.org/project/reformat-gherkin/)   [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)\n\n## Table of Contents\n\n- [About](#about)\n- [Getting Started](#getting-started)\n- [Usage](#usage)\n- [Pre-commit hook](#pre-commit-hook)\n- [Acknowledgements](#acknowledgements)\n\n## About\n\nThis tool is a formatter for Gherkin files. It ensures consistent look regardless of the project and authors.\n\n`reformat-gherkin` can be used either as a command-line tool, or a `pre-commit` hook.\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\n\n### Prerequisites\n\n- [Python 3.6+](https://www.python.org/downloads/)\n- [Poetry](https://poetry.eustace.io/)\n\n### Installing\n\n1. Clone this repository\n ```bash\n git clone https://github.com/ducminh-phan/reformat-gherkin.git\n ```\n\n2. Install dependencies\n ```bash\n cd reformat-gherkin\n poetry install\n ```\n\n## Usage\n\n Usage: reformat-gherkin [OPTIONS] [SRC]...\n \n Reformat the given Gherkin files and all files in the given directories\n recursively.\n \n Options:\n --check Don't write the files back, just return the\n status. Return code 0 means nothing would\n change. Return code 1 means some files would\n be reformatted. Return code 123 means there\n was an internal error.\n -a, --alignment [left|right] Specify the alignment of step keywords (Given,\n When, Then,...). If specified, all statements\n after step keywords are left-aligned, spaces\n are inserted before/after the keywords to\n right/left align them. By default, step\n keywords are left-aligned, and there is a\n single space between the step keyword and the\n statement.\n -n, --newline [LF|CRLF] Specify the line separators when formatting\n files inplace. If not specified, line\n separators are preserved.\n --fast / --safe If --fast given, skip the sanity checks of\n file contents. [default: --safe]\n --config FILE Read configuration from FILE.\n --version Show the version and exit.\n --help Show this message and exit.\n\n### Config file\n\nThe tool is able to read project-specific default values for its command line options from a `.reformat-gherkin.yaml` file.\n\nBy default, `reformat-gherkin` looks for the config file starting from the common base directory of all files and directories passed on the command line. If it's not there, it looks in parent directories. It stops looking when it finds the file, or a .git directory, or a .hg directory, or the root of the file system, whichever comes first.\n\nExample config file\n\n```yaml\ncheck: False\nalignment: left\n```\n\n## Pre-commit hook\n\nOnce you have installed [pre-commit](https://pre-commit.com/), add this to the `.pre-commit-config.yaml` in your repository:\n\n repos:\n - repo: https://github.com/ducminh-phan/reformat-gherkin\n rev: stable\n hooks:\n - id: reformat-gherkin\n\nThen run `pre-commit install` and you're ready to go.\n\n## Acknowledgements\n\nThis project is inspired by [black](https://github.com/psf/black). Some functions are taken from `black`'s source code.\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ducminh-phan/reformat-gherkin", "keywords": "", "license": "MIT", "maintainer": "Duc-Minh Phan", "maintainer_email": "alephvn@gmail.com", "name": "reformat-gherkin", "package_url": "https://pypi.org/project/reformat-gherkin/", "platform": "", "project_url": "https://pypi.org/project/reformat-gherkin/", "project_urls": { "Homepage": "https://github.com/ducminh-phan/reformat-gherkin" }, "release_url": "https://pypi.org/project/reformat-gherkin/1.0.0/", "requires_dist": [ "gherkin-official (>=4.1,<5.0)", "click (>=7.0,<8.0)", "attrs (>=19.1,<20.0)", "cattrs (>=0.9.0,<0.10.0)", "pyyaml (>=5.1,<6.0)" ], "requires_python": ">=3.6,<4.0", "summary": "Formatter for Gherkin language", "version": "1.0.0" }, "last_serial": 5727303, "releases": { "0.2.3": [ { "comment_text": "", "digests": { "md5": "41858d60ded7153d538ae8464f8b58f0", "sha256": "568097491597fbd370c20c38873552e05219ee35663d2f48dc05a6921459b68d" }, "downloads": -1, "filename": "reformat_gherkin-0.2.3-py3-none-any.whl", "has_sig": false, "md5_digest": "41858d60ded7153d538ae8464f8b58f0", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 20820, "upload_time": "2019-06-23T04:08:13", "url": "https://files.pythonhosted.org/packages/a4/bf/a6451c971bdfcb1bdb255773d06c735be25fb3e9a2cad58120673110f064/reformat_gherkin-0.2.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "91c8bcbf941b4ae8906493147729e36a", "sha256": "4f2b5a5b38bf97f49eb3437fb576482452ade24cf27d11f80e85b7a3e8d95b3c" }, "downloads": -1, "filename": "reformat-gherkin-0.2.3.tar.gz", "has_sig": false, "md5_digest": "91c8bcbf941b4ae8906493147729e36a", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 14959, "upload_time": "2019-06-23T04:08:11", "url": "https://files.pythonhosted.org/packages/b7/8e/363109e5af6c0b622edf6c3bd6c5a42625081446e3dd662178005ddafb64/reformat-gherkin-0.2.3.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "c3150147047c111b046ce17c88a59ff9", "sha256": "b9b79cdf91ecb9f2d6ec662e59a83b10f18cf50198863d9ab6ff72dfa6821cdb" }, "downloads": -1, "filename": "reformat_gherkin-0.3.0-py3-none-any.whl", "has_sig": false, "md5_digest": "c3150147047c111b046ce17c88a59ff9", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 44461, "upload_time": "2019-06-29T08:13:08", "url": "https://files.pythonhosted.org/packages/4e/10/57ca1e91568242c223ce7ab378a8c134f8e1777700c97908466db22838dc/reformat_gherkin-0.3.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "15b254afa01401ee6287272ab40416c0", "sha256": "2dcb5219c6e7c65090d6900d41bedae5d6a01becf9ccd9b04cca79461ac8f367" }, "downloads": -1, "filename": "reformat-gherkin-0.3.0.tar.gz", "has_sig": false, "md5_digest": "15b254afa01401ee6287272ab40416c0", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 16057, "upload_time": "2019-06-29T08:13:06", "url": "https://files.pythonhosted.org/packages/5d/db/b439aadd5dbd68e58fd89b3a55d20624a3396fbb4db80dce7e79bd01e65c/reformat-gherkin-0.3.0.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "829a69e1c9043a586ff21931cb3d1e63", "sha256": "b9cc4bb6417b88be7c504b17b2ebe4fa355896acae9ae2fe258a125bf6cdb515" }, "downloads": -1, "filename": "reformat_gherkin-0.3.2-py3-none-any.whl", "has_sig": false, "md5_digest": "829a69e1c9043a586ff21931cb3d1e63", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 22154, "upload_time": "2019-06-29T08:27:10", "url": "https://files.pythonhosted.org/packages/6d/87/f77feb69dc2ac0e18e319c72a0ad23777e573512a9e1c7e59e76d0955c5c/reformat_gherkin-0.3.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b522eec5fc0737583c8d4aea3a894ea1", "sha256": "e0b8ba86a375a015d805b4209d4eaf25a2f8b98af02502486f99405efc33e37c" }, "downloads": -1, "filename": "reformat-gherkin-0.3.2.tar.gz", "has_sig": false, "md5_digest": "b522eec5fc0737583c8d4aea3a894ea1", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 16041, "upload_time": "2019-06-29T08:27:08", "url": "https://files.pythonhosted.org/packages/73/72/21da492780526e0d59d95752c293469b61845818477809ae01243a21fbd7/reformat-gherkin-0.3.2.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "4dd4caf311fe57cfe55d7aadadf21048", "sha256": "372504560d479c2179c8e41ed74f0143754074ef4703b68c5a0f5f948fa2c7af" }, "downloads": -1, "filename": "reformat_gherkin-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "4dd4caf311fe57cfe55d7aadadf21048", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 23042, "upload_time": "2019-08-25T15:11:28", "url": "https://files.pythonhosted.org/packages/99/ee/09d793731be4248c19eabdfbb639909010b51d7f5a2e5906fe57591579cc/reformat_gherkin-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9d0863a2d644a3c8c9c1b6af128c86d9", "sha256": "bc84df05e89a8392c80ea0d43a77d019660b5928fbbd8ef85456d3f270316ba8" }, "downloads": -1, "filename": "reformat-gherkin-1.0.0.tar.gz", "has_sig": false, "md5_digest": "9d0863a2d644a3c8c9c1b6af128c86d9", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 17246, "upload_time": "2019-08-25T15:11:26", "url": "https://files.pythonhosted.org/packages/0d/52/2be8bd26b057729dc5e00c22f772853dd665077d2429cb4e601ce5976a01/reformat-gherkin-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "4dd4caf311fe57cfe55d7aadadf21048", "sha256": "372504560d479c2179c8e41ed74f0143754074ef4703b68c5a0f5f948fa2c7af" }, "downloads": -1, "filename": "reformat_gherkin-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "4dd4caf311fe57cfe55d7aadadf21048", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6,<4.0", "size": 23042, "upload_time": "2019-08-25T15:11:28", "url": "https://files.pythonhosted.org/packages/99/ee/09d793731be4248c19eabdfbb639909010b51d7f5a2e5906fe57591579cc/reformat_gherkin-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9d0863a2d644a3c8c9c1b6af128c86d9", "sha256": "bc84df05e89a8392c80ea0d43a77d019660b5928fbbd8ef85456d3f270316ba8" }, "downloads": -1, "filename": "reformat-gherkin-1.0.0.tar.gz", "has_sig": false, "md5_digest": "9d0863a2d644a3c8c9c1b6af128c86d9", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6,<4.0", "size": 17246, "upload_time": "2019-08-25T15:11:26", "url": "https://files.pythonhosted.org/packages/0d/52/2be8bd26b057729dc5e00c22f772853dd665077d2429cb4e601ce5976a01/reformat-gherkin-1.0.0.tar.gz" } ] }