{"id":18278000,"url":"https://github.com/tanem/shelljs-plugin-authors","last_synced_at":"2025-04-05T04:30:54.122Z","repository":{"id":37617276,"uuid":"145325593","full_name":"tanem/shelljs-plugin-authors","owner":"tanem","description":":shell: A ShellJS plugin for generating a nicely formatted list of authors.","archived":false,"fork":false,"pushed_at":"2024-04-08T05:03:54.000Z","size":1723,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-14T14:59:29.804Z","etag":null,"topics":["authors","git","script","shelljs","shelljs-plugin","shortlog"],"latest_commit_sha":null,"homepage":"https://npm.im/shelljs-plugin-authors","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tanem.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null}},"created_at":"2018-08-19T17:52:35.000Z","updated_at":"2024-04-22T02:12:07.423Z","dependencies_parsed_at":"2023-10-14T15:22:57.234Z","dependency_job_id":"dfd7d138-77ed-4966-8c56-aa8a5a92483a","html_url":"https://github.com/tanem/shelljs-plugin-authors","commit_stats":{"total_commits":438,"total_committers":3,"mean_commits":146.0,"dds":0.5410958904109588,"last_synced_commit":"aa3af6700e487836efea70a0ec6f5da94306657f"},"previous_names":[],"tags_count":169,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tanem%2Fshelljs-plugin-authors","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tanem%2Fshelljs-plugin-authors/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tanem%2Fshelljs-plugin-authors/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tanem%2Fshelljs-plugin-authors/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tanem","download_url":"https://codeload.github.com/tanem/shelljs-plugin-authors/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247289382,"owners_count":20914463,"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":["authors","git","script","shelljs","shelljs-plugin","shortlog"],"created_at":"2024-11-05T12:22:36.204Z","updated_at":"2025-04-05T04:30:51.074Z","avatar_url":"https://github.com/tanem.png","language":"JavaScript","readme":"# shelljs-plugin-authors\n\n[![npm version](https://img.shields.io/npm/v/shelljs-plugin-authors.svg?style=flat-square)](https://www.npmjs.com/package/shelljs-plugin-authors)\n[![build status](https://img.shields.io/github/workflow/status/tanem/shelljs-plugin-authors/CI?style=flat-square)](https://github.com/tanem/shelljs-plugin-authors/actions?query=workflow%3ACI)\n[![coverage status](https://img.shields.io/codecov/c/github/tanem/shelljs-plugin-authors.svg?style=flat-square)](https://codecov.io/gh/tanem/shelljs-plugin-authors)\n[![npm downloads](https://img.shields.io/npm/dm/shelljs-plugin-authors.svg?style=flat-square)](https://www.npmjs.com/package/shelljs-plugin-authors)\n[![shelljs-plugin](https://img.shields.io/badge/shelljs-plugin-brightgreen.svg?style=flat-square)](https://github.com/shelljs/shelljs/wiki/Using-ShellJS-Plugins)\n\n\u003e A [ShellJS](https://github.com/shelljs/shelljs) plugin for generating a nicely formatted list of authors.\n\n## Usage\n\nLet's assume that we're inside a git repo, and the output of `git shortlog -se` gives us something like:\n\n```\n    24  Andrew Powlowski \u003cAndrew_Powlowski@yahoo.com\u003e\n    39  Gregorio Heaney \u003cGregorio.Heaney43@yahoo.com\u003e\n    55  Miller Reichel \u003cMiller_Reichel@yahoo.com\u003e\n    70  Mervin Graham \u003cMervin69@yahoo.com\u003e\n    99  Hallie Paucek \u003cHallie.Paucek@yahoo.com\u003e\n```\n\nWe want to generate a nicely formatted list of authors sorted alphabetically by author name. There are two ways to do that with this module, first you can use it as a ShellJS plugin:\n\n```js\nconst shell = require('shelljs')\nrequire('shelljs-plugin-authors')\nconst authors = shell.authors()\nshell.echo(authors.stdout)\n/*\nAndrew Powlowski \u003cAndrew_Powlowski@yahoo.com\u003e\nGregorio Heaney \u003cGregorio.Heaney43@yahoo.com\u003e\nMiller Reichel \u003cMiller_Reichel@yahoo.com\u003e\nMervin Graham \u003cMervin69@yahoo.com\u003e\nHallie Paucek \u003cHallie.Paucek@yahoo.com\u003e\n*/\n```\n\nOr you can use it via the CLI:\n\n```\n$ shelljs-authors\nAndrew Powlowski \u003cAndrew_Powlowski@yahoo.com\u003e\nGregorio Heaney \u003cGregorio.Heaney43@yahoo.com\u003e\nMiller Reichel \u003cMiller_Reichel@yahoo.com\u003e\nMervin Graham \u003cMervin69@yahoo.com\u003e\nHallie Paucek \u003cHallie.Paucek@yahoo.com\u003e\n```\n\nIf you'd prefer the list be sorted by number of commits per author, pass the `-n` option:\n\n```js\nconst shell = require('shelljs')\nrequire('shelljs-plugin-authors')\nconst authors = shell.authors('-n')\nshell.echo(authors.stdout)\n/*\nHallie Paucek \u003cHallie.Paucek@yahoo.com\u003e\nMervin Graham \u003cMervin69@yahoo.com\u003e\nMiller Reichel \u003cMiller_Reichel@yahoo.com\u003e\nGregorio Heaney \u003cGregorio.Heaney43@yahoo.com\u003e\nAndrew Powlowski \u003cAndrew_Powlowski@yahoo.com\u003e\n*/\n```\n\n```\n$ shelljs-authors -n\nHallie Paucek \u003cHallie.Paucek@yahoo.com\u003e\nMervin Graham \u003cMervin69@yahoo.com\u003e\nMiller Reichel \u003cMiller_Reichel@yahoo.com\u003e\nGregorio Heaney \u003cGregorio.Heaney43@yahoo.com\u003e\nAndrew Powlowski \u003cAndrew_Powlowski@yahoo.com\u003e\n```\n\n## API\n\n### Plugin\n\n**Options**\n\n- `-n` - _Optional_ Sort the list by number of commits per author.\n\n**Example**\n\n```js\nshell.authors('-n')\n```\n\n### CLI\n\n```\n$ shelljs-authors -h\n\n  Usage: shelljs-authors [options]\n\n  Generate a nicely formatted list of authors\n\n  Options:\n\n    -V, --version   output the version number\n    -n, --numbered  Sort by number of commits per author\n    -h, --help      output usage information\n\n  Examples:\n\n    $ shelljs-authors\n    $ shelljs-authors -n\n```\n\n## Installation\n\n### Plugin\n\n```\n$ npm i -D shelljs shelljs-plugin-authors\n```\n\n### CLI\n\n```\n$ npm i -g shelljs shelljs-plugin-authors\n```\n\n## License\n\nMIT\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftanem%2Fshelljs-plugin-authors","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftanem%2Fshelljs-plugin-authors","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftanem%2Fshelljs-plugin-authors/lists"}