
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
@blocz/mdx-plugin-detect-imports
Advanced tools
@blocz/mdx-plugin-detect-imports
MDX plugin to detect the list of every imports done in a MDX file.
Since the v0.2.0, it's based on MDX v2. It you want to use it with MDX v1, you can look at the v0.1.0.
If you’re looking to upgrade to the v0.2.0, the list of breaking changes is listed here.
If your MDX file look like this:
import { Tabs, Button } from "@blocz/elements";
## Hello MDX
1. First item
2. Second item
<Button variant="blue" label="Label" />
This plugin will transform this file into:
import { Button, Tabs as Tabulations } from "@blocz/elements";
## Hello MDX
1. First item
2. Second item
<Button variant="blue" label="Label" />
export const importStatements = [
{
module: "@blocz/elements",
imports: [
{
kind: "named",
imported: "Button",
local: "Button",
value: this_is_the_value_of_the_variable_Button
},
{
kind: "named",
imported: "Tabs",
local: "Tabulations",
value: this_is_the_value_of_the_variable_Tabs
}
]
}
]
yarn add -D @blocz/mdx-plugin-detect-imports
const detectImportsPlugin = require("@blocz/mdx-plugin-detect-imports");
module.exports = {
// ...
module: {
rules: [
// ...
{
test: /.mdx?$/,
loader: "@mdx-js/loader",
options: {
remarkPlugins: [detectImportsPlugin],
// Or if you want to specify a custom name for the exported variable:
remarkPlugins: [
[detectImportsPlugin, { exportName: "otherName" }],
],
},
},
],
},
};
And finally:
import MyAwesomeComponent, { importStatements } from './my-awesome-component.mdx';
(or import MyAwesomeComponent, { otherName } from './my-awesome-component.mdx';
if you specified a custom name.)
import compile from "@mdx-js/mdx";
import detectImportsPlugin from "@blocz/mdx-plugin-detect-imports";
const vFile = await compile(mdxText, {
remarkPlugins: [detectImportsPlugin],
});
// Or if you want to specify a custom name for the exported variable:
const vFile = await compile(mdxText, {
remarkPlugins: [[detectImportsPlugin, { exportName: "otherName" }]],
});
ImportStatement
If you need typings, we provide the following type:
interface ImportStatement {
module: string;
imports: Array<
| {
kind: "named";
imported: string;
local: string;
value: any;
}
| {
kind: "namespace" | "default";
local: string;
value: any;
}
>;
}
And then you can do:
// mdx.d.ts
declare module "*.mdx" {
const MDXComponent: (props: any) => JSX.Element;
// you can replace `importStatements` with your own variable name
export const importStatements: ImportStatement[];
export default MDXComponent;
}
FAQs
Unknown package
The npm package @blocz/mdx-plugin-detect-imports receives a total of 12 weekly downloads. As such, @blocz/mdx-plugin-detect-imports popularity was classified as not popular.
We found that @blocz/mdx-plugin-detect-imports demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.