Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pascal-giguere/mastofeed
📬 Post new RSS feed items to Mastodon
https://github.com/pascal-giguere/mastofeed
automation bot feed mastodon nodejs rss typescript
Last synced: 2 months ago
JSON representation
📬 Post new RSS feed items to Mastodon
- Host: GitHub
- URL: https://github.com/pascal-giguere/mastofeed
- Owner: pascal-giguere
- License: gpl-3.0
- Created: 2023-02-19T23:57:36.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-23T22:50:14.000Z (11 months ago)
- Last Synced: 2024-04-26T03:45:02.388Z (8 months ago)
- Topics: automation, bot, feed, mastodon, nodejs, rss, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/mastofeed
- Size: 2.98 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mastofeed 📬
A Node.js library to post RSS feed items to Mastodon.
- Syncs new RSS feed items and posts them from a Mastodon bot account.
- Outputs rich, highly-customizable posts. Extract and transform any RSS item attribute.
- Type-safe and entirely built with TypeScript.
[](https://www.gnu.org/licenses/gpl-3.0)
*Automated post from [@[email protected]](https://mastodon.quebec/@lapresse) displayed in [Ivory](https://tapbots.com/ivory/mac/)*
## Prerequisites
Mastofeed requires that you use a Mastodon bot account and generate an access token for it.
To do so, log into your Mastodon instance with your bot account, then go to Preferences > Development and create a new
application with the `read:accounts`, `read:statuses` and `write:statuses` scopes. Take note of the access token
generated for your application.
## Installation
```bash
npm install mastofeed
```
## Usage
Instantiate a `Mastofeed` client, providing your Mastodon and RSS configuration.
Use the `rss.postDef` property to define a mapping of RSS item attributes and customize the contents of your Mastodon
posts.
#### Basic example
```js
import { Mastofeed } from 'mastofeed';
const feed = new Mastofeed({
mastodon: {
instanceUrl: 'https://mastodon.quebec',
accessToken: process.env.MASTODON_ACCESS_TOKEN,
},
rss: {
feedUrl: 'https://www.lapresse.ca/manchettes/rss',
postDef: {
id: { path: 'guid' },
title: { path: 'title' },
linkUrl: { path: 'link' },
},
},
});
```
#### Advanced example
```js
import {
Mastofeed,
UppercaseTransform,
BoldTransform,
MapTransform,
QuotationMarksTransform,
ItalicTransform,
} from 'mastofeed';
const feed = new Mastofeed({
mastodon: {
instanceUrl: 'https://mastodon.quebec',
accessToken: process.env.MASTODON_ACCESS_TOKEN,
},
rss: {
feedUrl: 'https://www.lapresse.ca/manchettes/rss',
postDef: {
id: { path: 'guid' },
kicker: { path: 'title', regex: '^(.+) \\|', transforms: [new UppercaseTransform()] },
title: { path: 'title', regex: '(?!.*\\|) *(.+)?', transforms: [new BoldTransform()] },
category: {
path: 'link',
regex: '^https:\\/\\/www\\.lapresse\\.ca\\/(\\w+)\\/',
transforms: [
new MapTransform({
actualites: 'Actualités',
affaires: 'Affaires',
auto: 'Auto',
arts: 'Arts',
cinema: 'Cinéma',
contexte: 'Contexte',
debats: 'Débats',
gourmand: 'Gourmand',
international: 'International',
maison: 'Maison',
societe: 'Société',
sports: 'Sports',
voyage: 'Voyage',
}),
],
},
description: {
path: 'contentSnippet',
transforms: [new QuotationMarksTransform(), new ItalicTransform()],
},
author: { path: 'dc:creator' },
linkUrl: { path: 'link' },
},
maxSyncedItems: 10,
},
logging: {
level: 'DEBUG',
prefix: 'La Presse',
},
});
```
#### Publishing to Mastodon
Then, to post all new RSS feed items to Mastodon from your bot account:
```js
await feed.sync();
```
#### Full project example
See [Mastodon Québec Bots](https://github.com/pascal-giguere/mastodon-quebec-bots) for a full example of a project using Mastofeed.
## Privacy
Mastofeed does not collect any analytics or telemetry data.
The addition of the `mfid` query parameter in URLs is strictly used to prevent duplicate posts.