Merge pull request #62 from extractus/6.1.4

v6.1.4rc1

Author: ndaidong

CONTRIBUTING.md

@@ -1,20 +1,25 @@
-# Contributing to feed-reader
+# Contributing to `@extractus/feed-extractor`
 
-While `feed-reader` is just a simple library with personal purpose, I'm happy if it can be useful for you too.
+Glad to see you here.
 
-Anyway, I hope it always gets better, so pull requests are welcome, though larger proposals should be discussed first.
+Collaborations and pull requests are always welcomed, though larger proposals should be discussed first.
 
-As an OSS, it should follow the Unix philosophy: "do one thing and do it well".
+As an OSS, it's better to 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.
+## What you can contribute?
 
-If it works well, you can start modifying your fork.
+We are planing to re-write this tool in TypeScript and make it Deno-first library.
+If you are interested, please join our team.
 
-In this process, you can use [`node eval.js` command](https://github.com/ndaidong/feed-reader#quick-evaluation) to evaluate your changes.
+Besides that, you can also:
+
+- Test and report bugs
+- Fix unresolved issues
+- Improve performance
+- Write better documentation
+- Create examples or build demos
+- Feedback on software design and APIs
 
 
 ## Third-party libraries
@@ -32,7 +37,7 @@ Make sure your code lints before opening a pull request.
 
 
 ```bash
-cd feed-reader
+cd feed-extractor
 
 # check coding convention issue
 npm run lint
@@ -49,18 +54,18 @@ npm run lint:fix
 Be sure to run the unit test suite before opening a pull request. An example test run is shown below.
 
 ```bash
-cd feed-reader
+cd feed-extractor
 npm test
 ```
 
-![feed-reader unit test](https://i.imgur.com/xTwZK6B.png)
+![feed-extractor 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).
+If you've changed APIs, please update README and [the examples](https://github.com/extractus/feed-extractor/tree/main/examples).
 
 
 ## Clean commit histories
@@ -79,6 +84,6 @@ For people new to git, please refer the following guides:
 
 ## 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).
+By contributing to `@extractus/feed-extractor`, you agree that your contributions will be licensed under its [MIT license](https://github.com/extractus/feed-extractor/blob/main/LICENSE).
 
 ---

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Dong Nguyen
+Copyright (c) 2015 Extractus
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,34 +1,26 @@
-# feed-reader
+# feed-extractor
 
 To read & normalize RSS/ATOM/JSON feed data.
 
-[![NPM](https://badge.fury.io/js/feed-reader.svg)](https://badge.fury.io/js/feed-reader)
-![CI test](https://github.com/ndaidong/feed-reader/workflows/ci-test/badge.svg)
-[![Coverage Status](https://img.shields.io/coveralls/github/ndaidong/feed-reader)](https://coveralls.io/github/ndaidong/feed-reader?branch=main)
-![CodeQL](https://github.com/ndaidong/feed-reader/workflows/CodeQL/badge.svg)
+[![npm version](https://badge.fury.io/js/@extractus%2Ffeed-extractor.svg)](https://badge.fury.io/js/@extractus%2Ffeed-extractor)
+![CI test](https://github.com/extractus/feed-extractor/workflows/ci-test/badge.svg)
+[![Coverage Status](https://img.shields.io/coveralls/github/extractus/feed-extractor)](https://coveralls.io/github/extractus/feed-extractor?branch=main)
+![CodeQL](https://github.com/extractus/feed-extractor/workflows/CodeQL/badge.svg)
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
 ## Intro
 
-*feed-reader* is a part of tool sets for content builder:
+*feed-extractor* 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
+- [feed-extractor](https://github.com/extractus/feed-extractor): extract & normalize RSS/ATOM/JSON feed
+- [article-extractor](https://github.com/extractus/article-extractor): extract main article from given URL
+- [oembed-extractor](https://github.com/extractus/oembed-extractor): 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  ├──────────┘
-                                    └────────────────┘
-```
+### Attention
+
+`feed-reader` has been renamed to `@extractus/feed-extractor` since v6.1.4
 
 ## Demo
 
@@ -40,39 +32,43 @@ You can use one or combination of these tools to build news sites, create automa
 ### Node.js
 
 ```bash
-npm i feed-reader
+npm i @extractus/feed-extractor
 
 # pnpm
-pnpm i feed-reader
+pnpm i @extractus/feed-extractor
 
 # yarn
-yarn add feed-reader
+yarn add @extractus/feed-extractor
 ```
 
 ```ts
 // es6 module
-import { read } from 'feed-reader'
+import { read } from '@extractus/feed-extractor'
 
 // CommonJS
-const { read } = require('feed-reader')
+const { read } = require('@extractus/feed-extractor')
 
 // or specify exactly path to CommonJS variant
-const { read } = require('feed-reader/dist/cjs/feed-reader.js')
+const { read } = require('@extractus/feed-extractor/dist/cjs/feed-extractor.js')
 ```
 
 ### Deno
 
 ```ts
-import { read } from 'https://esm.sh/feed-reader'
+// deno > 1.28
+import { read } from 'npm:@extractus/feed-extractor'
+
+// deno < 1.28
+// import { read } from 'https://esm.sh/@extractus/feed-extractor'
 ```
 
 ### Browser
 
 ```ts
-import { read } from 'https://unpkg.com/feed-reader@latest/dist/feed-reader.esm.js'
+import { read } from 'https://unpkg.com/@extractus/feed-extractor@latest/dist/feed-extractor.esm.js'
 ```
 
-Please check [the examples](https://github.com/ndaidong/feed-reader/tree/main/examples) for reference.
+Please check [the examples](https://github.com/extractus/feed-extractor/tree/main/examples) for reference.
 
 ### Deta cloud
 
@@ -110,9 +106,10 @@ Feed content must be accessible and conform one of the following standards:
 For example:
 
 ```js
-import { read } from 'feed-reader'
+import { read } from '@extractus/feed-extractor'
 
-read('https://news.google.com/atom').then(result => console.log(result))
+const result = await read('https://news.google.com/atom')
+console.log(result)
 ```
 
 Without any options, the result should have the following structure:
@@ -151,13 +148,13 @@ Object with all or several of the following properties:
 For example:
 
 ```ts
-import { read } from 'feed-reader'
+import { read } from '@extractus/feed-extractor'
 
-read('https://news.google.com/atom', {
+await read('https://news.google.com/atom', {
   useISODateFormat: false
 })
 
-read('https://news.google.com/rss', {
+await read('https://news.google.com/rss', {
   useISODateFormat: false,
   getExtraFeedFields: (feedData) => {
     return {
@@ -191,10 +188,10 @@ You can use this param to set request headers to fetch.
 For example:
 
 ```js
-import { read } from 'feed-reader'
+import { read } from '@extractus/feed-extractor'
 
 const url = 'https://news.google.com/rss'
-read(url, null, {
+await read(url, null, {
   headers: {
     'user-agent': 'Opera/9.60 (Windows NT 6.0; U; en) Presto/2.1.1'
   }
@@ -206,11 +203,11 @@ You can also specify a proxy endpoint to load remote content, instead of fetchin
 For example:
 
 ```js
-import { read } from 'feed-reader'
+import { read } from '@extractus/feed-extractor'
 
 const url = 'https://news.google.com/rss'
 
-read(url, null, {
+await read(url, null, {
   headers: {
     'user-agent': 'Opera/9.60 (Windows NT 6.0; U; en) Presto/2.1.1'
   },
@@ -223,14 +220,14 @@ read(url, null, {
 })
 ```
 
-Passing requests to proxy is useful while running `feed-reader` on browser. View `examples/browser-feed-reader` as reference example.
+Passing requests to proxy is useful while running `@extractus/feed-extractor` on browser. View `examples/browser-feed-reader` as reference example.
 
 
 ## Quick evaluation
 
 ```bash
-git clone https://github.com/ndaidong/feed-reader.git
-cd feed-reader
+git clone https://github.com/extractus/feed-extractor.git
+cd feed-extractor
 npm install
 
 node eval.js --url=https://news.google.com/rss --normalization=y --useISODateFormat=y --includeEntryContent=n --includeOptionalElements=n

SECURITY.md

@@ -12,6 +12,6 @@ Description above is a general rule and may be altered on case by case basis.
 
 You can report low severity vulnerabilities as GitHub issues.
 
-More severe vulnerabilities should be reported to my email [email protected] or Twitter [@ndaidong](https://twitter.com/ndaidong).
+More severe vulnerabilities should be reported to email extractus.security@skiff.com.
 
 ---

build.js

@@ -1,7 +1,4 @@
-/**
- * build.js
- * @ndaidong
-**/
+// build.js
 
 import { readFileSync, writeFileSync, copyFileSync, rmSync, mkdirSync } from 'fs'
 
@@ -38,7 +35,7 @@ const esmVersion = {
   ...baseOpt,
   platform: 'browser',
   format: 'esm',
-  outfile: `dist/${pkg.name}.esm.js`,
+  outfile: 'dist/feed-extractor.esm.js',
   banner: {
     js: comment
   }
@@ -50,7 +47,7 @@ const cjsVersion = {
   platform: 'node',
   format: 'cjs',
   mainFields: ['main'],
-  outfile: `dist/cjs/${pkg.name}.js`,
+  outfile: 'dist/cjs/feed-extractor.js',
   banner: {
     js: comment
   }

build.test.js

@@ -9,8 +9,8 @@ import {
 
 const pkg = JSON.parse(readFileSync('./package.json'))
 
-const esmFile = `./dist/${pkg.name}.esm.js`
-const cjsFile = `./dist/cjs/${pkg.name}.js`
+const esmFile = './dist/feed-extractor.esm.js'
+const cjsFile = './dist/cjs/feed-extractor.js'
 const cjsPkg = JSON.parse(readFileSync('./dist/cjs/package.json'))
 const cjsType = './dist/cjs/index.d.ts'