Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modernizing the library a bit #15

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

alisonaquinas
Copy link

Hello, Konstantin; thank you for getting back to me, I appreciate it. I've got this broken up into two commits, I won't be offended if you pick and choose; I just wanted to share the work I already did.

  • c2c1c97 : This is all that is needed to resolve the vulrablities
  • 132aa3d : These are changes to the circleCI configuration and the documentation to conform to normal conventions on GitHub

Renamed License to .txt

Add Git ignore

Add .npmignore and add a circleci config

Add Contributing Document. update Readme
node_modules
package-lock.json
test-results.xml
test
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This keeps the tests out of the published package, making the published package smaller

@@ -1,12 +1,16 @@
# UTF-7

[![CircleCI](https://circleci.com/gh/kkaefer/utf7.svg?style=svg)](https://circleci.com/gh/kkaefer/utf7)
[![CircleCI](https://circleci.com/gh/kkaefer/utf7.svg?style=svg)](https://circleci.com/gh/kkaefer/utf7) [![npm](https://img.shields.io/npm/dw/utf7)](https://www.npmjs.com/package/utf7)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a badge for your NPM package


Encodes and decodes JavaScript (Unicode/UCS-2) strings to UTF-7 ASCII strings. It supports two modes: UTF-7 as defined in [RFC 2152](http://tools.ietf.org/html/rfc2152) and Modified UTF-7 as defined by the IMAP standard in [RFC 3501, section 5.1.3](http://tools.ietf.org/html/rfc3501#section-5.1.3)

## Usage

**RFC 2152**
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Markdown linters prefer using headers over emphasis here

"scripts": {
"test": "tape test/*.js"
}
"test": "tape test/*.js | tap-xunit > test-results.xml"
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change allows circle CI to parse the uni test results

@Tiuipuv
Copy link

Tiuipuv commented Oct 31, 2024

@alisonaquinas Have you been able to get ahold of Konstantin? even just changing a single character in the package.json (~ to a ^) would be enough to get npm update to allow semver v5.7.2, fixing CVE-2022-25883.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants