Gathering detailed insights and metrics for mdast-util-definitions
Gathering detailed insights and metrics for mdast-util-definitions
utility to find definition nodes in an mdast tree
Installations
npm install mdast-util-definitionsDeveloper
Developer Guide
BETA
Module System
ESM
Min. Node Version
Typescript Support
Yes
Node Version
20.0.0
NPM Version
9.7.2
Statistics
11 Stars
141 Commits
1 Forks
10 Watching
1 Branches
11 Contributors
Updated on 02 Nov 2024
Bundle Size
782.00 B
Minified
453.00 B
Minified + Gzipped
Languages
JavaScript (100%)
Total Downloads
Cumulative downloads
Total Downloads
1,127,692,770
Last day
-1.4%
1,136,349
Compared to previous day
Last week
3.9%
5,920,680
Compared to previous week
Last month
10.9%
24,836,816
Compared to previous month
Last year
-2.1%
333,908,258
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Versions
mdast-util-definitions
mdast utility to find definitions by identifier.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Types
- Compatibility
- Security
- Related
- Contribute
- License
What is this?
This package is a tiny utility that lets you find definitions.
When should I use this?
This utility can be useful because definitions can occur after the things that reference them. It’s small and protects against prototype pollution.
Install
This package is ESM only. In Node.js (version 16+), install with npm:
1npm install mdast-util-definitions
In Deno with esm.sh:
1import {definitions} from 'https://esm.sh/mdast-util-definitions@6'
In browsers with esm.sh:
1<script type="module"> 2 import {definitions} from 'https://esm.sh/mdast-util-definitions@6?bundle' 3</script>
Use
1import {definitions} from 'mdast-util-definitions' 2import {fromMarkdown} from 'mdast-util-from-markdown' 3 4const tree = fromMarkdown('[example]: https://example.com "Example"') 5 6const definition = definitions(tree) 7 8definition('example') 9// => {type: 'definition', 'title': 'Example', …} 10 11definition('foo') 12// => undefined
API
This package exports the identifier definitions.
There is no default export.
definitions(tree)
Find definitions in tree.
Uses CommonMark precedence, which means that earlier definitions are preferred over duplicate later definitions.
Parameters
tree(Node) — tree to check
Returns
Getter (GetDefinition).
GetDefinition
Get a definition by identifier (TypeScript type).
Parameters
identifier(string, optional) — identifier of definition
Returns
Definition corresponding to identifier (Definition) or
undefined.
Types
This package is fully typed with TypeScript.
It exports the additional type GetDefinition.
Compatibility
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line,
mdast-util-definitions@^6, compatible with Node.js 16.
Security
Use of mdast-util-definitions does not involve hast or user content so
there are no openings for cross-site scripting (XSS) attacks.
Additionally, safe guards are in place to protect against prototype poisoning.
Related
unist-util-index— index property values or computed keys to nodes
Contribute
See contributing.md in syntax-tree/.github for
ways to get started.
See support.md for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
License
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: license:0
- Info: FSF or OSI recognized license: MIT License: license:0
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/syntax-tree/.github/security.md:1
- Info: Found linked content: github.com/syntax-tree/.github/security.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/syntax-tree/.github/security.md:1
- Info: Found text in security policy: github.com/syntax-tree/.github/security.md:1
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/bb.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/syntax-tree/mdast-util-definitions/bb.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/syntax-tree/mdast-util-definitions/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/syntax-tree/mdast-util-definitions/main.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/syntax-tree/mdast-util-definitions/main.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/main.yml:15
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 2 third-party GitHubAction dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/bb.yml:1
- Warn: no topLevel permission defined: .github/workflows/main.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Score
4.1
/10
Last Scanned on 2024-11-18
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