@tiangong-lca/pcr 0.3.0 → 0.4.0

package/node_modules/remark-parse/lib/index.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Aadd support for parsing from markdown.
+ *
+ * @param {Readonly<Options> | null | undefined} [options]
+ *   Configuration (optional).
+ * @returns {undefined}
+ *   Nothing.
+ */
+export default function remarkParse(options?: Readonly<Options> | null | undefined): undefined;
+export default class remarkParse {
+    /**
+     * Aadd support for parsing from markdown.
+     *
+     * @param {Readonly<Options> | null | undefined} [options]
+     *   Configuration (optional).
+     * @returns {undefined}
+     *   Nothing.
+     */
+    constructor(options?: Readonly<Options> | null | undefined);
+    parser: (document: string, file: import("vfile").VFile) => import("mdast").Root;
+}
+export type Root = import('mdast').Root;
+export type FromMarkdownOptions = import('mdast-util-from-markdown').Options;
+export type Parser = import('unified').Parser<Root>;
+export type Processor = import('unified').Processor<Root>;
+export type Options = Omit<FromMarkdownOptions, 'extensions' | 'mdastExtensions'>;

package/node_modules/remark-parse/lib/index.js

@@ -0,0 +1,43 @@
+/**
+ * @typedef {import('mdast').Root} Root
+ * @typedef {import('mdast-util-from-markdown').Options} FromMarkdownOptions
+ * @typedef {import('unified').Parser<Root>} Parser
+ * @typedef {import('unified').Processor<Root>} Processor
+ */
+
+/**
+ * @typedef {Omit<FromMarkdownOptions, 'extensions' | 'mdastExtensions'>} Options
+ */
+
+import {fromMarkdown} from 'mdast-util-from-markdown'
+
+/**
+ * Aadd support for parsing from markdown.
+ *
+ * @param {Readonly<Options> | null | undefined} [options]
+ *   Configuration (optional).
+ * @returns {undefined}
+ *   Nothing.
+ */
+export default function remarkParse(options) {
+  /** @type {Processor} */
+  // @ts-expect-error: TS in JSDoc generates wrong types if `this` is typed regularly.
+  const self = this
+
+  self.parser = parser
+
+  /**
+   * @type {Parser}
+   */
+  function parser(doc) {
+    return fromMarkdown(doc, {
+      ...self.data('settings'),
+      ...options,
+      // Note: these options are not in the readme.
+      // The goal is for them to be set by plugins on `data` instead of being
+      // passed by users.
+      extensions: self.data('micromarkExtensions') || [],
+      mdastExtensions: self.data('fromMarkdownExtensions') || []
+    })
+  }
+}

package/node_modules/remark-parse/license

@@ -0,0 +1,21 @@
+(The MIT License)
+
+Copyright (c) 2014 Titus Wormer <tituswormer@gmail.com>
+
+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/node_modules/remark-parse/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "remark-parse",
+  "version": "11.0.0",
+  "description": "remark plugin to add support for parsing markdown input",
+  "license": "MIT",
+  "keywords": [
+    "abstract",
+    "ast",
+    "markdown",
+    "mdast",
+    "parse",
+    "plugin",
+    "remark",
+    "remark-plugin",
+    "syntax",
+    "tree",
+    "unified"
+  ],
+  "homepage": "https://remark.js.org",
+  "repository": "https://github.com/remarkjs/remark/tree/main/packages/remark-parse",
+  "bugs": "https://github.com/remarkjs/remark/issues",
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/unified"
+  },
+  "author": "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)",
+  "contributors": [
+    "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)",
+    "Eugene Sharygin <eush77@gmail.com>",
+    "Junyoung Choi <fluke8259@gmail.com>",
+    "Elijah Hamovitz <elijahhamovitz@gmail.com>",
+    "Ika <ikatyang@gmail.com>"
+  ],
+  "sideEffects": false,
+  "type": "module",
+  "exports": "./index.js",
+  "files": [
+    "lib/",
+    "index.d.ts",
+    "index.js"
+  ],
+  "dependencies": {
+    "@types/mdast": "^4.0.0",
+    "mdast-util-from-markdown": "^2.0.0",
+    "micromark-util-types": "^2.0.0",
+    "unified": "^11.0.0"
+  },
+  "scripts": {},
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "ignoreCatch": true,
+    "strict": true
+  },
+  "xo": {
+    "overrides": [
+      {
+        "files": [
+          "**/*.ts"
+        ],
+        "rules": {
+          "@typescript-eslint/ban-types": "off",
+          "@typescript-eslint/consistent-type-definitions": "off"
+        }
+      }
+    ],
+    "prettier": true,
+    "rules": {
+      "unicorn/no-this-assignment": "off"
+    }
+  }
+}

package/node_modules/remark-parse/readme.md

@@ -0,0 +1,428 @@
+# remark-parse
+
+[![Build][build-badge]][build]
+[![Coverage][coverage-badge]][coverage]
+[![Downloads][downloads-badge]][downloads]
+[![Size][size-badge]][size]
+[![Sponsors][sponsors-badge]][collective]
+[![Backers][backers-badge]][collective]
+[![Chat][chat-badge]][chat]
+
+**[remark][]** plugin to add support for parsing from markdown.
+
+## Contents
+
+*   [What is this?](#what-is-this)
+*   [When should I use this?](#when-should-i-use-this)
+*   [Install](#install)
+*   [Use](#use)
+*   [API](#api)
+    *   [`unified().use(remarkParse)`](#unifieduseremarkparse)
+*   [Examples](#examples)
+    *   [Example: support GFM and frontmatter](#example-support-gfm-and-frontmatter)
+    *   [Example: turning markdown into a man page](#example-turning-markdown-into-a-man-page)
+*   [Syntax](#syntax)
+*   [Syntax tree](#syntax-tree)
+*   [Types](#types)
+*   [Compatibility](#compatibility)
+*   [Security](#security)
+*   [Contribute](#contribute)
+*   [Sponsor](#sponsor)
+*   [License](#license)
+
+## What is this?
+
+This package is a [unified][] ([remark][]) plugin that defines how to take
+markdown as input and turn it into a syntax tree.
+
+See [the monorepo readme][remark] for info on what the remark ecosystem is.
+
+## When should I use this?
+
+This plugin adds support to unified for parsing markdown.
+If you also need to serialize markdown, you can alternatively use
+[`remark`][remark-core], which combines unified, this plugin, and
+[`remark-stringify`][remark-stringify].
+
+If you *just* want to turn markdown into HTML (with maybe a few extensions),
+we recommend [`micromark`][micromark] instead.
+If you don’t use plugins and want to access the syntax tree, you can directly
+use [`mdast-util-from-markdown`][mdast-util-from-markdown].
+remark focusses on making it easier to transform content by abstracting these
+internals away.
+
+You can combine this plugin with other plugins to add syntax extensions.
+Notable examples that deeply integrate with it are
+[`remark-gfm`][remark-gfm],
+[`remark-mdx`][remark-mdx],
+[`remark-frontmatter`][remark-frontmatter],
+[`remark-math`][remark-math], and
+[`remark-directive`][remark-directive].
+You can also use any other [remark plugin][remark-plugin] after `remark-parse`.
+
+## Install
+
+This package is [ESM only][esm].
+In Node.js (version 16+), install with [npm][]:
+
+```sh
+npm install remark-parse
+```
+
+In Deno with [`esm.sh`][esmsh]:
+
+```js
+import remarkParse from 'https://esm.sh/remark-parse@11'
+```
+
+In browsers with [`esm.sh`][esmsh]:
+
+```html
+<script type="module">
+  import remarkParse from 'https://esm.sh/remark-parse@11?bundle'
+</script>
+```
+
+## Use
+
+Say we have the following module `example.js`:
+
+```js
+import rehypeStringify from 'rehype-stringify'
+import remarkGfm from 'remark-gfm'
+import remarkParse from 'remark-parse'
+import remarkRehype from 'remark-rehype'
+import {unified} from 'unified'
+
+const doc = `
+# Mercury
+
+**Mercury** is the first planet from the [Sun](https://en.wikipedia.org/wiki/Sun)
+and the smallest planet in the Solar System.
+`
+
+const file = await unified()
+  .use(remarkParse)
+  .use(remarkGfm)
+  .use(remarkRehype)
+  .use(rehypeStringify)
+  .process(doc)
+
+console.log(String(file))
+```
+
+…then running `node example.js` yields:
+
+```html
+<h1>Mercury</h1>
+<p><strong>Mercury</strong> is the first planet from the <a href="https://en.wikipedia.org/wiki/Sun">Sun</a>
+and the smallest planet in the Solar System.</p>
+```
+
+## API
+
+This package exports no identifiers.
+The default export is [`remarkParse`][api-remark-parse].
+
+### `unified().use(remarkParse)`
+
+Add support for parsing from markdown.
+
+###### Parameters
+
+There are no parameters.
+
+###### Returns
+
+Nothing (`undefined`).
+
+## Examples
+
+### Example: support GFM and frontmatter
+
+We support CommonMark by default.
+Non-standard markdown extensions can be enabled with plugins.
+
+This example shows how to support GFM features (autolink literals,
+footnotes, strikethrough, tables, tasklists) and frontmatter (YAML):
+
+```js
+import rehypeStringify from 'rehype-stringify'
+import remarkFrontmatter from 'remark-frontmatter'
+import remarkGfm from 'remark-gfm'
+import remarkParse from 'remark-parse'
+import remarkRehype from 'remark-rehype'
+import {unified} from 'unified'
+
+const doc = `---
+layout: solar-system
+---
+
+# Hi ~~Mars~~Venus!
+`
+
+const file = await unified()
+  .use(remarkParse)
+  .use(remarkFrontmatter)
+  .use(remarkGfm)
+  .use(remarkRehype)
+  .use(rehypeStringify)
+  .process(doc)
+
+console.log(String(file))
+```
+
+Yields:
+
+```html
+<h1>Hi <del>Mars</del>Venus!</h1>
+```
+
+### Example: turning markdown into a man page
+
+Man pages (short for manual pages) are a way to document CLIs (example: type
+`man git-log` in your terminal).
+They use an old markup format called roff.
+There’s a remark plugin, [`remark-man`][remark-man], that can serialize as
+roff.
+
+This example shows how to turn markdown into man pages by using unified with
+`remark-parse` and `remark-man`:
+
+```js
+import remarkMan from 'remark-man'
+import remarkParse from 'remark-parse'
+import {unified} from 'unified'
+
+const doc = `
+# titan(7) -- largest moon of saturn
+
+Titan is the largest moon…
+`
+
+const file = await unified().use(remarkParse).use(remarkMan).process(doc)
+
+console.log(String(file))
+```
+
+Yields:
+
+```roff
+.TH "TITAN" "7" "September 2023" "" ""
+.SH "NAME"
+\fBtitan\fR - largest moon of saturn
+.P
+Titan is the largest moon…
+```
+
+## Syntax
+
+Markdown is parsed according to CommonMark.
+Other plugins can add support for syntax extensions.
+If you’re interested in extending markdown,
+[more information is available in micromark’s readme][micromark-extend].
+
+## Syntax tree
+
+The syntax tree used in remark is [mdast][].
+
+## Types
+
+This package is fully typed with [TypeScript][].
+It exports the additional type `Options` (which is currently empty).
+
+## 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, `remark-parse@^11`,
+compatible with Node.js 16.
+
+## Security
+
+As markdown can be turned into HTML and improper use of HTML can open you up to
+[cross-site scripting (XSS)][xss] attacks, use of remark can be unsafe.
+When going to HTML, you will combine remark with **[rehype][]**, in which case
+you should use [`rehype-sanitize`][rehype-sanitize].
+
+Use of remark plugins could also open you up to other attacks.
+Carefully assess each plugin and the risks involved in using them.
+
+For info on how to submit a report, see our [security policy][security].
+
+## Contribute
+
+See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways
+to get started.
+See [`support.md`][support] for ways to get help.
+Join us in [Discussions][chat] to chat with the community and contributors.
+
+This project has a [code of conduct][coc].
+By interacting with this repository, organization, or community you agree to
+abide by its terms.
+
+## Sponsor
+
+Support this effort and give back by sponsoring on [OpenCollective][collective]!
+
+<table>
+<tr valign="middle">
+<td width="20%" align="center" rowspan="2" colspan="2">
+  <a href="https://vercel.com">Vercel</a><br><br>
+  <a href="https://vercel.com"><img src="https://avatars1.githubusercontent.com/u/14985020?s=256&v=4" width="128"></a>
+</td>
+<td width="20%" align="center" rowspan="2" colspan="2">
+  <a href="https://motif.land">Motif</a><br><br>
+  <a href="https://motif.land"><img src="https://avatars1.githubusercontent.com/u/74457950?s=256&v=4" width="128"></a>
+</td>
+<td width="20%" align="center" rowspan="2" colspan="2">
+  <a href="https://www.hashicorp.com">HashiCorp</a><br><br>
+  <a href="https://www.hashicorp.com"><img src="https://avatars1.githubusercontent.com/u/761456?s=256&v=4" width="128"></a>
+</td>
+<td width="20%" align="center" rowspan="2" colspan="2">
+  <a href="https://www.gitbook.com">GitBook</a><br><br>
+  <a href="https://www.gitbook.com"><img src="https://avatars1.githubusercontent.com/u/7111340?s=256&v=4" width="128"></a>
+</td>
+<td width="20%" align="center" rowspan="2" colspan="2">
+  <a href="https://www.gatsbyjs.org">Gatsby</a><br><br>
+  <a href="https://www.gatsbyjs.org"><img src="https://avatars1.githubusercontent.com/u/12551863?s=256&v=4" width="128"></a>
+</td>
+</tr>
+<tr valign="middle">
+</tr>
+<tr valign="middle">
+<td width="20%" align="center" rowspan="2" colspan="2">
+  <a href="https://www.netlify.com">Netlify</a><br><br>
+  <!--OC has a sharper image-->
+  <a href="https://www.netlify.com"><img src="https://images.opencollective.com/netlify/4087de2/logo/256.png" width="128"></a>
+</td>
+<td width="10%" align="center">
+  <a href="https://www.coinbase.com">Coinbase</a><br><br>
+  <a href="https://www.coinbase.com"><img src="https://avatars1.githubusercontent.com/u/1885080?s=256&v=4" width="64"></a>
+</td>
+<td width="10%" align="center">
+  <a href="https://themeisle.com">ThemeIsle</a><br><br>
+  <a href="https://themeisle.com"><img src="https://avatars1.githubusercontent.com/u/58979018?s=128&v=4" width="64"></a>
+</td>
+<td width="10%" align="center">
+  <a href="https://expo.io">Expo</a><br><br>
+  <a href="https://expo.io"><img src="https://avatars1.githubusercontent.com/u/12504344?s=128&v=4" width="64"></a>
+</td>
+<td width="10%" align="center">
+  <a href="https://boostnote.io">Boost Note</a><br><br>
+  <a href="https://boostnote.io"><img src="https://images.opencollective.com/boosthub/6318083/logo/128.png" width="64"></a>
+</td>
+<td width="10%" align="center">
+  <a href="https://markdown.space">Markdown Space</a><br><br>
+  <a href="https://markdown.space"><img src="https://images.opencollective.com/markdown-space/e1038ed/logo/128.png" width="64"></a>
+</td>
+<td width="10%" align="center">
+  <a href="https://www.holloway.com">Holloway</a><br><br>
+  <a href="https://www.holloway.com"><img src="https://avatars1.githubusercontent.com/u/35904294?s=128&v=4" width="64"></a>
+</td>
+<td width="10%"></td>
+<td width="10%"></td>
+</tr>
+<tr valign="middle">
+<td width="100%" align="center" colspan="8">
+  <br>
+  <a href="https://opencollective.com/unified"><strong>You?</strong></a>
+  <br><br>
+</td>
+</tr>
+</table>
+
+## License
+
+[MIT][license] © [Titus Wormer][author]
+
+<!-- Definitions -->
+
+[build-badge]: https://github.com/remarkjs/remark/workflows/main/badge.svg
+
+[build]: https://github.com/remarkjs/remark/actions
+
+[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark.svg
+
+[coverage]: https://codecov.io/github/remarkjs/remark
+
+[downloads-badge]: https://img.shields.io/npm/dm/remark-parse.svg
+
+[downloads]: https://www.npmjs.com/package/remark-parse
+
+[size-badge]: https://img.shields.io/bundlejs/size/remark-parse
+
+[size]: https://bundlejs.com/?q=remark-parse
+
+[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
+
+[backers-badge]: https://opencollective.com/unified/backers/badge.svg
+
+[collective]: https://opencollective.com/unified
+
+[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
+
+[chat]: https://github.com/remarkjs/remark/discussions
+
+[security]: https://github.com/remarkjs/.github/blob/main/security.md
+
+[health]: https://github.com/remarkjs/.github
+
+[contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md
+
+[support]: https://github.com/remarkjs/.github/blob/main/support.md
+
+[coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md
+
+[license]: https://github.com/remarkjs/remark/blob/main/license
+
+[author]: https://wooorm.com
+
+[npm]: https://docs.npmjs.com/cli/install
+
+[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
+
+[esmsh]: https://esm.sh
+
+[mdast]: https://github.com/syntax-tree/mdast
+
+[mdast-util-from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown
+
+[micromark]: https://github.com/micromark/micromark
+
+[micromark-extend]: https://github.com/micromark/micromark#extensions
+
+[rehype]: https://github.com/rehypejs/rehype
+
+[rehype-sanitize]: https://github.com/rehypejs/rehype-sanitize
+
+[remark]: https://github.com/remarkjs/remark
+
+[remark-core]: ../remark/
+
+[remark-directive]: https://github.com/remarkjs/remark-directive
+
+[remark-frontmatter]: https://github.com/remarkjs/remark-frontmatter
+
+[remark-gfm]: https://github.com/remarkjs/remark-gfm
+
+[remark-mdx]: https://github.com/mdx-js/mdx/tree/main/packages/remark-mdx
+
+[remark-man]: https://github.com/remarkjs/remark-man
+
+[remark-math]: https://github.com/remarkjs/remark-math
+
+[remark-plugin]: https://github.com/remarkjs/remark#plugin
+
+[remark-stringify]: ../remark-stringify/
+
+[typescript]: https://www.typescriptlang.org
+
+[unified]: https://github.com/unifiedjs/unified
+
+[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
+
+[api-remark-parse]: #unifieduseremarkparse

package/node_modules/remark-stringify/index.d.ts

@@ -0,0 +1,41 @@
+import type {Root} from 'mdast'
+import type {Options as ToMarkdownExtension} from 'mdast-util-to-markdown'
+import type {Plugin} from 'unified'
+import type {Options} from './lib/index.js'
+
+export type {Options} from './lib/index.js'
+
+/**
+ * Add support for serializing to markdown.
+ *
+ * @this
+ *   Unified processor.
+ * @param
+ *   Configuration (optional).
+ * @returns
+ *   Nothing.
+ */
+declare const remarkStringify: Plugin<
+  [(Readonly<Options> | null | undefined)?],
+  Root,
+  string
+>
+export default remarkStringify
+
+// Add custom settings supported when `remark-stringify` is added.
+declare module 'unified' {
+  interface Settings extends Options {}
+
+  interface Data {
+    /**
+     * List of `mdast-util-to-markdown` extensions to use.
+     *
+     * This type is registered by `remark-stringify`.
+     * Values can be registered by remark plugins that extend
+     * `mdast-util-to-markdown`.
+     * See {@link ToMarkdownExtension | `Options`} from
+     * {@link https://github.com/syntax-tree/mdast-util-to-markdown#options | `mdast-util-to-markdown`}.
+     */
+    toMarkdownExtensions?: ToMarkdownExtension[]
+  }
+}

package/node_modules/remark-stringify/index.js

@@ -0,0 +1,2 @@
+// Note: types exposed from `index.d.ts`.
+export {default} from './lib/index.js'

package/node_modules/remark-stringify/lib/index.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Add support for serializing to markdown.
+ *
+ * @param {Readonly<Options> | null | undefined} [options]
+ *   Configuration (optional).
+ * @returns {undefined}
+ *   Nothing.
+ */
+export default function remarkStringify(options?: Readonly<Options> | null | undefined): undefined;
+export default class remarkStringify {
+    /**
+     * Add support for serializing to markdown.
+     *
+     * @param {Readonly<Options> | null | undefined} [options]
+     *   Configuration (optional).
+     * @returns {undefined}
+     *   Nothing.
+     */
+    constructor(options?: Readonly<Options> | null | undefined);
+    compiler: (tree: import("mdast").Root, file: import("vfile").VFile) => string;
+}
+export type Root = import('mdast').Root;
+export type ToMarkdownOptions = import('mdast-util-to-markdown').Options;
+export type Compiler = import('unified').Compiler<Root, string>;
+export type Processor = import('unified').Processor<undefined, undefined, undefined, Root, string>;
+export type Options = Omit<ToMarkdownOptions, 'extensions'>;