https://github.com/denisecaze/dc-link-catcher-lib
Laboratoria Bootcamp - Sprint 4 (final product) - a library designed to filter links in markdown language using Mocha, Chai and NYC to perform unit tests
https://github.com/denisecaze/dc-link-catcher-lib
chai css3 html5 javascript lodash mocha nyc
Last synced: 2 months ago
JSON representation
Laboratoria Bootcamp - Sprint 4 (final product) - a library designed to filter links in markdown language using Mocha, Chai and NYC to perform unit tests
- Host: GitHub
- URL: https://github.com/denisecaze/dc-link-catcher-lib
- Owner: denisecaze
- Created: 2018-09-01T23:47:23.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-08T12:33:25.000Z (over 6 years ago)
- Last Synced: 2025-01-06T14:29:02.762Z (4 months ago)
- Topics: chai, css3, html5, javascript, lodash, mocha, nyc
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/dc-link-catcher-lib
- Size: 3.66 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Link Catcher
A library designed to filter links in markdown language.
## Motivation
This was the final project of the fourth sprint of Laboratoria bootcamp. The challenge was to create an npm library to capture links in markdown language using Regex. In addition, using Mocha, Chai and NYC to perform unit tests.
## Installation
+ Requires Node.js, NPM and Lodash. If you do not have it, go to:
1. [Node + NPM](https://nodejs.org/en/download/);
2. [Lodash](https://lodash.com/);
+ In the terminal, go to the folder where you want to use the library and then type:
```
$ npm install dc-link-catcher-lib
```
## Use
```
$ node
> const library = require("dc-link-catcher-lib")
> library.getLinksFromMd("this is Google's link: [google](www.google.com)")
> //[ {href: "www.google.com", text: "google"} ]
```
## Technology Stack
+ HTML5
+ CSS3
+ JavaScript
+ NPM
+ Mocha
+ Chai
+ NYC
+ Lodash
## Oficial Roadmap
#### version 2.0.0 (scheduled for November 2018)
+ Implementation of recognition of more complex URLs: with protocol, domain, paths, resource, query_string and fragment.
#### version 1.0.0 (released)
+ Can capture links and titles and save it in an object. These links could have or not have a protocol (http://, https://) or a path (/path).