{"_id":"@anchoredlabs/contrib","_rev":"1-4c40bc8246a75cc9a2a06b146573c550","name":"@anchoredlabs/contrib","dist-tags":{"latest":"0.1.0-beta.0"},"versions":{"0.1.0-beta.0":{"name":"@anchoredlabs/contrib","version":"0.1.0-beta.0","description":"Generate list of contributors from a git repo","bin":{"contrib":"src/cli.js"},"main":"src/index.js","scripts":{"start":"node src/index.js","dev":"nodemon src/index.js","debug":"node --nolazy --inspect-brk=9229 src/index.js","lint":"npm run prettier && npm run eslint","eslint":"eslint . --config ./.eslintrc.js --fix","prettier":"prettier \"**/*.{js,json,css,scss,vue,html,md}\" --write --list-different --loglevel warn","test":"echo \"Error: no test specified\" && exit 1","commit":"git add . && npx git-cz","release":"release-it"},"author":{"name":"Ryan Crosser","email":"ryankcrosser@gmail.com"},"license":"Apache-2.0","publishConfig":{"access":"public"},"config":{"commitizen":{"path":"./node_modules/conventional-changelog-cross"}},"devDependencies":{"@commitlint/cli":"^8.3.5","@commitlint/config-conventional":"^8.3.4","@release-it/conventional-changelog":"^1.1.0","commitizen":"^4.0.3","conventional-changelog-cross":"^1.0.0","cross-env":"^7.0.0","eslint":"^6.8.0","eslint-config-prettier":"^6.10.0","eslint-plugin-prettier":"^3.1.2","husky":"^4.2.3","lint-staged":"^10.0.7","nodemon":"^2.0.2","npm-run-all":"^4.1.5","prettier":"^1.19.1","pretty-quick":"^2.0.1","release-it":"^12.4.3"},"dependencies":{"detect-indent":"^6.0.0","sort-package-json":"^1.39.1","yargs":"^15.1.0"},"gitHead":"4bb96c5db4dad58410ec762324205c704ed5cd4d","_id":"@anchoredlabs/contrib@0.1.0-beta.0","_nodeVersion":"12.12.0","_npmVersion":"6.11.3","dist":{"integrity":"sha512-LrF2J0AjJHdxiED8bBOxYD1u4QZuQxBo/fipWF84vqCx0NZgVIVTjTifsrtVN6d7vuGvLM8mRHvi2DmkYbWvCA==","shasum":"d7fb188f68b31a120161feb18d4674ff8f54fbc8","tarball":"https://registry.npmjs.org/@anchoredlabs/contrib/-/contrib-0.1.0-beta.0.tgz","fileCount":18,"unpackedSize":20913,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeSf1TCRA9TVsSAnZWagAALQ8QAI+JImrM75MehhwTa5dq\nF6cOxprHQ/IbYed0JxURE8VsWDfc9U5DFvh6lauTm25G4GV2xGrf9cNUuLzT\n9qYIyHmphg42ZIOQfB0i+Dm8HAQUn9ftdWVupRwjejU8XBpC4bWENCy7E9xn\nZAYAyD+6r5C/bhS8iCH2w8WQpr9a+dBpFRqcKPSC2/BLqDpUvoBuRMRj8vch\n7rSfofkb63cQCdMbyQj8opyOg2vAWsdGjclA3HnE93/HsEJfRQaY420nAQ4k\np/MM6BQZOczlODn76+YX5LIHQ/AEkwYXwIkdywmk/R8+YkzgJEhMN9LTa02d\nbXwlCBRqM2NXi8WGfkdAdeX7S5cih0DUYY/QahDJhpBZ6lNJitq0pp7SdxtA\nrCYyn+6SoXCwNzOFohTmLVkFaXfZRKtZOSErm1RxyK4k4zn7VXmYMPSJLxl6\n+I7N7KuS/dYX7sWfMS3e1U239V0tFaDjlOIN9+3zmv0jIi2zMcS2Bkl/ns2n\nRvhzmfy/zmYaPWPRqEkGn4UQd1P5V7Y5UrvfYj/ucc+TdPgBvMKInUrDLHbU\no/8pSPFpW+vor9gsYYX5QngFSdOCW3jKM7mnJn/yRKqZ7ZJyXvrP0HcbNVEy\nGlg/ws6tkZd9znW+K6oUHsBnQVz/GLy0mcbQmX0hhZoIOOc6OSPHgOuXMF/4\nanAz\r\n=jMVT\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCASEF96qIqRcxmZ57VPFmWoBiuEPnV8+MgIxB0MwN1ygIgXh+XYVn2InJahK5bFre1+QDChqNCKxHRyoU5Dmel+Ik="}]},"maintainers":[{"name":"ryancrosser","email":"ryankcrosser@gmail.com"}],"_npmUser":{"name":"ryancrosser","email":"ryankcrosser@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/contrib_0.1.0-beta.0_1581907283542_0.6850512060025766"},"_hasShrinkwrap":false}},"time":{"created":"2020-02-17T02:41:23.302Z","0.1.0-beta.0":"2020-02-17T02:41:23.676Z","modified":"2022-04-04T13:57:08.776Z"},"maintainers":[{"name":"ryancrosser","email":"ryankcrosser@gmail.com"}],"description":"Generate list of contributors from a git repo","author":{"name":"Ryan Crosser","email":"ryankcrosser@gmail.com"},"license":"Apache-2.0","readme":"# Contrib\n\nA CLI tools to generate a CONTRIBUTORS file based on git commits to highlight the work of the contributors to the project\n\n## Install\n\nWith npm:\n\n```\n# global (to use as a CLI tool)\nnpm install --global @anchoredlabs/contrib\n\n# to use programmatically\nnpm install -D @anchoredlabs/contrib\n```\n\nWith yarn:\n\n```\n# global (to use as a CLI tool)\nyarn global add @anchoredlabs/contrib\n\n# to use programmatically\nyarn add --dev @anchoredlabs/contrib\n```\n\n## Usage\n\n```\n# from the project directory with default options\ncontrib\n\n# to generate the list of contributors for a different directory, use the `cwd` flag\ncontrib --cwd path/to/another/directory\n```\n\n## API\n\n### contrib(options?)\n\nCreates a `CONTRIBUTORS.md` file in the current working directory\n\n#### options\n\nType: `object`\nYou can specify the below options.\n\n##### cwd\ncwd Current working directory of the script\nDefault: current working directory\n\nType: `string`\\\nDefault: `process.cwd()`\n\nWorking directory to find `.git` directory.\n\n##### contributors-file\nType: `boolean`\\\nDefault: `true`\n\nWhether or not the generated contributors are added to the contributors file (file will be created if it does not exist)\n\n##### package-file\n\nType: `boolean`\\\nDefault: `false`\n\nWhether or not the generated contributors are added to the package.json file\n\n##### sort, s\n\nType: `string`\\\nDefault: `lastName`\n\nSorts the output by the specified property\n\n##### sort-order\n\nType: `string`\\\nChoices: `asc`, `desc`\\\nDefault: `asc`\n\nThe sorting direction\n\n##### merge, -m\n\nType: `array`\n\nA simple way to merge names or emails.\nNOTE: Git's .mailmap functionality can be used to perform more complex merging\n\n```sh\ncontrib --merge \"original:new value\" --merge \"second:another value\"\n# or you can simply list the values (space separated)\ncontrib --merge \"original:new value\" \"second:another value\"\n```\n\n##### include-domains\n\nType: `array`\n\nOnly allows emails with the specified domains. Value is used similar to a `string.includes()` so `example` would match `me@example.com`, but it would also match `wrong@myexamplesite.com`. To account for this, the value is passed in to `new RegExp()` which allows you to more precisely match emails. You can pass `example.com$` to match only emails from `me@example.com` and not `wrong@myexamplesite.com`.\n\n##### exclude-domains\n\nType: `array`\n\nOmits emails with the specified domains. This value is processed in the same manner as `--include-domains`.\n\n##### contributors-file-name\n\nType: `string`\\\nDefault: `CONTRIBUTORS.md`\n\nThe file name for the contributors file.\n\n##### contributors-file-message\n\nType: `string`\\\nDefault: `Thank you to all the Contributors that have helped support this project.`\n\nA message that is added to the top of the contributors file.\n\n##### contributors-directory-path\n\nType: `string`\\\nDefault: the value of the `cwd` options above.\n\nThe directory in which the contributors file should be created.\n\n#### verbose, -v\n\nRun with verbose logging, helpful when troubleshooting.\n\n#### dry-run, --dry\n\nSimulate the operation, with verbose logging\n\n#### help\n\nShow help\n\n#### version\n\nShow version number\n\n## License\n\nApache-2.0 © Anchored Labs\n","readmeFilename":"README.md"}