awesome-readme-lint-double-link

0.0.4 verified Fri May 01 auth: no javascript

A lint tool for awesome README files that detects duplicate links (same URL appearing more than once). Version 0.0.4, stable but minimal release cadence. Differentiates from other markdown link linters by specifically targeting duplicate links in awesome-style lists. Supports Node >=10.

Common errors

error Error: duplicate links found: ↓

cause The markdown contains duplicate URLs and the function throws an error.

fix

Remove duplicate links from your markdown or catch the error.

error Cannot find module 'awesome-readme-lint-double-link' ↓

cause The package is not installed or not in node_modules.

fix

Run 'npm install awesome-readme-lint-double-link' in your project directory.

Warnings

deprecated The package has not been updated since 2019 and has very low usage. ↓

fix Consider using more maintained alternatives like markdown-link-check or awesome-lint.

gotcha Only checks for exact URL duplicates, not case-sensitive or trailing slash variations. ↓

fix Normalize URLs before passing to the function if needed.

gotcha The function throws an error on duplicate links, not just logs a warning. ↓

fix Wrap call in try/catch to handle duplicate detection gracefully.

Install

npm install awesome-readme-lint-double-link

yarn add awesome-readme-lint-double-link

pnpm add awesome-readme-lint-double-link

Imports

awesomeReadmeLintLink

wrong

import awesomeReadmeLintLink from 'awesome-readme-lint-double-link';

correct

const awesomeReadmeLintLink = require('awesome-readme-lint-double-link');

Package is CommonJS only; no default ESM export. Use require().

awesomeReadmeLintLink (default export)

const awesomeReadmeLintLink = require('awesome-readme-lint-double-link').default || require('awesome-readme-lint-double-link');

No named exports. The module exports the function directly via module.exports = ...

TypeScript usage

wrong

import awesomeReadmeLintLink from 'awesome-readme-lint-double-link';

correct

import awesomeReadmeLintLink = require('awesome-readme-lint-double-link');

For TypeScript with esModuleInterop, use import = require. Package does not ship types.

Quickstart

Lint an awesome README string for duplicate links using CommonJS require.

const awesomeReadmeLintLink = require('awesome-readme-lint-double-link');
const options = { /* e.g., verbose: true */ };
const md = `
# awesome you project

## Level 1

### Level 1.1

*Description leve 1.1*

- [text link 1](https://url-link-1) - A description link 1
- [text link 2](https://url-link-2) - A description link 2
- [text link 1](https://url-link-1) - A description link 3
`;

try {
  awesomeReadmeLintLink(md, options);
  console.log('No duplicate links found.');
} catch (err) {
  console.error(err.message);
}