dzen-rss

Dzen RSS

A Node.js library for creating, configuring, and managing an RSS feed for Dzen in accordance with the official documentation.

Features

• Generate RSS feeds in XML format.
• Support for custom RSS feed configurations.
• Easy integration with Node.js projects.
• Written in TypeScript for better type safety and developer experience.

An XML builder for node.js.

Installation

To install the library, use npm or yarn:

npm install dzen-rss

or

yarn add dzen-rss

Usage

Here's a basic example of how to use the library to create an RSS feed:

import createRssFeed from 'dzen-rss';

const options = {
  title: 'My RSS Feed',
  link: 'https://example.com',
  language: 'en',
};

const articles = [
  {
    title: 'Article 1',
    link: 'https://example.com/article1',
    guid: '12345',
    pubDate: '2023-10-01', // or new Date('2023-10-01')
    category: ['native-draft', 'noindex', 'comment-all'],
    content_encoded: 'This is the content of article 1.',
  },
];

const rssFeed = createRssFeed(options, articles);

Output

<rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:media="http://search.yahoo.com/mrss/" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:georss="http://www.georss.org/georss">
  <channel>
    <title>My RSS Feed</title>
    <link>https://example.com</link>
    <language>en</language>
    <item>
      <title>Article 1</title>
      <link>https://example.com/article1</link>
      <guid>12345</guid>
      <pubDate>2023-10-01</pubDate>
      <category>native-draft</category>
      <category>noindex</category>
      <category>comment-all</category>
      <content:encoded>This is the content of article 1.</content:encoded>
    </item>
  </channel>
</rss>

Development

Prerequisites

• Node.js (version 16.0.0 or higher)
• npm or yarn
• TypeScript (version 5.6.3 or higher)
• tshy (https://github.com/evanw/tshy)

Scripts

• npm run dev: Run the development server.
• npm run build: Build the project.
• npm run lint:ts: Check TypeScript types.
• npm run eslint: Run ESLint for code quality checks.
• npm run eslint-fix: Fix ESLint issues automatically.
• npm run test: Run tests and linting.
• npm run test:vi: Run tests using Vitest.

Contributing

Contributions are welcome! Please follow the Contributing Guidelines.

License

This project is licensed under the MIT License.