https://github.com/hanover-computing/canonicize-url
Get a stable, canonical version of any URL, with DNS and HTTPS checks, redirects, tracker stripping, and canonical link extraction!
https://github.com/hanover-computing/canonicize-url
amp canonical canonical-urls compare-urls javascript normalize-url npm-package privacy sanitize-url ssrf tracker tracking url-normalization
Last synced: 7 months ago
JSON representation
Get a stable, canonical version of any URL, with DNS and HTTPS checks, redirects, tracker stripping, and canonical link extraction!
- Host: GitHub
- URL: https://github.com/hanover-computing/canonicize-url
- Owner: hanover-computing
- License: lgpl-3.0
- Created: 2021-07-08T04:20:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-23T02:41:54.000Z (over 1 year ago)
- Last Synced: 2024-11-06T23:17:12.731Z (over 1 year ago)
- Topics: amp, canonical, canonical-urls, compare-urls, javascript, normalize-url, npm-package, privacy, sanitize-url, ssrf, tracker, tracking, url-normalization
- Language: JavaScript
- Homepage:
- Size: 1.4 MB
- Stars: 12
- Watchers: 3
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Welcome to normalize-url-plus 👋
[](https://circleci.com/gh/JaneJeon/normalize-url-plus/tree/master)
[](https://codecov.io/gh/JaneJeon/normalize-url-plus)
[](https://www.npmjs.com/package/normalize-url-plus)
[](https://www.npmjs.com/package/normalize-url-plus)
> normalize-url plus additional features to supercharge link normalization!
While `normalize-url` is good enough for many normalization use cases, this library is akin to prettier or black in that it ABSOLUTELY normalizes links, including features like default www-stripping and default https (both of which fall back should such links do not exist - unlike `normalize-url`), stripping ALL trackers (courtesy of clearURLs), following redirects (even those that can't normally be automatically redirected without manual user intervention such as youtube redirect links), and even extracting canonical URLs, all the while securing your servers from SSRF!
### 🏠 [Homepage](https://github.com/JaneJeon/normalize-url-plus)
## Install
```sh
npm i normalize-url-plus
```
## Usage
Note that this package is ESM-only; see https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c for what to do if you're using CJS (i.e. `require()`).
```js
import gen from 'normalize-url-plus'
const normalizeUrl = gen(normalizeUrlOptions, gotOptions) // it is recommended to fill out the caching options for got
const longDisgustingTrackerFilledLink =
'https://www.amazon.com/Blanket-Fleece-Cartoon-Printing-Napping/dp/B089G4JDVB/ref=sr_1_1?keywords=hello%20kitty&sr=8-1' // eww
await normalizeUrl(longDisgustingTrackerFilledLink) // https://amazon.com/Blanket-Fleece-Cartoon-Printing-Napping/dp/B089G4JDVB
```
## Run tests
```sh
npm test
```
## Author
👤 **Jane Jeon **
- Website: janejeon.dev
- Github: [@JaneJeon](https://github.com/JaneJeon)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/JaneJeon/normalize-url-plus/issues).
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2022 [Jane Jeon ](https://github.com/JaneJeon).
This project is [LGPL-3.0](https://github.com/JaneJeon/normalize-url-plus/blob/main/LICENSE) licensed.
TL;DR: you are free to import and use this library "as-is" in your code, without needing to make your code source-available or to license it under the same license as this library; however, if you do change this library and you distribute it (directly or as part of your code consuming this library), please do contribute back any improvements for this library and this library alone.