npmpackage.info

Gathering detailed insights and metrics for @jboxman/asciidoc-aware-link-check

@jboxman/asciidoc-aware-link-check - 2.0.0 | npmpackage.info

@jboxman/asciidoc-aware-link-check

Verify links in Asciidoc source files.

2.0.0

MIT

JavaScript

25.75 kB

2.6

Installations

npm install @jboxman/asciidoc-aware-link-check

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>= 10

Node Version

14.17.6

NPM Version

6.14.15 Pull Requests

Open

3

Total

11

Closed

7

Merged

1

Issues

Open

4

Total

5

Closed

1

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

jboxman

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

7 Stars

34 Commits

5 Forks

1 Watchers

4 Branches

1 Contributors

Updated on Jun 05, 2024

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

2.0.0

Package Id

@jboxman/asciidoc-aware-link-check@2.0.0

Unpacked Size

25.75 kB

Size

9.38 kB

File Count

NPM Version

6.14.15

Node Version

14.17.6

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

asciidoctor async chalk commander js-yaml link-check progress semver

Dev Dependencies

esm riteway

Why

I need to be able to validate external links that might be derived from attributes.

With this application, you can validate any link directive that references a URL with either an HTTP or HTTPS method.

Installation

To install the application, complete the following steps:

npm i -g @jboxman/asciidoc-aware-link-check

Usage

To learn about supported options, enter the following command:

$ asciidoc-aware-link-check --help
Usage: asciidoc-aware-link-check [options]

Options:
  -a, --attributes [attributes...]  Optional: Attributes such as "product-version=1".
  --csv                             Output to stdout in CSV format. Outputs BROKEN_LINK,MODULE,LINE_NUM. This option
                                    implies --no-progress and --quiet.
  -n, --dry                         Dry run.
  --no-progress                     Hide progress bar.
  -q, --quiet                       Display errors only.
  --stdin                           Read file list from stdin instead of a _topic_map.yml file. (default: false)
  --topic <path>                    Optional: Path to ascii_binder _topic_map.yml file.
  -h, --help                        display help for command

To validate links, enter the following command. Replace <ASSEMBLY_FILE> with the file name that includes any include statements needed to successfully build your documentation.

$ echo <ASSEMBLY_FILE> | asciidoc-aware-link-check --stdin

To validate links for your entire documentation set, you might enter the following the command. Replace <ASSEMBLY_DIR> with the directory where you save your assembly files.

$ find <ASSEMBLY_DIR> -type f -name '*.adoc' | asciidoc-aware-link-check --stdin

Known issues

A HTTP/1.1 301 Moved Permanently is considered a broken link.
Any links within a listing block are ignored.

TODO

Finish tests

Credits

This work is based on the asciidoc-link-check module.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

1

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

2.6

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More