{"_id":"@4awpawz/ghif","_rev":"1-01d7df70cf9d99fe7350485fe3331587","name":"@4awpawz/ghif","dist-tags":{"latest":"1.1.0"},"versions":{"1.0.0":{"name":"@4awpawz/ghif","version":"1.0.0","description":"An issues formatter for Github's gh CLI issues","main":"ghif.mjs","bin":{"ghif":"cli.mjs"},"type":"module","scripts":{},"keywords":["cli","issues"],"author":{"name":"Jeffrey Schwartz, aka 4awpawz"},"repository":{"type":"git","url":"git+https://github.com/4awpawz/ghif.git"},"license":"MIT","dependencies":{"fs-extra":"^11.2.0"},"_id":"@4awpawz/ghif@1.0.0","gitHead":"da8cde86ed5db78a1cdf81e123a8803876c670f3","bugs":{"url":"https://github.com/4awpawz/ghif/issues"},"homepage":"https://github.com/4awpawz/ghif#readme","_nodeVersion":"20.11.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-mh/Tt+1DNdB1OzXK7BjhtQkec/k0mvkxXpr4+N64ZsuWjdLmkoo65GBeFE/JlbiFhQi4IhfMn+0ZeYrQvAEpIw==","shasum":"6712ca0e74139197f7f0203bc08cb2e9f78e09f8","tarball":"https://registry.npmjs.org/@4awpawz/ghif/-/ghif-1.0.0.tgz","fileCount":4,"unpackedSize":6261,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCBMUmfzi1JqVmMK84KBoFc/BdyLNEdxluRPiOdb9cimgIgWd6VxCHK/0xGp/pXubl1sKp6O/WJzvzl9rlPSS1OgEQ="}]},"_npmUser":{"name":"jeffreyschwartz","email":"jefftschwartz@gmail.com"},"directories":{},"maintainers":[{"name":"jeffreyschwartz","email":"jefftschwartz@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ghif_1.0.0_1707841612183_0.45452056306794497"},"_hasShrinkwrap":false},"1.1.0":{"name":"@4awpawz/ghif","version":"1.1.0","description":"An issues formatter for Github's gh CLI issues","main":"ghif.mjs","bin":{"ghif":"cli.mjs"},"type":"module","scripts":{},"keywords":["github","cli","gh","issues","list","format","markdown"],"author":{"name":"Jeffrey Schwartz, aka 4awpawz"},"repository":{"type":"git","url":"git+https://github.com/4awpawz/ghif.git"},"license":"MIT","dependencies":{"chalk":"^5.3.0","fs-extra":"^11.2.0"},"_id":"@4awpawz/ghif@1.1.0","gitHead":"73b641cea293af6e5255fbcd3b26e1270c756b1f","bugs":{"url":"https://github.com/4awpawz/ghif/issues"},"homepage":"https://github.com/4awpawz/ghif#readme","_nodeVersion":"20.11.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-2vztDIL3CMUVPOxNk/iaoTvF77WYyfz+DbdDOqitk9uWFFA/tJXNNqEA//85GhDeo2I62M07V3NwSh3UiL/cUw==","shasum":"1863210b2bfd7cc54bf1dbc43696272db43cd482","tarball":"https://registry.npmjs.org/@4awpawz/ghif/-/ghif-1.1.0.tgz","fileCount":7,"unpackedSize":51402523,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC2V+tr8Facp/NhfncGBfkB1IgPTQcebFWnGpbbT/mmwAIgLK8HS6FnOcXBTcoYJDagVMvmUpd2W9bu+swYuiX6gwk="}]},"_npmUser":{"name":"jeffreyschwartz","email":"jefftschwartz@gmail.com"},"directories":{},"maintainers":[{"name":"jeffreyschwartz","email":"jefftschwartz@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ghif_1.1.0_1708454783297_0.4134038976211747"},"_hasShrinkwrap":false}},"time":{"created":"2024-02-13T16:26:52.055Z","1.0.0":"2024-02-13T16:26:52.344Z","modified":"2024-02-20T18:46:24.960Z","1.1.0":"2024-02-20T18:46:24.093Z"},"maintainers":[{"name":"jeffreyschwartz","email":"jefftschwartz@gmail.com"}],"description":"An issues formatter for Github's gh CLI issues","homepage":"https://github.com/4awpawz/ghif#readme","keywords":["github","cli","gh","issues","list","format","markdown"],"repository":{"type":"git","url":"git+https://github.com/4awpawz/ghif.git"},"author":{"name":"Jeffrey Schwartz, aka 4awpawz"},"bugs":{"url":"https://github.com/4awpawz/ghif/issues"},"license":"MIT","readme":"# _ghif_, an issues formatter for Github's CLI `gh issue list` \n<img style=\"border-radius: 3px; border: 2px solid #ffffff; margin: 24px 0; box-shadow: 4px 4px 1px 1px #888\" src=\"./readme-assets/demo.gif\" alt=\"changelog image\">\n<br>\n\nMaintaining a project's changelog shouldn't be a chore yet it often ends up being one. Having to repetitively cut and paste from our Github issues into our project's changelog and then having to format everything in a consistent manner can be a significant task in its own right.\nThat's where _ghif_ steps in to radically reduce the effort of changelog maintenance.\n\n_ghif_ is a simple command line utility that takes the issues output from Github's `gh issue list --json \"number,title,labels\"` command, formats them according to any additional _ghif_ _formatting options_ that you provide (please see below), and then sends the formatted output to stdout. \n\n⚠️ ___ghif_ expects _gh issue list_ to return JSON and for issue objects to contain the _number, title and labels_ fields and will fail to run otherwise. Therefor the minimum <em>gh issue list</em> command required is the following:__\n\n```console\n> gh issue list --json \"number,title,labels\"\n```\nYou can, of course, include any of the _gh issue list filters_ that support your project's use case, such as _status (-s), repository (--repo), milestone (-m), etc_. \n\n## Installation\n\n⚠️ ___ghif_ requires the [Github CLI](https://cli.github.com)__\n\n```shell\n> npm i -g 4awpawz/ghif\n```\n## Supported output formats and examples\n### Plain text\n```shell\n> gh issue list --json \"number,title,labels\" | ghif --text --header=\"v1.3.0\"\n```\nExample: _a list of issues with a heading_\n```text\nv1.3.0\n\n#98: Unresolved token reporting drops the last closing brace for include tokens. [bug, revision]\n#97: Log warning to the console if user project does not have a 404.html document. [feature, revision]\n#96: Though template front matter is documented as a requirement, this is not enforced in the codebase. [wontfix, revision]\n#95: Update to Node v18.18.0 LTS and address all related issues. [revision]\n#94: Include cache bust metric when release is called without the --verbose option and is called with the --cache-bust option. [revision]\n#93: Refactor the cli help to accommodate multiple command options. [feature]\n#92: Provide CLI --verbose logging option. [feature, revision]\n#91: Update Buster dependency to v1.1.0. [revision]\n```\n### Markdown\nAs a list:\n```shell\n> gh issue list --json \"number,title,labels\" | ghif --markdown-list --header=\"## v1.3.0\"\n```\nExample: _a list of issues with a h2 header_\n```text\n## v1.3.0\n\n#98: Unresolved token reporting drops the last closing brace for include tokens. [bug, revision]\n\n#97: Log warning to the console if user project does not have a 404.html document. [feature, revision]\n\n#96: Though template front matter is documented as a requirement, this is not enforced in the codebase. [wontfix, revision]\n\n#95: Update to Node v18.18.0 LTS and address all related issues. [revision]\n\n#94: Include cache bust metric when release is called without the --verbose option and is called with the --cache-bust option. [revision]\n\n#93: Refactor the cli help to accommodate multiple command options. [feature]\n\n#92: Provide CLI --verbose logging option. [feature, revision]\n\n#91: Update Buster dependency to v1.1.0. [revision]\n```\nAs an unordered list:\n```shell\n> gh issue list --json \"number,title,labels\" | ghif --markdown-unordered-list\n```\nExample: _an unordered list of issues_\n```markdown\n- #98: Unresolved token reporting drops the last closing brace for include tokens. [bug, revision]\n- #97: Log warning to the console if user project does not have a 404.html document. [feature, revision]\n- #96: Though template front matter is documented as a requirement, this is not enforced in the codebase. [wontfix, revision]\n- #95: Update to Node v18.18.0 LTS and address all related issues. [revision]\n- #94: Include cache bust metric when release is called without the --verbose option and is called with the --cache-bust option. [revision]\n- #93: Refactor the cli help to accommodate multiple command options. [feature]\n- #92: Provide CLI --verbose logging option. [feature, revision]\n- #91: Update Buster dependency to v1.1.0. [revision]\n```\nAs an ordered list:\n```shell\n> gh issue list --json \"number,title,labels\" | ghif --markdown-ordered-list\n```\nExample: _an ordered list of issues_\n```markdown\n1. #98: Unresolved token reporting drops the last closing brace for include tokens. [bug, revision]\n1. #97: Log warning to the console if user project does not have a 404.html document. [feature, revision]\n1. #96: Though template front matter is documented as a requirement, this is not enforced in the codebase. [wontfix, revision]\n1. #95: Update to Node v18.18.0 LTS and address all related issues. [revision]\n1. #94: Include cache bust metric when release is called without the --verbose option and is called with the --cache-bust option. [revision]\n1. #93: Refactor the cli help to accommodate multiple command options. [feature]\n1. #92: Provide CLI --verbose logging option. [feature, revision]\n1. #91: Update Buster dependency to v1.1.0. [revision]\n```\n## Usage examples\n_Output text to the terminal_\n```shell\n> gh issue list -s closed -m \"v1.3.0\" --json \"number,title,labels\" --repo 4awpawz/fusion.ssg | ghif --text\n```\n_Pipe text output to a text file_\n```shell\n> gh issue list -s closed -m \"v1.3.0\" --json \"number,title,labels\" --repo 4awpawz/fusion.ssg | ghif --text > issues.txt\n```\n_Pipe markdown output to a markdown file_\n```shell\n> gh issue list -s closed -m \"v1.3.0\" --json \"number,title,labels\" --repo 4awpawz/fusion.ssg | ghif --markdown-unordered-list --blank-line-between-issues > issues.md\n```\n### Formatting options\n- `--colored-labels`: colorize labels, ignored if output format is not markdown\n- `--blank-line-between-issues`: output a blank line between issues \n- `--text`: output a list of issues as plain text\n- `--markdown-list`: output a list of issues in markdown\n- `--markdown-unordered-list`: output an unordered list of issues in markdown\n- `--markdown-ordered-list`: output an ordered list of issues in markdown\n- `--header`: prepend a header (e.g. V1.0.3) to the output, supports markdown headers and plain text headings\n## Show some love ❤️\n<a href=\"https://www.buymeacoffee.com/4awpawz\"><img src=\"./readme-assets/buymeacoffee.png\" alt=\"image\"></a>\n\nIf using _ghif_ provides you value then please click on the repository's _Star_ button.\n\nIf you would like to be notified when there are changes then please click on the repository's _Watch_ button.\n\n","readmeFilename":"README.md"}