npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

Iโ€™ve always been into building performant and accessible sites, but lately Iโ€™ve been taking it extremely seriously. So much so that Iโ€™ve been building a tool to help me optimize and monitor the sites that I build to make sure that Iโ€™m making an attempt to offer the best experience to those who visit them. If youโ€™re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, ๐Ÿ‘‹, Iโ€™m Ryan Hefnerย  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If youโ€™re interested in other things Iโ€™m working on, follow me on Twitter or check out the open source projects Iโ€™ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soonโ€“ish.

Open Software & Tools

This site wouldnโ€™t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you ๐Ÿ™

ยฉ 2024 โ€“ย Pkg Stats / Ryan Hefner

remark-code-import

v1.2.0

Published

๐Ÿ“ Populate code blocks from files

Downloads

49,100

Readme

remark-code-import

๐Ÿ“ Populate code blocks from files.

npm version

Starting from v1.0.0, the plugin is now ESM only. Node 12+ is needed to use it and it must be imported instead of required.

Installation

npm install -D remark-code-import

Setup

The plugin can be imported via named export, there's no default export.

import codeImport from 'remark-code-import';

See Using plugins for more instructions in the official documentation.

It can also be used in various of libraries: remark: MDX, Gatsby gatsby-plugin-mdx, Storybook docs.

Usage

Transform:

```js file=./say-hi.js
```

into:

```js file=./say-hi.js
console.log('Hello remark-code-import!');
```

The file path is relative to the markdown file path. You can use <rootDir> at the start of the path to import files relatively from the rootDir:

```js file=<rootDir>/file-under-root-directory.js
```

You may also specify lines or ranges:

Only line 3:
```js file=./say-hi.js#L3
```

Line 3 to line 6:
```js file=./say-hi.js#L3-L6
```

Line 3 to the end of the file
```js file=./say-hi.js#L3-
```

File paths with spaces should be escaped with \:

```js file=./file\ with\ spaces.js
```

Options

  • async: boolean: By default, this plugin uses readFileSync to read the contents of the files. Set this to true if you want to use readFile for non-blocking IO.
  • rootDir: string: Change what <rootDir> refers to. Defaults to process.cwd().
  • preserveTrailingNewline: boolean: By default, this plugin will trim the trailing newline of the file when importing the code. You can preserve the trailing new line in the code block by setting this option to true.
  • removeRedundantIndentations: boolean: Set to true to remove redundant indentations for each line. For instance, the imported code of:
      First line
        Second line
    will become...
    First line
      Second line
  • allowImportingFromOutside: boolean: For security reasons, by default this plugin doesn't allow importing files from outside the root directory (rootDir). Set this option to true to bypass this limit.

Use as a Gatsby remark plugin

Use the /gatsby endpoint. It's possible through to-gatsby-remark-plugin.

{
  resolve: 'remark-code-import/gatsby',
  options: {}
}

Testing

After installing dependencies with npm install, the tests can be run with: npm test

License

Kai Hao MIT