https://github.com/itaditya/octokit-plugin-mentions
It allows you to parse the names of users mentioned in a github comment easily
https://github.com/itaditya/octokit-plugin-mentions
Last synced: over 1 year ago
JSON representation
It allows you to parse the names of users mentioned in a github comment easily
- Host: GitHub
- URL: https://github.com/itaditya/octokit-plugin-mentions
- Owner: itaditya
- Created: 2018-03-06T23:32:57.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-07T10:26:30.000Z (over 8 years ago)
- Last Synced: 2025-03-31T09:11:57.290Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/octokit-plugin-mentions
- Size: 7.81 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## octokit-plugin-mentions
> It allows you to parse the names of users mentioned in a github comment easily.
### How To Use
```js
const octokit = require('@octokit/rest')();
const mentionsPlugin = require('octokit-plugin-mentions'); // Import the plugin
octokit.plugin(mentionsPlugin); // Plug-in the plugin
octokit.getMentions({ comment }) // Call the plugin methods
// For a working example try out the demo example in /demo/demo.js
```
### List of available methods
* **octokit.getMentions({ comment })** : It takes a github comment and returns an array containing list of all users mentioned in the comment.
### How to Contribute
* Fork and Clone this repo.
* On your local machine run `npm link` in the root of the cloned project.
* `cd` into demo folder and run `npm link octokit-plugin-mentions`.
* Now make changes in the `index.js` and test it via `demo/demo.js` file.
* When you are ready create a branch and submit a PR.
### Is this Tested ?
Yes, the plugin is tested with [Tape](https://github.com/substack/tape).