nlinks

nlinks is an open sourced cli program which is used for finding the stauts of websites. You can use any files such as HTML, txt, srv, etc.

Few types of test files are given in the repository. All can be used seperately or you can use your own file.

Status

Current version - ^1.01

Installation

npm i nlinks

Usage

nlinks [filename or options or link]

Options

Options available (v0.1) >
     * '--v, --version, -v' : Will show the version of the cli
     * '--h, --help, -h' : Will open up list of params you can use
     * '--f, --files, -f' : Will show the types of files the program can format
     * '--ignore' : Will the files provided. See exmaple below.

nlinks [ link ] //Output the result of the link
nlinks [ filename ] --[ options ]       // Pick custom options for better reuslt/understanding of the CLI
nlinks [ filename ] --all               // Output all the links
nlinks [ filename ] --good              // Only output good working links
nlinks [ filename ] --bads              // Only output bad error links

npm run prettier                        // Source Code Formatter
npm run eslint                          // Source Code Linter

// Testing Commands
npm run test
npx jest --coverage

Ignore functionality

nlinks [ filename ] --ignore [ example_ignore_urls.txt]

Note

This CLI App is built in Visual Studion Code and it has .vscode file to help with inital setup

Contributing

As this is an open source project, pull requests are very welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

BSD 3-Clause License