Merge pull request #59 from ndaidong/6.1.3

6.1.3

Author: ndaidong

.github/workflows/ci-test.yml

@@ -8,23 +8,22 @@ on: [push, pull_request]
 jobs:
   test:
 
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
 
     strategy:
       matrix:
-        node_version: [14.x, 15.x, 16.x, 17.x, 18.x]
+        node_version: [14.x, 15.x, 16.x, 17.x, 18.x, 19.x]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: setup Node.js v${{ matrix.node_version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node_version }}
 
     - name: run npm scripts
       run: |
-        npm i -g standard
         npm install
         npm run lint
         npm run build --if-present
@@ -36,7 +35,7 @@ jobs:
         github-token: ${{ secrets.GITHUB_TOKEN }}
 
     - name: cache node modules
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       with:
         path: ~/.npm
         key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

CONTRIBUTING.md

@@ -0,0 +1,84 @@
+# Contributing to feed-reader
+
+While `feed-reader` is just a simple library with personal purpose, I'm happy if it can be useful for you too.
+
+Anyway, I hope it always gets better, so pull requests are welcome, though larger proposals should be discussed first.
+
+As an OSS, it should follow the Unix philosophy: "do one thing and do it well".
+
+## Installation
+
+- Ensure you have `node` and `npm` installed.
+- After cloning the repository, run `npm install` in the root of the repository.
+- Run `npm test` to ensure that everything works correctly in your environment.
+
+If it works well, you can start modifying your fork.
+
+In this process, you can use [`node eval.js` command](https://github.com/ndaidong/feed-reader#quick-evaluation) to evaluate your changes.
+
+
+## Third-party libraries
+
+Please avoid using libaries other than those available in the standard library, unless necessary.
+
+This library needs to be simple and flexible to run on multiple platforms such as Deno, Bun, or even browser.
+
+
+## Coding convention
+
+Please follow [standardjs](https://standardjs.com/) style guide.
+
+Make sure your code lints before opening a pull request.
+
+
+```bash
+cd feed-reader
+
+# check coding convention issue
+npm run lint
+
+# auto fix coding convention issue
+npm run lint:fix
+```
+
+*When you run `npm test`, the linting process will be triggered at first.*
+
+
+## Testing
+
+Be sure to run the unit test suite before opening a pull request. An example test run is shown below.
+
+```bash
+cd feed-reader
+npm test
+```
+
+![feed-reader unit test](https://i.imgur.com/xTwZK6B.png)
+
+If test coverage decreased, please check test scripts and try to improve this number.
+
+
+## Documentation
+
+If you've changed APIs, please update README and [the examples](https://github.com/ndaidong/feed-reader/tree/main/examples).
+
+
+## Clean commit histories
+
+When you open a pull request, please ensure the commit history is clean.
+Squash the commits into logical blocks, perhaps a single commit if that makes sense.
+
+What you want to avoid is commits such as "WIP" and "fix test" in the history.
+This is so we keep history on master clean and straightforward.
+
+For people new to git, please refer the following guides:
+
+- [Writing good commit messages](https://github.com/erlang/otp/wiki/writing-good-commit-messages)
+- [Commit Message Guidelines](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53)
+
+
+## License
+
+By contributing to `feed-reader`, you agree that your contributions will be licensed under its [MIT license](https://github.com/ndaidong/feed-reader/blob/main/LICENSE).
+
+---

README.md

@@ -8,7 +8,27 @@ To read & normalize RSS/ATOM/JSON feed data.
 ![CodeQL](https://github.com/ndaidong/feed-reader/workflows/CodeQL/badge.svg)
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
-[![Deploy](https://button.deta.dev/1/svg)](https://go.deta.dev/deploy?repo=https://github.com/ndaidong/feed-reader-deta)
+## Intro
+
+*feed-reader* is a part of tool sets for content builder:
+
+- [feed-reader](https://github.com/ndaidong/feed-reader): extract & normalize RSS/ATOM/JSON feed
+- [article-parser](https://github.com/ndaidong/article-parser): extract main article from given URL
+- [oembed-parser](https://github.com/ndaidong/oembed-parser): extract oEmbed data from supported providers
+
+You can use one or combination of these tools to build news sites, create automated content systems for marketing campaign or gather dataset for NLP projects...
+
+```
+                                    ┌────────────────┐
+                            ┌───────► article-parser ├──────────┐
+                            │       └────────────────┘          │
+┌─────────────┐   ┌─────────┴────┐                     ┌────────▼─────────┐   ┌─────────────┐
+│ feed-reader ├───► feed entries │                     │ content database ├───► public APIs │
+└─────────────┘   └─────────┬────┘                     └────────▲─────────┘   └─────────────┘
+                            │       ┌────────────────┐          │
+                            └───────► oembed-parser  ├──────────┘
+                                    └────────────────┘
+```
 
 ## Demo
 
@@ -29,7 +49,7 @@ pnpm i feed-reader
 yarn add feed-reader
 ```
 
-```js
+```ts
 // es6 module
 import { read } from 'feed-reader'
 
@@ -48,12 +68,18 @@ import { read } from 'https://esm.sh/feed-reader'
 
 ### Browser
 
-```js
+```ts
 import { read } from 'https://unpkg.com/feed-reader@latest/dist/feed-reader.esm.js'
 ```
 
 Please check [the examples](https://github.com/ndaidong/feed-reader/tree/main/examples) for reference.
 
+### Deta cloud
+
+For [Deta](https://www.deta.sh/) devs please refer [the source code and guideline here](https://github.com/ndaidong/feed-reader-deta) or simply click the button below.
+
+[![Deploy](https://button.deta.dev/1/svg)](https://go.deta.dev/deploy?repo=https://github.com/ndaidong/feed-reader-deta)
+
 
 ## APIs
 
@@ -63,7 +89,7 @@ Load and extract feed data from given RSS/ATOM/JSON source. Return a Promise obj
 
 #### Syntax
 
-```js
+```ts
 read(String url)
 read(String url, Object options)
 read(String url, Object options, Object fetchOptions)
@@ -91,7 +117,7 @@ read('https://news.google.com/atom').then(result => console.log(result))
 
 Without any options, the result should have the following structure:
 
-```js
+```ts
 {
   title: String,
   link: String,
@@ -124,7 +150,7 @@ Object with all or several of the following properties:
 
 For example:
 
-```js
+```ts
 import { read } from 'feed-reader'
 
 read('https://news.google.com/atom', {
@@ -135,7 +161,7 @@ read('https://news.google.com/rss', {
   useISODateFormat: false,
   getExtraFeedFields: (feedData) => {
     return {
-      subtitle: feed.subtitle || ''
+      subtitle: feedData.subtitle || ''
     }
   },
   getExtraEntryFields: (feedEntry) => {

SECURITY.md

@@ -0,0 +1,17 @@
+# Security Policy
+
+## Supported Versions
+
+Due to resource limitations, only the latest stable minor release is getting bugfixes (including security ones).
+
+So e.g. if the latest stable version is 6.1.3, then 6.1.x line will still get security fixes but older versions (like 6.0.x) won't get any fixes.
+
+Description above is a general rule and may be altered on case by case basis.
+
+## Reporting a Vulnerability
+
+You can report low severity vulnerabilities as GitHub issues.
+
+More severe vulnerabilities should be reported to the my email [email protected] or Twitter [@ndaidong](https://twitter.com/ndaidong).
+
+---