Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/getindiekit/mf2tojf2
Convert MF2 to JF2.
https://github.com/getindiekit/mf2tojf2
jf2 mf2 microformats
Last synced: 3 months ago
JSON representation
Convert MF2 to JF2.
- Host: GitHub
- URL: https://github.com/getindiekit/mf2tojf2
- Owner: getindiekit
- License: mit
- Created: 2020-07-25T23:19:20.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-05T21:47:20.000Z (4 months ago)
- Last Synced: 2024-11-11T20:46:04.926Z (3 months ago)
- Topics: jf2, mf2, microformats
- Language: JavaScript
- Homepage:
- Size: 527 KB
- Stars: 6
- Watchers: 0
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MF2 to JF2
[](https://github.com/getindiekit/mf2tojf2/actions)
Convert [MF2](https://microformats.org/wiki/microformats2-parsing) to [JF2](https://jf2.spec.indieweb.org).
JF2 is a simpler JSON serialization of microformats2 intended to be easier to consume than the standard [microformats JSON representation](https://microformats.org/wiki/microformats2).
## Requirements
- [Node.js](https://nodejs.org) v18.18+
## Usage
### Simple (synchronous)
```js
import { mf2tojf2 } from "mf2tojf2";
const mf2 = {
items: [
{
type: ["h-card"],
properties: {
name: ["Paul Robert Lloyd"],
url: ["https://paulrobertlloyd.com"],
},
},
],
};
const jf2 = mf2tojf2(mf2);
console.log(jf2);
```
Returns:
```js
{
type: "card",
name: "Paul Robert Lloyd",
url: "https://paulrobertlloyd.com"
}
```
### With references (asynchronous)
JF2 can include [a `references` property](https://jf2.spec.indieweb.org/#using-references) to exclude any non-authoritative data from the defined object.
```js
import { mf2tojf2referenced } from "mf2tojf2";
const mf2 = {
items: [
{
type: ["h-entry"],
properties: {
name: ["What my friend ate for lunch yesterday"],
published: ["2019-02-12T10:00:00.000+00:00"],
url: ["https://my-website.example/bookmarks/lunch"],
"bookmark-of": ["https://their-website.example/notes/lunch"],
"mp-syndicate-to": "https://example.social/@username",
},
},
],
};
const jf2WithReferences = await mf2tojf2referenced(mf2);
console.log(jf2WithReferences);
```
Returns:
```js
{
type: "entry",
name: "What my friend ate for lunch yesterday",
published: "2019-02-12T10:00:00.000+00:00",
url: "https://my-website.example/bookmarks/lunch",
"bookmark-of": "https://their-website.example/notes/lunch",
"mp-syndicate-to": "https://example.social/@username",
references: {
"https://their-website.example/notes/lunch": {
type: "entry",
name: "What I ate for lunch",
published: "2019-01-12T15:55:00.000+00:00",
url: "https://their-website.example/notes/lunch",
content: {
text: "I ate a cheese sandwich, which was nice.",
html: "
I ate a cheese sandwich, which was nice.
"
},
category: ["Food", "Lunch", "Sandwiches"]
}
}
}
```
> [!NOTE]\
> Values for `audio`, `photo`, `url`, `video` and any property prefixed with `mp-`, are excluded from referencing.
## Testing
`npm test`
## Releasing a new version
`npm run release`
## Credits
Based on [mf2tojf2.py](https://github.com/microformats/mf2tojf2.py).