Gathering detailed insights and metrics for unist-util-generated
Gathering detailed insights and metrics for unist-util-generated
utility to check if a node is generated
Installations
npm install unist-util-generatedDeveloper
Developer Guide
BETA
Module System
ESM
Min. Node Version
Typescript Support
Yes
Node Version
20.0.0
NPM Version
9.7.2
Statistics
4 Stars
90 Commits
1 Forks
9 Watching
1 Branches
11 Contributors
Updated on 22 Jan 2023
Bundle Size
368.00 B
Minified
213.00 B
Minified + Gzipped
Languages
JavaScript (100%)
Total Downloads
Cumulative downloads
Total Downloads
904,492,347
Last day
-2.2%
791,850
Compared to previous day
Last week
3.5%
4,161,815
Compared to previous week
Last month
12.3%
17,495,055
Compared to previous month
Last year
-22.4%
222,907,685
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Versions
unist-util-generated
unist utility to check if a node is generated.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Types
- Compatibility
- Related
- Contribute
- License
What is this?
This utility can be used to check if a node is said to be generated.
When should I use this?
You can use this utility to check is generated. Generated nodes were not in the source of the original file, and thus not authored by a human. This info can then be used to not emit lint messages for generated content.
You might also find the utility unist-util-position
useful to get clean positional info.
To display positional info to users, use
unist-util-stringify-position.
Install
This package is ESM only. In Node.js (version 16+), install with npm:
1npm install unist-util-generated
In Deno with esm.sh:
1import {generated} from 'https://esm.sh/unist-util-generated@3'
In browsers with esm.sh:
1<script type="module"> 2 import {generated} from 'https://esm.sh/unist-util-generated@3?bundle' 3</script>
Use
1import {generated} from 'unist-util-generated' 2 3generated({}) // => true 4 5generated({position: {start: {}, end: {}}}) // => true 6 7generated({ 8 position: {start: {line: 1, column: 1}, end: {line: 1, column: 2}} 9}) // => false
API
This package exports the identifier generated.
There is no default export.
generated(node)
Check if node is generated.
Parameters
node(Node) — node to check
Returns
Whether node is generated (does not have positional info) (boolean).
Types
This package is fully typed with TypeScript. It exports no additional types.
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, unist-util-generated@^2,
compatible with Node.js 16.
Related
unist-util-position— get the position of nodesunist-util-source— get the source of a node or positionunist-util-remove-position— removepositionsunist-util-stringify-position— serialize positional info
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 dangerous workflow patterns detected
Reason
no binaries found in the repo
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
Found 1/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/unist-util-generated/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/unist-util-generated/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/unist-util-generated/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/unist-util-generated/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
Project has not signed or included provenance with any releases.
Details
- Warn: release artifact 1.1.6 not signed: https://api.github.com/repos/syntax-tree/unist-util-generated/releases/33361229
- Warn: release artifact 1.1.5 not signed: https://api.github.com/repos/syntax-tree/unist-util-generated/releases/21345632
- Warn: release artifact 1.1.6 does not have provenance: https://api.github.com/repos/syntax-tree/unist-util-generated/releases/33361229
- Warn: release artifact 1.1.5 does not have provenance: https://api.github.com/repos/syntax-tree/unist-util-generated/releases/21345632
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 1 are checked with a SAST tool
Score
3.7
/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