@proto-kit/remark-code-import 1.2.0

package/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2020, Kai Hao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,109 @@
+# `remark-code-import`
+
+📝 Populate code blocks from files.
+
+[![npm version](https://badge.fury.io/js/remark-code-import.svg)](https://badge.fury.io/js/remark-code-import)
+
+**Starting from v1.0.0, the plugin is now [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). Node 12+ is needed to use it and it must be `import`ed instead of `require`d.**
+
+## Installation
+
+```sh
+npm install -D @proto-kit/remark-code-import
+```
+
+## Setup
+
+The plugin can be imported via named export, there's no default export.
+
+```js
+import codeImport from 'remark-code-import';
+```
+
+See [**Using plugins**](https://github.com/remarkjs/remark/blob/master/doc/plugins.md#using-plugins) for more instructions in the official documentation.
+
+It can also be used in various of libraries: `remark`: [MDX](https://mdxjs.com/advanced/plugins#using-remark-and-rehype-plugins), [Gatsby `gatsby-plugin-mdx`](https://www.gatsbyjs.org/docs/mdx/plugins/#remark-plugins), [Storybook docs](https://github.com/storybookjs/storybook/tree/master/addons/docs#manual-configuration).
+
+## Usage
+
+Transform:
+
+````md
+```js file=./say-hi.js
+```
+````
+
+into:
+
+````md
+```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`](#options):
+
+````md
+```js file=<rootDir>/file-under-root-directory.js
+```
+````
+
+You may also specify lines or ranges:
+
+````md
+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 `\`:
+
+````md
+```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`](https://github.com/kevin940726/to-gatsby-remark-plugin).
+
+```js
+{
+  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](LICENSE)

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import type { Root } from 'mdast';
+import type { VFile } from 'vfile';
+interface CodeImportOptions {
+    async?: boolean;
+    preserveTrailingNewline?: boolean;
+    removeRedundantIndentations?: boolean;
+    rootDir?: string;
+    allowImportingFromOutside?: boolean;
+}
+declare function codeImport(options?: CodeImportOptions): (tree: Root, file: VFile) => Promise<void[]> | undefined;
+export { codeImport };
+export default codeImport;

package/dist/index.js

@@ -0,0 +1,165 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { EOL } from 'node:os';
+import { visit } from 'unist-util-visit';
+import stripIndent from 'strip-indent';
+function getGroup(input) {
+    var _a;
+    const result = /group (?<group>[\w\-_]*)/.exec(input);
+    return (_a = result === null || result === void 0 ? void 0 : result.groups) === null || _a === void 0 ? void 0 : _a.group;
+}
+function extractElements(input) {
+    return input.split(EOL).map(line => {
+        if (line.includes("group")) {
+            const group = getGroup(line);
+            if (group === undefined) {
+                return {
+                    type: "text",
+                    text: line
+                };
+            }
+            else {
+                return {
+                    type: "group",
+                    group
+                };
+            }
+        }
+        else {
+            return {
+                type: "text",
+                text: line
+            };
+        }
+    });
+}
+function extractGroups(content) {
+    const map = {};
+    content.forEach(((line, index) => {
+        var _a;
+        if (line.includes("group")) {
+            const group = getGroup(line);
+            if (group !== undefined) {
+                ((_a = map[group]) !== null && _a !== void 0 ? _a : (map[group] = [])).push(index);
+            }
+        }
+    }));
+    return map;
+}
+function transformDoc(content, elements) {
+    const groups = extractGroups(content);
+    return elements.flatMap(el => {
+        if (el.type === "text") {
+            return [el.text];
+        }
+        else {
+            const array = groups[el.group];
+            if (array && array.length < 2) {
+                console.error(`Group ${el.group} not found in document`);
+            }
+            const group = content.slice(array.shift() + 1, array.shift());
+            // Not sure if that is necessary
+            groups[el.group] = array;
+            return group;
+        }
+    }).join("\n");
+}
+function extractLines(mode, content, fromLine, hasDash, toLine, oldValue, preserveTrailingNewline = false) {
+    const lines = content.split(EOL);
+    if (mode === "classic") {
+        const start = fromLine || 1;
+        let end;
+        if (!hasDash) {
+            end = start;
+        }
+        else if (toLine) {
+            end = toLine;
+        }
+        else if (lines[lines.length - 1] === '' && !preserveTrailingNewline) {
+            end = lines.length - 1;
+        }
+        else {
+            end = lines.length;
+        }
+        return lines.slice(start - 1, end).join('\n');
+    }
+    else {
+        const elements = extractElements(oldValue);
+        return transformDoc(lines, elements);
+    }
+}
+function codeImport(options = {}) {
+    const rootDir = options.rootDir || process.cwd();
+    if (!path.isAbsolute(rootDir)) {
+        throw new Error(`"rootDir" has to be an absolute path`);
+    }
+    return function transformer(tree, file) {
+        const codes = [];
+        const promises = [];
+        visit(tree, 'code', (node, index, parent) => {
+            codes.push([node, index, parent]);
+        });
+        for (const [node] of codes) {
+            const fileMeta = (node.meta || '')
+                // Allow escaping spaces
+                .split(/(?<!\\) /g)
+                .find((meta) => meta.startsWith('file='));
+            if (!fileMeta) {
+                continue;
+            }
+            if (!file.dirname) {
+                throw new Error('"file" should be an instance of VFile');
+            }
+            const res = /^file=(?<path>.+?)(?:(?:#(?:L(?<from>\d+)(?<dash>-)?)?)(?:L(?<to>\d+))?)?$/.exec(fileMeta);
+            if (!res || !res.groups || !res.groups.path) {
+                throw new Error(`Unable to parse file path ${fileMeta}`);
+            }
+            const filePath = res.groups.path;
+            const fromLine = res.groups.from
+                ? parseInt(res.groups.from, 10)
+                : undefined;
+            const hasDash = !!res.groups.dash || fromLine === undefined;
+            const toLine = res.groups.to ? parseInt(res.groups.to, 10) : undefined;
+            const normalizedFilePath = filePath
+                .replace(/^<rootDir>/, rootDir)
+                .replace(/\\ /g, ' ');
+            const fileAbsPath = path.resolve(file.dirname, normalizedFilePath);
+            const mode = (node.meta || '').includes("inline") ? "inline" : "classic";
+            if (!options.allowImportingFromOutside) {
+                const relativePathFromRootDir = path.relative(rootDir, fileAbsPath);
+                if (!rootDir ||
+                    relativePathFromRootDir.startsWith(`..${path.sep}`) ||
+                    path.isAbsolute(relativePathFromRootDir)) {
+                    throw new Error(`Attempted to import code from "${fileAbsPath}", which is outside from the rootDir "${rootDir}"`);
+                }
+            }
+            if (options.async) {
+                promises.push(new Promise((resolve, reject) => {
+                    fs.readFile(fileAbsPath, 'utf8', (err, fileContent) => {
+                        if (err) {
+                            reject(err);
+                            return;
+                        }
+                        node.value = extractLines(mode, fileContent, fromLine, hasDash, toLine, node.value, options.preserveTrailingNewline);
+                        if (options.removeRedundantIndentations) {
+                            node.value = stripIndent(node.value);
+                        }
+                        resolve();
+                    });
+                }));
+            }
+            else {
+                const fileContent = fs.readFileSync(fileAbsPath, 'utf8');
+                node.value = extractLines(mode, fileContent, fromLine, hasDash, toLine, node.value, options.preserveTrailingNewline);
+                if (options.removeRedundantIndentations) {
+                    node.value = stripIndent(node.value);
+                }
+            }
+        }
+        if (promises.length) {
+            return Promise.all(promises);
+        }
+    };
+}
+export { codeImport };
+export default codeImport;

package/gatsby/index.js

@@ -0,0 +1,4 @@
+const toGatsbyRemarkPlugin = require('to-gatsby-remark-plugin');
+const codeImport = require('../');
+
+module.exports = toGatsbyRemarkPlugin(codeImport);

package/gatsby/package.json

@@ -0,0 +1,3 @@
+{
+  "main": "index.js"
+}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@proto-kit/remark-code-import",
+  "description": "📝 Populate code blocks from files",
+  "version": "1.2.0",
+  "engines": {
+    "node": ">= 12"
+  },
+  "type": "module",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "author": "Protokit & Kai Hao",
+  "license": "MIT",
+  "homepage": "https://github.com/kevin940726/remark-code-import#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kevin940726/remark-code-import.git"
+  },
+  "files": [
+    "dist",
+    "gatsby"
+  ],
+  "keywords": [
+    "remark",
+    "remark-plugin",
+    "markdown",
+    "code-block",
+    "code-fence",
+    "file-system",
+    "import-code",
+    "gatsby",
+    "gatsby-plugin"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest",
+    "prepare": "npm run build && npm test -- run",
+    "publish": "npm publish --access public"
+  },
+  "dependencies": {
+    "strip-indent": "^4.0.0",
+    "to-gatsby-remark-plugin": "^0.1.0",
+    "unist-util-visit": "^4.1.0"
+  },
+  "devDependencies": {
+    "mdast": "^3.0.0",
+    "prettier": "2.5.1",
+    "remark": "^14.0.2",
+    "typescript": "4.4.4",
+    "vfile": "^5.3.0",
+    "vitest": "^0.31.0"
+  },
+  "prettier": {
+    "singleQuote": true,
+    "trailingComma": "es5"
+  },
+  "main": "index.js",
+  "directories": {
+    "test": "test"
+  },
+  "bugs": {
+    "url": "https://github.com/kevin940726/remark-code-import/issues"
+  }
+}