Gathering detailed insights and metrics for @mdx-js/esbuild
Gathering detailed insights and metrics for @mdx-js/esbuild
Installations
npm install @mdx-js/esbuildDeveloper Guide
BETA
Typescript
Yes
Module System
ESM
Node Version
23.0.0
NPM Version
10.9.0
Score
51.8
Supply Chain
87.9
Quality
82.1
Maintenance
100
Vulnerability
99.3
License
Releases
119
Contributors
193
Unable to fetch Contributors
Languages
2
JavaScript
MDX
JavaScript (100%)
Developer
Download Statistics
Total Downloads
5,557,560
Last Day
9,980
Last Week
61,761
Last Month
273,867
Last Year
3,686,695
GitHub Statistics
17,876 Stars
1,743 Commits
1,138 Forks
88 Watching
10 Branches
193 Contributors
Sponsor this package
Maintainers
4
Package Meta Information
Latest Version
3.1.0
Package Id
@mdx-js/esbuild@3.1.0
Unpacked Size
14.22 kB
Size
5.45 kB
File Count
9
NPM Version
10.9.0
Node Version
23.0.0
Publised On
18 Oct 2024
Total Downloads
Cumulative downloads
Total Downloads
5,557,560
Last day
-9.4%
9,980
Compared to previous day
Last week
-2.5%
61,761
Compared to previous week
Last month
-4.5%
273,867
Compared to previous month
Last year
134.7%
3,686,695
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
5
Peer Dependencies
1
Versions
@mdx-js/esbuild
esbuild plugin for MDX.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Types
- Compatibility
- Security
- Contribute
- License
What is this?
This package is an esbuild plugin to support MDX.
When should I use this?
This integration is useful if you’re using esbuild (or another tool that uses esbuild).
If you want to evaluate MDX code then the lower-level compiler (@mdx-js/mdx)
can be used.
to support nonstandard JSX runtime (such as Vue), @mdx-js/mdx can also be
used, or our webpack loader (@mdx-js/loader) or Rollup plugin
(@mdx-js/rollup).
Install
This package is ESM only. In Node.js (version 16+), install with npm:
1npm install @mdx-js/esbuild
Use
Do something like this with the esbuild API:
1import mdx from '@mdx-js/esbuild' 2import esbuild from 'esbuild' 3 4await esbuild.build({ 5 // Replace `index.js` with your entry point that imports MDX files: 6 entryPoints: ['index.js'], 7 format: 'esm', 8 outfile: 'output.js', 9 plugins: [mdx({/* jsxImportSource: …, otherOptions… */})] 10})
API
This package exports no identifiers.
The default export is mdx.
mdx(options?)
Create an esbuild plugin to compile MDX to JS.
esbuild takes care of turning modern JavaScript features into syntax that works wherever you want it to. With other integrations you might need to use Babel for this, but with esbuild that’s not needed. See esbuild’s docs for more info.
Parameters
options(Options, optional) — configuration
Returns
ESBuild plugin (Plugin from esbuild).
Options
Configuration (TypeScript type).
Options are the same as CompileOptions from @mdx-js/mdx.
Types
This package is fully typed with TypeScript.
It exports the additional type Options.
See § Types on our website for information.
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, @mdx-js/esbuild@^3,
compatible with Node.js 16.
Security
See § Security on our website for information.
Contribute
See § Contribute on our website for ways to get started. See § Support 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
16 commit(s) and 16 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
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/mdx-js/.github/security.md:1
- Info: Found linked content: github.com/mdx-js/.github/security.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/mdx-js/.github/security.md:1
- Info: Found text in security policy: github.com/mdx-js/.github/security.md:1
Reason
2 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
Reason
dependency not pinned by hash detected -- score normalized to 4
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/bb.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/bb.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/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/mdx-js/mdx/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/main.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/website.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/website.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/website.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/website.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/website.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/website.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/website.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/website.yml/main?enable=pin
- Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 2 third-party GitHubAction dependencies pinned
- Info: 3 out of 3 npmCommand dependencies pinned
Reason
Found 0/28 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/website.yml:7
- Warn: no topLevel permission defined: .github/workflows/bb.yml:1
- Warn: no topLevel permission defined: .github/workflows/main.yml:1
- Warn: no topLevel permission defined: .github/workflows/website.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'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 2 are checked with a SAST tool
Score
5.1
/10
Last Scanned on 2024-12-16
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