Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bcomnes/jsonfeed-to-atom
Convert a JSON feed to an atom feed
https://github.com/bcomnes/jsonfeed-to-atom
Last synced: about 2 months ago
JSON representation
Convert a JSON feed to an atom feed
- Host: GitHub
- URL: https://github.com/bcomnes/jsonfeed-to-atom
- Owner: bcomnes
- License: mit
- Created: 2018-04-14T04:00:30.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-09T15:31:25.000Z (4 months ago)
- Last Synced: 2024-07-19T05:22:40.320Z (2 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/jsonfeed-to-atom
- Size: 251 KB
- Stars: 23
- Watchers: 3
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# jsonfeed-to-atom
[![npm version][2]][3] [![build status][4]][5]
[![downloads][8]][9] [![js-standard-style][10]][11]
Convert a JSON feed to an atom feed.
## Installation
```console
$ npm install jsonfeed-to-atom
```
## Usage
```js
const jsonfeedToAtom = require('jsonfeed-to-atom')
const someJSONFeed = require('./load-some-json-feed-data.json')
const atomFeed = jsonfeedToAtom(someJSONFeed) // Returns an atom formatted json feed
```
Example input:
```json
{
"version": "https://jsonfeed.org/version/1",
"title": "bret.io log",
"home_page_url": "https://bret.io",
"feed_url": "https://bret.io/feed.json",
"description": "A running log of announcements, projects and accomplishments.",
"next_url": "https://bret.io/2017.json",
"icon": "https://bret.io/icon-512x512.png",
"author": {
"name": "Bret Comnes",
"url": "https://bret.io",
"avatar": "https://gravatar.com/avatar/8d8b82740cb7ca994449cccd1dfdef5f?size=512"
},
"items": [
{
"date_published": "2018-04-07T20:48:02.000Z",
"content_text": "Wee wooo this is some content. \n Maybe a new paragraph too",
"url": "https://bret.io/my-text-post",
"id": "https://bret.io/my-text-post-2018-04-07T20:48:02.000Z"
},
{
"date_published": "2018-04-07T22:06:43.000Z",
"content_html": "
Hello, world!
",
"title": "This is a blog title",
"url": "https://bret.io/my-blog-post",
"external_url": "https://example.com/some-external-link",
"id": "https://bret.io/my-blog-post-2018-04-07T22:06:43.000Z"
}
]
}
```
Example output:
```xml
bret.io log
https://bret.io/feed.xml
2018-04-07T22:06:43.000Z
Bret Comnes
https://bret.io
jsonfeed-to-atom
© 2018 Bret Comnes
A running log of announcements, projects and accomplishments.
https://bret.io/my-text-post-2018-04-07T20:48:02.000Z
Wee wooo this is some content.
2018-04-07T20:48:02.000Z
2018-04-07T20:48:02.000Z
Wee wooo this is some content.
Maybe a new paragraph too
https://bret.io/my-blog-post-2018-04-07T22:06:43.000Z
This is a blog title
2018-04-07T22:06:43.000Z
2018-04-07T22:06:43.000Z
Hello, world!]]>
```
## API
### `jsonfeedToAtom(parsedJsonfeed, opts)`
Coverts a parsed JSON feed into an atom feed. Returns the string of the atom feed.
Opts include:
```js
{
// a function that returns the atom feed url
feedURLFn: (feedURL, jf) => feedURL.replace(/\.json\b/, '.xml')
}
```
## See also
- [JSON Feed: Mapping RSS and Atom to JSON Feed](https://jsonfeed.org/mappingrssandatom)
- [AtomEnabled: Developers > Syndication](https://mro.github.io/atomenabled.org/) ([Archive](https://web.archive.org/web/20160113103647/http://atomenabled.org/developers/syndication/#link))
- [bcomnes/generate-feed](https://github.com/bcomnes/generate-feed)
- [Rss20AndAtom10Compared](http://www.intertwingly.net/wiki/pie/Rss20AndAtom10Compared)
- [bcomnes/jsonfeed-to-rss](https://github.com/bcomnes/jsonfeed-to-rss): For podcasts or if you prefer RSS
## License
[MIT](https://tldrlegal.com/license/mit-license)
[0]: https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square
[1]: https://nodejs.org/api/documentation.html#documentation_stability_index
[2]: https://img.shields.io/npm/v/jsonfeed-to-atom.svg?style=flat-square
[3]: https://npmjs.org/package/jsonfeed-to-atom
[4]: https://github.com/bcomnes/jsonfeed-to-atom/actions/workflows/test.yml/badge.svg
[5]: https://github.com/bcomnes/jsonfeed-to-atom/actions/workflows/test.yml
[8]: http://img.shields.io/npm/dm/jsonfeed-to-atom.svg?style=flat-square
[9]: https://npmjs.org/package/jsonfeed-to-atom
[10]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
[11]: https://github.com/feross/standard
[12]: https://img.shields.io/coveralls/bcomnes/jsonfeed-to-atom/master.svg?style=flat-square
[13]: https://coveralls.io/github/bcomnes/jsonfeed-to-atom