[FR] Add a sample node script with the required security considerations

Open
#593 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
javascript, node.js
Domain
cli, security

Research direction

Start by reviewing the linked readability-wrapper and this repository's README, especially its HTML-sanitization security guidance. Define the sample Node CLI's supported usage and security behavior before implementing it; done means a usable wrapper that demonstrates proper usage without omitting sanitization.

Written by the indexing model from the issue text.

Description

maintenance

The best node wrapper I have found is https://github.com/brynedwards/readability-wrapper which doesn’t sanitize html as recommended in the readme. I think it’s a good idea to add a proper node script that acts as a cli wrapper to the repo itself. It will both help illustrate proper usage, and it is itself useful. (A CLI is a pretty universal API useable in any language.)

Dominant language
JavaScript
Stars
11.5k
Forks
732
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mozilla/readability

All issues in mozilla/readability

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.