# dont-use-here-link

> The simple library for preventing using of `here` as link in markdown files

Latest version **2.0.0** (published 2021-01-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install dont-use-here-link
pnpm add dont-use-here-link
yarn add dont-use-here-link
bun add dont-use-here-link
```

Provides the command `dont-use-here-link`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2021-01-27 |
| First published | 2019-03-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 10 |
| Dependencies | 2 |
| Unpacked size | 812.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | hashimoto, smhbrowton |
| Keywords | markdown, here, prevent, usage, link |

## Links

- npm: https://www.npmjs.com/package/dont-use-here-link
- Repository: https://github.com/siberianmh/siberianmh
- Homepage: https://github.com/siberianmh/siberianmh#readme
- Issues: https://github.com/siberianmh/siberianmh/issues
- npm.io page: https://npm.io/package/dont-use-here-link

## Dependencies (2)

- [glob](https://npm.io/package/glob.md) ^7.1.6
- [meow](https://npm.io/package/meow.md) ^9.0.0

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2021-01-27
- 1.2.2 — 2020-12-16
- 1.2.1 — 2020-01-29
- 1.2.0 — 2020-01-07
- 1.1.1 — 2019-07-28
- 1.1.0 — 2019-06-23
- 1.0.1 — 2019-06-06
- 1.0.0 — 2019-06-02
- 0.9.3 — 2019-03-23
- 0.9.1 — 2019-03-22
- 0.9.0 — 2019-03-22

## README

# dont-use-here-link

> The simple library for preventing using of `here` as link in markdown files

## Install

```sh
$ npm install --save-dev dont-use-here-link
# or
$ yarn add dont-use-here-link --dev
```

## Usage

You can use these library from a cli or from import statement.

### Import like usage

```ts
import { verifyLinks } from 'dont-use-here-link'
// or
const { verifyLinks } = require('dont-use-here-link')

const hereLinks = async () => await verifyLinks('./blog') // can be folder or file

console.log(hereLinks().catch(() => {}))
// Checking all markdown files to ensure [here] not used for links…
//   Checking file: blog\text.md…
//   Checking file: blog\text2.md…
// [here] links were found.
// In file: blog/text.md
//  - Line 2: 'Follow along with the [Google Chromium blog](http://blog.chromium.org) to learn about features as new versions ship and again, you can check the version of Chromium that Electron uses [here](https://electronjs.org/#electron-versions).'
// Look for the source of these markdown and looks to not use [here] as link'.
```

### CLI like usage

```sh
npx dont-use-here-link <folder or file>
```

Example:

```sh
npx dont-use-here-link ./blog

> Checking all markdown files to ensure [here] not used for links…
>  Checking file: blog\text.md…
>  Checking file: blog\text2.md…
> [here] links were found.
> In file: blog/text.md
>  - Line 2: 'Follow along with the [Google Chromium blog](http://blog.chromium.org) to learn about features as new versions ship and again, you can check the version of Chromium that Electron uses [here](https://electronjs.org/#electron-versions).'
> Look for the source of these markdown and looks to not use [here] as link'.
```

### API

`verifyLinks(globRoot[, options])`

Arguments:

- globRoot String (required)
- options Object (optional)
  - searchWord String - Word what's need to search. Defaults `[here]`

## License

[MIT](https://github.com/siberianmh/siberianmh/blob/master/LICENSE.md)

---
_Source: https://npm.io/package/dont-use-here-link · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._