Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/voxpelli/node-webmention-testpinger
A tool to ping your site with a variety of real world WebMentions
https://github.com/voxpelli/node-webmention-testpinger
cli indieweb microformats test-suite webmention
Last synced: 13 days ago
JSON representation
A tool to ping your site with a variety of real world WebMentions
- Host: GitHub
- URL: https://github.com/voxpelli/node-webmention-testpinger
- Owner: voxpelli
- Created: 2014-01-04T16:06:33.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2024-11-15T04:08:29.000Z (2 months ago)
- Last Synced: 2024-12-25T06:09:58.203Z (25 days ago)
- Topics: cli, indieweb, microformats, test-suite, webmention
- Language: HTML
- Size: 99.6 KB
- Stars: 48
- Watchers: 6
- Forks: 5
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-starred - voxpelli/node-webmention-testpinger - A tool to ping your site with a variety of real world WebMentions (cli)
README
# WebMention Test Pinger
[](https://www.npmjs.com/package/webmention-testpinger)
[](https://www.npmjs.com/package/webmention-testpinger)
[](https://github.com/voxpelli/badges-cjs-esm)
[![Follow @[email protected]](https://img.shields.io/mastodon/follow/109247025527949675?domain=https%3A%2F%2Fmastodon.social&style=social)](https://mastodon.social/@voxpelli)
A tool to ping your site with a variety of [WebMentions](http://indiewebcamp.com/webmention) markup. Contains copies of a couple of real world examples of mentions that it enables you to ping locally to a development copy of your site.
## Real world sites included
* [AaronParecki.com](aaronparecki.com/replies/2013/09/08/1/indiewebcampuk-webmention) by [Aaron Parecki](https://github.com/aaronpk)
* [Adactio.com](http://adactio.com/journal/6495/) by [Jeremy Keith](https://github.com/adactio)
* [Brid.gy](http://brid.gy/) by [Ryan Barrett](https://github.com/snarfed) (Example code from [here](https://brid-gy.appspot.com/repost/twitter/pfefferle/423744359297585152/423756080376995840))
* [notizBlog.org](https://notizblog.org/2014/01/16/bridgy-webmentions-fuer-twitter-und-facebook/) by [Matthias Pfefferle](https://github.com/pfefferle)
* [Sandeep.io](http://www.sandeep.io/103) by [Sandeep Shetty](https://github.com/sandeepshetty) (A special [like mention](http://indiewebcamp.com/like))
* [Tantek.com](http://tantek.com/2014/139/t1/going-homebrew-website-club-indieweb) by [Tantek Çelik](https://github.com/tantek) (A special [RSVP mention](http://indiewebcamp.com/rsvp))
* [VoxPelli.com](http://voxpelli.com/2013/12/webmentions-for-static-pages/) by me, [Pelle Wessman](https://github.com/voxpelli/) (With an added <base> tag to resolve the avatar correctly)
* Your site? Send a pull request with a copy of your WebMention page in the templates directory with the mention target set to "http://example.com/webmention/target/placeholder"
## Test suites included
* [checkmention](https://checkmention.appspot.com/) by [KB Sriram](https://github.com/kbsriram), includes [the two xss tests](https://github.com/kbsriram/checkmention/tree/839d52b8138d53ddb2509779e5adf873a5852e9b/src/WEB-INF/checks)
## Usage on CLI
First install from NPM:
npm install -g webmention-testpinger
Then run by doing:
webmention-testpinger --endpoint=http://example.com/endpoint --target=http://example.com/target
This tool will spin up a server on port 8080 and then ping the specified WebMentions hub with a URL to that server or each real world example which will return a copy of that example with a placeholder URL replaced with the requested mention target. After all pinged mentions has been fetched it will shut down the server and finish its execution.
### Options
To list all available options, run:
webmention-testpinger --help
## Usage in Node.js project
First add it from NPM:
npm install webmention-testpinger --save-dev
Then require it and set it up:
```javascript
var WebMentionTemplates = require('webmention-testpinger').WebMentionTemplates;
var templateCollection = new WebMentionTemplates();
templateCollection.getTemplateNames().then(function (templateNames) {
// "templateNames" contains an array of the names of all available templates
});
templateCollection.getTemplate(templateName, templateTarget).then(function (template) {
// "template" contains the rendered HTML for the template with the name "templateName"
// and has its webmention targeted at the "templateTarget" target URL
});
```
### Options
One can send an object into `new WebMentionTemplates()` to define some options. The possible ones are:
* **templatePath** – an absolute path to a folder in which a bunch of templates can be found
## Requirements for CLI
* Node.js (with npm)
* Local copy of the hub you want to ping