@tiangong-lca/pcr 0.3.0 → 0.4.0

package/node_modules/unist-util-is/readme.md

@@ -0,0 +1,351 @@
+# unist-util-is
+
+[![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]
+
+[unist][] utility to check if nodes pass a test.
+
+## Contents
+
+* [What is this?](#what-is-this)
+* [When should I use this?](#when-should-i-use-this)
+* [Install](#install)
+* [Use](#use)
+* [API](#api)
+  * [`is(node[, test[, index, parent[, context]]])`](#isnode-test-index-parent-context)
+  * [`convert(test)`](#converttest)
+  * [`Check`](#check)
+  * [`Test`](#test)
+  * [`TestFunction`](#testfunction)
+* [Examples](#examples)
+  * [Example of `convert`](#example-of-convert)
+* [Types](#types)
+* [Compatibility](#compatibility)
+* [Related](#related)
+* [Contribute](#contribute)
+* [License](#license)
+
+## What is this?
+
+This package is a small utility that checks that a node is a certain node.
+
+## When should I use this?
+
+Use this small utility if you find yourself repeating code for checking what
+nodes are.
+
+A similar package, [`hast-util-is-element`][hast-util-is-element], works on hast
+elements.
+
+For more advanced tests, [`unist-util-select`][unist-util-select] can be used
+to match against CSS selectors.
+
+## Install
+
+This package is [ESM only][esm].
+In Node.js (version 16+), install with [npm][]:
+
+```sh
+npm install unist-util-is
+```
+
+In Deno with [`esm.sh`][esmsh]:
+
+```js
+import {is} from 'https://esm.sh/unist-util-is@6'
+```
+
+In browsers with [`esm.sh`][esmsh]:
+
+```html
+<script type="module">
+  import {is} from 'https://esm.sh/unist-util-is@6?bundle'
+</script>
+```
+
+## Use
+
+```js
+import {is} from 'unist-util-is'
+
+const node = {type: 'strong'}
+const parent = {type: 'paragraph', children: [node]}
+
+is() // => false
+is({children: []}) // => false
+is(node) // => true
+is(node, 'strong') // => true
+is(node, 'emphasis') // => false
+
+is(node, node) // => true
+is(parent, {type: 'paragraph'}) // => true
+is(parent, {type: 'strong'}) // => false
+
+is(node, test) // => false
+is(node, test, 4, parent) // => false
+is(node, test, 5, parent) // => true
+
+function test(node, n) {
+  return n === 5
+}
+```
+
+## API
+
+This package exports the identifiers [`convert`][api-convert] and
+[`is`][api-is].
+There is no default export.
+
+### `is(node[, test[, index, parent[, context]]])`
+
+Check if `node` is a `Node` and whether it passes the given test.
+
+###### Parameters
+
+* `node` (`unknown`, optional)
+  — thing to check, typically [`Node`][node]
+* `test` ([`Test`][api-test], optional)
+  — a test for a specific element
+* `index` (`number`, optional)
+  — the node’s position in its parent
+* `parent` ([`Node`][node], optional)
+  — the node’s parent
+* `context` (`unknown`, optional)
+  — context object (`this`) to call `test` with
+
+###### Returns
+
+Whether `node` is a [`Node`][node] and passes a test (`boolean`).
+
+###### Throws
+
+When an incorrect `test`, `index`, or `parent` is given.
+There is no error thrown when `node` is not a node.
+
+### `convert(test)`
+
+Generate a check from a test.
+
+Useful if you’re going to test many nodes, for example when creating a
+utility where something else passes a compatible test.
+
+The created function is a bit faster because it expects valid input only:
+a `node`, `index`, and `parent`.
+
+###### Parameters
+
+* `test` ([`Test`][api-test], optional)
+  — a test for a specific node
+
+###### Returns
+
+A check ([`Check`][api-check]).
+
+### `Check`
+
+Check that an arbitrary value is a node (TypeScript type).
+
+###### Parameters
+
+* `this` (`unknown`, optional)
+  — context object (`this`) to call `test` with
+* `node` (`unknown`)
+  — anything (typically a node)
+* `index` (`number`, optional)
+  — the node’s position in its parent
+* `parent` ([`Node`][node], optional)
+  — the node’s parent
+
+###### Returns
+
+Whether this is a node and passes a test (`boolean`).
+
+### `Test`
+
+Check for an arbitrary node (TypeScript type).
+
+###### Type
+
+```ts
+type Test =
+  | Array<Record<string, unknown> | TestFunction | string>
+  | Record<string, unknown>
+  | TestFunction
+  | string
+  | null
+  | undefined
+```
+
+Checks that the given thing is a node, and then:
+
+* when `string`, checks that the node has that tag name
+* when `function`, see  [`TestFunction`][api-test-function]
+* when `object`, checks that all keys in test are in node, and that they have
+  (strictly) equal values
+* when `Array`, checks if one of the subtests pass
+
+### `TestFunction`
+
+Check if a node passes a test (TypeScript type).
+
+###### Parameters
+
+* `node` ([`Node`][node])
+  — a node
+* `index` (`number` or `undefined`)
+  — the node’s position in its parent
+* `parent` ([`Node`][node] or `undefined`)
+  — the node’s parent
+
+###### Returns
+
+Whether this node passes the test (`boolean`, optional).
+
+## Examples
+
+### Example of `convert`
+
+```js
+import {u} from 'unist-builder'
+import {convert} from 'unist-util-is'
+
+const test = convert('leaf')
+
+const tree = u('tree', [
+  u('node', [u('leaf', '1')]),
+  u('leaf', '2'),
+  u('node', [u('leaf', '3'), u('leaf', '4')]),
+  u('leaf', '5')
+])
+
+const leafs = tree.children.filter(function (child, index) {
+  return test(child, index, tree)
+})
+
+console.log(leafs)
+```
+
+Yields:
+
+```js
+[{type: 'leaf', value: '2'}, {type: 'leaf', value: '5'}]
+```
+
+## Types
+
+This package is fully typed with [TypeScript][].
+It exports the additional types [`Check`][api-check],
+[`Test`][api-test],
+[`TestFunction`][api-test-function].
+
+## 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, `unist-util-is@^6`,
+compatible with Node.js 16.
+
+## Related
+
+* [`unist-util-find-after`](https://github.com/syntax-tree/unist-util-find-after)
+  — find a node after another node
+* [`unist-util-find-before`](https://github.com/syntax-tree/unist-util-find-before)
+  — find a node before another node
+* [`unist-util-find-all-after`](https://github.com/syntax-tree/unist-util-find-all-after)
+  — find all nodes after another node
+* [`unist-util-find-all-before`](https://github.com/syntax-tree/unist-util-find-all-before)
+  — find all nodes before another node
+* [`unist-util-find-all-between`](https://github.com/mrzmmr/unist-util-find-all-between)
+  — find all nodes between two nodes
+* [`unist-util-filter`](https://github.com/syntax-tree/unist-util-filter)
+  — create a new tree with nodes that pass a check
+* [`unist-util-remove`](https://github.com/syntax-tree/unist-util-remove)
+  — remove nodes from tree
+
+## Contribute
+
+See [`contributing.md`][contributing] in [`syntax-tree/.github`][health] for
+ways to get started.
+See [`support.md`][support] for ways to get help.
+
+This project has a [code of conduct][coc].
+By interacting with this repository, organization, or community you agree to
+abide by its terms.
+
+## License
+
+[MIT][license] © [Titus Wormer][author]
+
+<!-- Definitions -->
+
+[api-check]: #check
+
+[api-convert]: #converttest
+
+[api-is]: #isnode-test-index-parent-context
+
+[api-test]: #test
+
+[api-test-function]: #testfunction
+
+[author]: https://wooorm.com
+
+[backers-badge]: https://opencollective.com/unified/backers/badge.svg
+
+[build]: https://github.com/syntax-tree/unist-util-is/actions
+
+[build-badge]: https://github.com/syntax-tree/unist-util-is/workflows/main/badge.svg
+
+[chat]: https://github.com/syntax-tree/unist/discussions
+
+[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
+
+[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md
+
+[collective]: https://opencollective.com/unified
+
+[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md
+
+[coverage]: https://codecov.io/github/syntax-tree/unist-util-is
+
+[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/unist-util-is.svg
+
+[downloads]: https://www.npmjs.com/package/unist-util-is
+
+[downloads-badge]: https://img.shields.io/npm/dm/unist-util-is.svg
+
+[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
+
+[esmsh]: https://esm.sh
+
+[hast-util-is-element]: https://github.com/syntax-tree/hast-util-is-element
+
+[health]: https://github.com/syntax-tree/.github
+
+[license]: license
+
+[node]: https://github.com/syntax-tree/unist#node
+
+[npm]: https://docs.npmjs.com/cli/install
+
+[size]: https://bundlejs.com/?q=unist-util-is
+
+[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=unist-util-is
+
+[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
+
+[support]: https://github.com/syntax-tree/.github/blob/main/support.md
+
+[typescript]: https://www.typescriptlang.org
+
+[unist]: https://github.com/syntax-tree/unist
+
+[unist-util-select]: https://github.com/syntax-tree/unist-util-select

package/node_modules/unist-util-stringify-position/index.d.ts

@@ -0,0 +1 @@
+export {stringifyPosition} from './lib/index.js'

package/node_modules/unist-util-stringify-position/index.js

@@ -0,0 +1 @@
+export {stringifyPosition} from './lib/index.js'

package/node_modules/unist-util-stringify-position/lib/index.d.ts

@@ -0,0 +1,61 @@
+/**
+ * @typedef {import('unist').Node} Node
+ * @typedef {import('unist').Point} Point
+ * @typedef {import('unist').Position} Position
+ */
+/**
+ * @typedef NodeLike
+ * @property {string} type
+ * @property {PositionLike | null | undefined} [position]
+ *
+ * @typedef PointLike
+ * @property {number | null | undefined} [line]
+ * @property {number | null | undefined} [column]
+ * @property {number | null | undefined} [offset]
+ *
+ * @typedef PositionLike
+ * @property {PointLike | null | undefined} [start]
+ * @property {PointLike | null | undefined} [end]
+ */
+/**
+ * Serialize the positional info of a point, position (start and end points),
+ * or node.
+ *
+ * @param {Node | NodeLike | Point | PointLike | Position | PositionLike | null | undefined} [value]
+ *   Node, position, or point.
+ * @returns {string}
+ *   Pretty printed positional info of a node (`string`).
+ *
+ *   In the format of a range `ls:cs-le:ce` (when given `node` or `position`)
+ *   or a point `l:c` (when given `point`), where `l` stands for line, `c` for
+ *   column, `s` for `start`, and `e` for end.
+ *   An empty string (`''`) is returned if the given value is neither `node`,
+ *   `position`, nor `point`.
+ */
+export function stringifyPosition(
+  value?:
+    | Node
+    | NodeLike
+    | Point
+    | PointLike
+    | Position
+    | PositionLike
+    | null
+    | undefined
+): string
+export type Node = import('unist').Node
+export type Point = import('unist').Point
+export type Position = import('unist').Position
+export type NodeLike = {
+  type: string
+  position?: PositionLike | null | undefined
+}
+export type PointLike = {
+  line?: number | null | undefined
+  column?: number | null | undefined
+  offset?: number | null | undefined
+}
+export type PositionLike = {
+  start?: PointLike | null | undefined
+  end?: PointLike | null | undefined
+}

package/node_modules/unist-util-stringify-position/lib/index.js

@@ -0,0 +1,84 @@
+/**
+ * @typedef {import('unist').Node} Node
+ * @typedef {import('unist').Point} Point
+ * @typedef {import('unist').Position} Position
+ */
+
+/**
+ * @typedef NodeLike
+ * @property {string} type
+ * @property {PositionLike | null | undefined} [position]
+ *
+ * @typedef PointLike
+ * @property {number | null | undefined} [line]
+ * @property {number | null | undefined} [column]
+ * @property {number | null | undefined} [offset]
+ *
+ * @typedef PositionLike
+ * @property {PointLike | null | undefined} [start]
+ * @property {PointLike | null | undefined} [end]
+ */
+
+/**
+ * Serialize the positional info of a point, position (start and end points),
+ * or node.
+ *
+ * @param {Node | NodeLike | Point | PointLike | Position | PositionLike | null | undefined} [value]
+ *   Node, position, or point.
+ * @returns {string}
+ *   Pretty printed positional info of a node (`string`).
+ *
+ *   In the format of a range `ls:cs-le:ce` (when given `node` or `position`)
+ *   or a point `l:c` (when given `point`), where `l` stands for line, `c` for
+ *   column, `s` for `start`, and `e` for end.
+ *   An empty string (`''`) is returned if the given value is neither `node`,
+ *   `position`, nor `point`.
+ */
+export function stringifyPosition(value) {
+  // Nothing.
+  if (!value || typeof value !== 'object') {
+    return ''
+  }
+
+  // Node.
+  if ('position' in value || 'type' in value) {
+    return position(value.position)
+  }
+
+  // Position.
+  if ('start' in value || 'end' in value) {
+    return position(value)
+  }
+
+  // Point.
+  if ('line' in value || 'column' in value) {
+    return point(value)
+  }
+
+  // ?
+  return ''
+}
+
+/**
+ * @param {Point | PointLike | null | undefined} point
+ * @returns {string}
+ */
+function point(point) {
+  return index(point && point.line) + ':' + index(point && point.column)
+}
+
+/**
+ * @param {Position | PositionLike | null | undefined} pos
+ * @returns {string}
+ */
+function position(pos) {
+  return point(pos && pos.start) + '-' + point(pos && pos.end)
+}
+
+/**
+ * @param {number | null | undefined} value
+ * @returns {number}
+ */
+function index(value) {
+  return value && typeof value === 'number' ? value : 1
+}

package/node_modules/unist-util-stringify-position/license

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2016 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/unist-util-stringify-position/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "unist-util-stringify-position",
+  "version": "4.0.0",
+  "description": "unist utility to serialize a node, position, or point as a human readable location",
+  "license": "MIT",
+  "keywords": [
+    "unist",
+    "unist-util",
+    "util",
+    "utility",
+    "position",
+    "location",
+    "point",
+    "node",
+    "stringify",
+    "tostring"
+  ],
+  "repository": "syntax-tree/unist-util-stringify-position",
+  "bugs": "https://github.com/syntax-tree/unist-util-stringify-position/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)"
+  ],
+  "sideEffects": false,
+  "type": "module",
+  "exports": "./index.js",
+  "files": [
+    "lib/",
+    "index.d.ts",
+    "index.js"
+  ],
+  "dependencies": {
+    "@types/unist": "^3.0.0"
+  },
+  "devDependencies": {
+    "@types/mdast": "^4.0.0",
+    "@types/node": "^20.0.0",
+    "c8": "^8.0.0",
+    "prettier": "^2.0.0",
+    "remark-cli": "^11.0.0",
+    "remark-preset-wooorm": "^9.0.0",
+    "type-coverage": "^2.0.0",
+    "typescript": "^5.0.0",
+    "xo": "^0.54.0"
+  },
+  "scripts": {
+    "prepack": "npm run build && npm run format",
+    "build": "tsc --build --clean && tsc --build && type-coverage",
+    "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
+    "test-api": "node --conditions development test.js",
+    "test-coverage": "c8 --100 --reporter lcov npm run test-api",
+    "test": "npm run build && npm run format && npm run test-coverage"
+  },
+  "prettier": {
+    "bracketSpacing": false,
+    "semi": false,
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "none",
+    "useTabs": false
+  },
+  "remarkConfig": {
+    "plugins": [
+      "remark-preset-wooorm"
+    ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "ignoreCatch": true,
+    "strict": true
+  },
+  "xo": {
+    "prettier": true
+  }
+}