dylang / dylang/node-rss

Consider removing fallback value for `site_url`?

Open
#116 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
1k
Forks
128
PR merge metrics
No merged PRs in 30d

Description

I just spent a while trying to figure out why a gatsby generated rss feed included links to this repo. After much searching, I discovered this fallback code: https://github.com/dylang/node-rss/blob/1.2.2/lib/index.js#L36. This doesn't feel like a very sane default to me. (I don't think there *is* a sane default one could have here.)

The docs in `readme.md` (https://github.com/dylang/node-rss/tree/1.2.2#feedoptions) do not declare this as optional:

```
* `site_url` **url string** Url to the site that the feed is for.
* `image_url` _optional_ **url string** Small image for feed readers to use.
```

Could we instead throw an exception if `site_url` is not specified?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.