@powerlines/plugin-alloy 0.23.1 → 0.23.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/core/components/output.d.cts +2 -2
- package/dist/core/components/output.d.cts.map +1 -1
- package/dist/core/components/output.d.mts +2 -2
- package/dist/core/components/single-line-comment.d.mts +2 -2
- package/dist/core/contexts/reflection.d.cts.map +1 -1
- package/dist/core/helpers/code.cjs +33 -0
- package/dist/core/helpers/code.d.cts +30 -0
- package/dist/core/helpers/code.d.cts.map +1 -0
- package/dist/core/helpers/code.d.mts +30 -0
- package/dist/core/helpers/code.d.mts.map +1 -0
- package/dist/core/helpers/code.mjs +33 -0
- package/dist/core/helpers/code.mjs.map +1 -0
- package/dist/core/helpers/index.cjs +3 -0
- package/dist/core/helpers/index.d.cts +2 -0
- package/dist/core/helpers/index.d.mts +2 -0
- package/dist/core/helpers/index.mjs +3 -0
- package/dist/core/index.cjs +3 -0
- package/dist/core/index.d.cts +3 -1
- package/dist/core/index.d.mts +3 -1
- package/dist/core/index.mjs +3 -1
- package/dist/markdown/components/front-matter.d.cts +2 -2
- package/dist/markdown/components/front-matter.d.cts.map +1 -1
- package/dist/markdown/components/front-matter.d.mts +2 -2
- package/dist/markdown/components/markdown-file.d.cts +3 -3
- package/dist/markdown/components/markdown-table.d.cts +4 -4
- package/dist/typescript/components/builtin-file.d.cts +2 -2
- package/dist/typescript/components/builtin-file.d.mts +2 -2
- package/dist/typescript/components/dynamic-import-statement.d.cts +2 -2
- package/dist/typescript/components/dynamic-import-statement.d.mts +2 -2
- package/dist/typescript/components/entry-file.d.cts +2 -2
- package/dist/typescript/components/entry-file.d.cts.map +1 -1
- package/dist/typescript/components/entry-file.d.mts +2 -2
- package/dist/typescript/components/interface-declaration.d.cts +2 -2
- package/dist/typescript/components/interface-declaration.d.mts +2 -2
- package/dist/typescript/components/object-declaration.d.cts +3 -3
- package/dist/typescript/components/object-declaration.d.mts +3 -3
- package/dist/typescript/components/property-name.d.cts +2 -2
- package/dist/typescript/components/property-name.d.mts +2 -2
- package/dist/typescript/components/tsdoc-reflection.d.mts +4 -4
- package/dist/typescript/components/tsdoc.cjs +1 -1
- package/dist/typescript/components/tsdoc.mjs +1 -1
- package/dist/typescript/components/tsdoc.mjs.map +1 -1
- package/dist/typescript/components/type-declaration.d.cts +2 -2
- package/dist/typescript/components/type-declaration.d.cts.map +1 -1
- package/dist/typescript/components/type-declaration.d.mts +2 -2
- package/dist/typescript/contexts/lexical-scope.d.mts +2 -2
- package/package.json +34 -6
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { MetaItem } from "../contexts/meta.cjs";
|
|
2
2
|
import "../contexts/index.cjs";
|
|
3
|
-
import * as
|
|
3
|
+
import * as _alloy_js_core20 from "@alloy-js/core";
|
|
4
4
|
import { OutputProps as OutputProps$1 } from "@alloy-js/core";
|
|
5
5
|
import { PluginContext } from "powerlines/types/context";
|
|
6
6
|
|
|
@@ -18,7 +18,7 @@ interface OutputProps<TContext extends PluginContext = PluginContext> extends Om
|
|
|
18
18
|
/**
|
|
19
19
|
* Output component for rendering the Powerlines plugin's output files via templates.
|
|
20
20
|
*/
|
|
21
|
-
declare function Output<TContext extends PluginContext = PluginContext>(props: OutputProps<TContext>):
|
|
21
|
+
declare function Output<TContext extends PluginContext = PluginContext>(props: OutputProps<TContext>): _alloy_js_core20.Children;
|
|
22
22
|
declare type __ΩOutputProps = any[];
|
|
23
23
|
//#endregion
|
|
24
24
|
export { Output, OutputProps, __ΩOutputProps };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"output.d.cts","names":[],"sources":["../../../src/core/components/output.tsx"],"sourcesContent":[],"mappings":";;;;;;;UAwBiB,6BACE,gBAAgB,uBACzB,KAAK;;;;EAFE,OAAA,EAMN,QANiB;EACT;;;EAKR,IAAA,CAAA,EAKF,MALE,CAAA,MAAA,EAKa,QALb,CAAA;;;;;AAWK,iBAAA,MAAM,CAAA,iBAAkB,aAAlB,GAAkC,aAAlC,CAAA,CAAA,KAAA,EACb,WADa,CACD,QADC,CAAA,CAAA,EACF,
|
|
1
|
+
{"version":3,"file":"output.d.cts","names":[],"sources":["../../../src/core/components/output.tsx"],"sourcesContent":[],"mappings":";;;;;;;UAwBiB,6BACE,gBAAgB,uBACzB,KAAK;;;;EAFE,OAAA,EAMN,QANiB;EACT;;;EAKR,IAAA,CAAA,EAKF,MALE,CAAA,MAAA,EAKa,QALb,CAAA;;;;;AAWK,iBAAA,MAAM,CAAA,iBAAkB,aAAlB,GAAkC,aAAlC,CAAA,CAAA,KAAA,EACb,WADa,CACD,QADC,CAAA,CAAA,EACF,gBAAA,CAAU,QADR;AAAkB,8BAAA,GAAA,EAAA"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { MetaItem } from "../contexts/meta.mjs";
|
|
2
2
|
import "../contexts/index.mjs";
|
|
3
|
-
import * as
|
|
3
|
+
import * as _alloy_js_core2 from "@alloy-js/core";
|
|
4
4
|
import { OutputProps as OutputProps$1 } from "@alloy-js/core";
|
|
5
5
|
import { PluginContext } from "powerlines/types/context";
|
|
6
6
|
|
|
@@ -18,7 +18,7 @@ interface OutputProps<TContext extends PluginContext = PluginContext> extends Om
|
|
|
18
18
|
/**
|
|
19
19
|
* Output component for rendering the Powerlines plugin's output files via templates.
|
|
20
20
|
*/
|
|
21
|
-
declare function Output<TContext extends PluginContext = PluginContext>(props: OutputProps<TContext>):
|
|
21
|
+
declare function Output<TContext extends PluginContext = PluginContext>(props: OutputProps<TContext>): _alloy_js_core2.Children;
|
|
22
22
|
declare type __ΩOutputProps = any[];
|
|
23
23
|
//#endregion
|
|
24
24
|
export { Output, OutputProps, __ΩOutputProps };
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ComponentProps } from "../../types/components.mjs";
|
|
2
|
-
import * as
|
|
2
|
+
import * as _alloy_js_core1 from "@alloy-js/core";
|
|
3
3
|
|
|
4
4
|
//#region src/core/components/single-line-comment.d.ts
|
|
5
5
|
type SingleLineCommentVariant = "double-slash" | "triple-slash" | "slash-star" | "slash-star-star" | "markdown";
|
|
@@ -15,7 +15,7 @@ interface SingleLineCommentProps extends ComponentProps {
|
|
|
15
15
|
* A single line comment block. The children are rendered as a prose element, which means that they
|
|
16
16
|
* are broken into multiple lines
|
|
17
17
|
*/
|
|
18
|
-
declare function SingleLineComment(props: SingleLineCommentProps):
|
|
18
|
+
declare function SingleLineComment(props: SingleLineCommentProps): _alloy_js_core1.Children;
|
|
19
19
|
declare type __ΩSingleLineCommentVariant = any[];
|
|
20
20
|
declare type __ΩSingleLineCommentProps = any[];
|
|
21
21
|
//#endregion
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"reflection.d.cts","names":[],"sources":["../../../src/core/contexts/reflection.ts"],"sourcesContent":[],"mappings":";;;;;UA4BiB,0CACL,sBAAsB;cAEpB,gBAAgB;EAHb,QAAA,CAAA,EAIJ,2BAJmC,CAIP,CAJO,CAAA;;;;;AAIP,cAM5B,sBAN4B,EAMJ,gBANI,CAOvC,+BAPuC,CAAA,GAAA,CAAA,CAAA;;;AAMzC;AASA;;AACkC,iBADlB,kBACkB,CAAA,UAAtB,MAAsB,CAAA,MAAA,EAAA,GAAA,CAAA,GAAA,MAAA,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,CAAA,EAAmB,+BAAnB,CAAmB,CAAnB,CAAA;;;;AAkBrB,cAAA,yBAA4C,EAAjB,
|
|
1
|
+
{"version":3,"file":"reflection.d.cts","names":[],"sources":["../../../src/core/contexts/reflection.ts"],"sourcesContent":[],"mappings":";;;;;UA4BiB,0CACL,sBAAsB;cAEpB,gBAAgB;EAHb,QAAA,CAAA,EAIJ,2BAJmC,CAIP,CAJO,CAAA;;;;;AAIP,cAM5B,sBAN4B,EAMJ,gBANI,CAOvC,+BAPuC,CAAA,GAAA,CAAA,CAAA;;;AAMzC;AASA;;AACkC,iBADlB,kBACkB,CAAA,UAAtB,MAAsB,CAAA,MAAA,EAAA,GAAA,CAAA,GAAA,MAAA,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,CAAA,EAAmB,+BAAnB,CAAmB,CAAnB,CAAA;;;;AAkBrB,cAAA,yBAA4C,EAAjB,gBAAiB,CAAA,kBAAD,CAAA;AAQxD;AAeA;AAQA;AAeA;AAQA;iBA9CgB,qBAAA,CAAA,GAAqB;;;;cAexB,yBAAyB,iBAAiB;;;;;;iBAQvC,mBAAA,CAAA,GAAmB;;;;cAetB,4BAA4B,iBAAiB;;;;;;iBAQ1C,sBAAA,CAAA,GAAsB"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
|
|
2
|
+
let __alloy_js_core = require("@alloy-js/core");
|
|
3
|
+
|
|
4
|
+
//#region src/core/helpers/code.ts
|
|
5
|
+
/**
|
|
6
|
+
* Turn the provided string template into Children by replacing literal line
|
|
7
|
+
* breaks with hardlines and automatically indenting indented content. Similar
|
|
8
|
+
* in spirit to the `<code>` element in HTML.
|
|
9
|
+
*
|
|
10
|
+
* @see {@link text} for a similar function which treats whitespace similar to
|
|
11
|
+
* JSX template bodies.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* code`
|
|
16
|
+
* function greet(name: string) {
|
|
17
|
+
* console.log("Hello, " + name + "!");
|
|
18
|
+
* }
|
|
19
|
+
* `
|
|
20
|
+
* ```
|
|
21
|
+
*
|
|
22
|
+
* @param template - The template string to be processed into Children.
|
|
23
|
+
* @param substitutions - Any interpolated values within the template, which will be treated as Children and properly indented.
|
|
24
|
+
* @returns A Children representation of the provided template string, with proper handling of line breaks and indentation.
|
|
25
|
+
* @throws Will throw an error if the provided template contains only whitespace, as this is likely a mistake and would cause a less recognizable "Cannot read properties of undefined" exception later in the processing.
|
|
26
|
+
*/
|
|
27
|
+
function code(template, ...substitutions) {
|
|
28
|
+
if (template.filter((seg) => seg.trim()).length === 0 && substitutions.length === 0) throw new Error("The `code` function cannot be used with a template that contains only whitespace. Please provide a non-empty template.");
|
|
29
|
+
return (0, __alloy_js_core.code)(template, ...substitutions);
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
//#endregion
|
|
33
|
+
exports.code = code;
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { Children } from "@alloy-js/core";
|
|
2
|
+
|
|
3
|
+
//#region src/core/helpers/code.d.ts
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Turn the provided string template into Children by replacing literal line
|
|
7
|
+
* breaks with hardlines and automatically indenting indented content. Similar
|
|
8
|
+
* in spirit to the `<code>` element in HTML.
|
|
9
|
+
*
|
|
10
|
+
* @see {@link text} for a similar function which treats whitespace similar to
|
|
11
|
+
* JSX template bodies.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* code`
|
|
16
|
+
* function greet(name: string) {
|
|
17
|
+
* console.log("Hello, " + name + "!");
|
|
18
|
+
* }
|
|
19
|
+
* `
|
|
20
|
+
* ```
|
|
21
|
+
*
|
|
22
|
+
* @param template - The template string to be processed into Children.
|
|
23
|
+
* @param substitutions - Any interpolated values within the template, which will be treated as Children and properly indented.
|
|
24
|
+
* @returns A Children representation of the provided template string, with proper handling of line breaks and indentation.
|
|
25
|
+
* @throws Will throw an error if the provided template contains only whitespace, as this is likely a mistake and would cause a less recognizable "Cannot read properties of undefined" exception later in the processing.
|
|
26
|
+
*/
|
|
27
|
+
declare function code(template: TemplateStringsArray, ...substitutions: Children[]): Children;
|
|
28
|
+
//#endregion
|
|
29
|
+
export { code };
|
|
30
|
+
//# sourceMappingURL=code.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"code.d.cts","names":[],"sources":["../../../src/core/helpers/code.ts"],"sourcesContent":[],"mappings":";;;;;;AA0CA;;;;;;;;;;;;;;;;;;;;iBAAgB,IAAA,WACJ,wCACQ,aACjB"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { Children } from "@alloy-js/core";
|
|
2
|
+
|
|
3
|
+
//#region src/core/helpers/code.d.ts
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Turn the provided string template into Children by replacing literal line
|
|
7
|
+
* breaks with hardlines and automatically indenting indented content. Similar
|
|
8
|
+
* in spirit to the `<code>` element in HTML.
|
|
9
|
+
*
|
|
10
|
+
* @see {@link text} for a similar function which treats whitespace similar to
|
|
11
|
+
* JSX template bodies.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* code`
|
|
16
|
+
* function greet(name: string) {
|
|
17
|
+
* console.log("Hello, " + name + "!");
|
|
18
|
+
* }
|
|
19
|
+
* `
|
|
20
|
+
* ```
|
|
21
|
+
*
|
|
22
|
+
* @param template - The template string to be processed into Children.
|
|
23
|
+
* @param substitutions - Any interpolated values within the template, which will be treated as Children and properly indented.
|
|
24
|
+
* @returns A Children representation of the provided template string, with proper handling of line breaks and indentation.
|
|
25
|
+
* @throws Will throw an error if the provided template contains only whitespace, as this is likely a mistake and would cause a less recognizable "Cannot read properties of undefined" exception later in the processing.
|
|
26
|
+
*/
|
|
27
|
+
declare function code(template: TemplateStringsArray, ...substitutions: Children[]): Children;
|
|
28
|
+
//#endregion
|
|
29
|
+
export { code };
|
|
30
|
+
//# sourceMappingURL=code.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"code.d.mts","names":[],"sources":["../../../src/core/helpers/code.ts"],"sourcesContent":[],"mappings":";;;;;;AA0CA;;;;;;;;;;;;;;;;;;;;iBAAgB,IAAA,WACJ,wCACQ,aACjB"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { code as code$1 } from "@alloy-js/core";
|
|
2
|
+
|
|
3
|
+
//#region src/core/helpers/code.ts
|
|
4
|
+
/**
|
|
5
|
+
* Turn the provided string template into Children by replacing literal line
|
|
6
|
+
* breaks with hardlines and automatically indenting indented content. Similar
|
|
7
|
+
* in spirit to the `<code>` element in HTML.
|
|
8
|
+
*
|
|
9
|
+
* @see {@link text} for a similar function which treats whitespace similar to
|
|
10
|
+
* JSX template bodies.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* code`
|
|
15
|
+
* function greet(name: string) {
|
|
16
|
+
* console.log("Hello, " + name + "!");
|
|
17
|
+
* }
|
|
18
|
+
* `
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @param template - The template string to be processed into Children.
|
|
22
|
+
* @param substitutions - Any interpolated values within the template, which will be treated as Children and properly indented.
|
|
23
|
+
* @returns A Children representation of the provided template string, with proper handling of line breaks and indentation.
|
|
24
|
+
* @throws Will throw an error if the provided template contains only whitespace, as this is likely a mistake and would cause a less recognizable "Cannot read properties of undefined" exception later in the processing.
|
|
25
|
+
*/
|
|
26
|
+
function code(template, ...substitutions) {
|
|
27
|
+
if (template.filter((seg) => seg.trim()).length === 0 && substitutions.length === 0) throw new Error("The `code` function cannot be used with a template that contains only whitespace. Please provide a non-empty template.");
|
|
28
|
+
return code$1(template, ...substitutions);
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
//#endregion
|
|
32
|
+
export { code };
|
|
33
|
+
//# sourceMappingURL=code.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"code.mjs","names":["code","baseCode","template","substitutions","filter","seg","trim","length","Error"],"sources":["../../../src/core/helpers/code.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/powerlines\n Documentation: https://docs.stormsoftware.com/projects/powerlines\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { code as baseCode, Children } from \"@alloy-js/core\";\n\n/**\n * Turn the provided string template into Children by replacing literal line\n * breaks with hardlines and automatically indenting indented content. Similar\n * in spirit to the `<code>` element in HTML.\n *\n * @see {@link text} for a similar function which treats whitespace similar to\n * JSX template bodies.\n *\n * @example\n * ```ts\n * code`\n * function greet(name: string) {\n * console.log(\"Hello, \" + name + \"!\");\n * }\n * `\n * ```\n *\n * @param template - The template string to be processed into Children.\n * @param substitutions - Any interpolated values within the template, which will be treated as Children and properly indented.\n * @returns A Children representation of the provided template string, with proper handling of line breaks and indentation.\n * @throws Will throw an error if the provided template contains only whitespace, as this is likely a mistake and would cause a less recognizable \"Cannot read properties of undefined\" exception later in the processing.\n */\nexport function code(\n template: TemplateStringsArray,\n ...substitutions: Children[]\n): Children {\n if (\n template.filter(seg => seg.trim()).length === 0 &&\n substitutions.length === 0\n ) {\n throw new Error(\n \"The `code` function cannot be used with a template that contains only whitespace. Please provide a non-empty template.\"\n );\n }\n\n return baseCode(template, ...substitutions);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AA0CA,SAAgBA"}
|
package/dist/core/index.cjs
CHANGED
|
@@ -7,6 +7,8 @@ const require_core_components_single_line_comment = require('./components/single
|
|
|
7
7
|
const require_core_components_source_file = require('./components/source-file.cjs');
|
|
8
8
|
const require_core_components_spacing = require('./components/spacing.cjs');
|
|
9
9
|
require('./components/index.cjs');
|
|
10
|
+
const require_core_helpers_code = require('./helpers/code.cjs');
|
|
11
|
+
require('./helpers/index.cjs');
|
|
10
12
|
|
|
11
13
|
exports.MetaContext = require_core_contexts_meta.MetaContext;
|
|
12
14
|
exports.Output = require_core_components_output.Output;
|
|
@@ -18,6 +20,7 @@ exports.ReflectionPropertyContext = require_core_contexts_reflection.ReflectionP
|
|
|
18
20
|
exports.SingleLineComment = require_core_components_single_line_comment.SingleLineComment;
|
|
19
21
|
exports.SourceFile = require_core_components_source_file.SourceFile;
|
|
20
22
|
exports.Spacing = require_core_components_spacing.Spacing;
|
|
23
|
+
exports.code = require_core_helpers_code.code;
|
|
21
24
|
exports.useMeta = require_core_contexts_meta.useMeta;
|
|
22
25
|
exports.useMetaContext = require_core_contexts_meta.useMetaContext;
|
|
23
26
|
exports.useMetaSafe = require_core_contexts_meta.useMetaSafe;
|
package/dist/core/index.d.cts
CHANGED
|
@@ -7,4 +7,6 @@ import { SingleLineComment, SingleLineCommentProps, SingleLineCommentVariant, __
|
|
|
7
7
|
import { SourceFile, SourceFileProps, __ΩSourceFileProps } from "./components/source-file.cjs";
|
|
8
8
|
import { Spacing, SpacingProps, __ΩSpacingProps } from "./components/spacing.cjs";
|
|
9
9
|
import "./components/index.cjs";
|
|
10
|
-
|
|
10
|
+
import { code } from "./helpers/code.cjs";
|
|
11
|
+
import "./helpers/index.cjs";
|
|
12
|
+
export { MetaContext, MetaItem, Output, OutputProps, PowerlinesContext, ReflectionClassContext, ReflectionClassContextInterface, ReflectionMethodContext, ReflectionParameterContext, ReflectionPropertyContext, SingleLineComment, SingleLineCommentProps, SingleLineCommentVariant, SourceFile, SourceFileProps, Spacing, SpacingProps, __ΩMetaItem, __ΩOutputProps, __ΩReflectionClassContextInterface, __ΩSingleLineCommentProps, __ΩSingleLineCommentVariant, __ΩSourceFileProps, __ΩSpacingProps, code, useMeta, useMetaContext, useMetaSafe, usePowerlines, usePowerlinesContext, usePowerlinesSafe, useReflectionClass, useReflectionMethod, useReflectionParameter, useReflectionProperty };
|
package/dist/core/index.d.mts
CHANGED
|
@@ -7,4 +7,6 @@ import { SingleLineComment, SingleLineCommentProps, SingleLineCommentVariant, __
|
|
|
7
7
|
import { SourceFile, SourceFileProps, __ΩSourceFileProps } from "./components/source-file.mjs";
|
|
8
8
|
import { Spacing, SpacingProps, __ΩSpacingProps } from "./components/spacing.mjs";
|
|
9
9
|
import "./components/index.mjs";
|
|
10
|
-
|
|
10
|
+
import { code } from "./helpers/code.mjs";
|
|
11
|
+
import "./helpers/index.mjs";
|
|
12
|
+
export { MetaContext, MetaItem, Output, OutputProps, PowerlinesContext, ReflectionClassContext, ReflectionClassContextInterface, ReflectionMethodContext, ReflectionParameterContext, ReflectionPropertyContext, SingleLineComment, SingleLineCommentProps, SingleLineCommentVariant, SourceFile, SourceFileProps, Spacing, SpacingProps, __ΩMetaItem, __ΩOutputProps, __ΩReflectionClassContextInterface, __ΩSingleLineCommentProps, __ΩSingleLineCommentVariant, __ΩSourceFileProps, __ΩSpacingProps, code, useMeta, useMetaContext, useMetaSafe, usePowerlines, usePowerlinesContext, usePowerlinesSafe, useReflectionClass, useReflectionMethod, useReflectionParameter, useReflectionProperty };
|
package/dist/core/index.mjs
CHANGED
|
@@ -7,5 +7,7 @@ import { SingleLineComment } from "./components/single-line-comment.mjs";
|
|
|
7
7
|
import { SourceFile } from "./components/source-file.mjs";
|
|
8
8
|
import { Spacing } from "./components/spacing.mjs";
|
|
9
9
|
import "./components/index.mjs";
|
|
10
|
+
import { code } from "./helpers/code.mjs";
|
|
11
|
+
import "./helpers/index.mjs";
|
|
10
12
|
|
|
11
|
-
export { MetaContext, Output, PowerlinesContext, ReflectionClassContext, ReflectionMethodContext, ReflectionParameterContext, ReflectionPropertyContext, SingleLineComment, SourceFile, Spacing, useMeta, useMetaContext, useMetaSafe, usePowerlines, usePowerlinesContext, usePowerlinesSafe, useReflectionClass, useReflectionMethod, useReflectionParameter, useReflectionProperty };
|
|
13
|
+
export { MetaContext, Output, PowerlinesContext, ReflectionClassContext, ReflectionMethodContext, ReflectionParameterContext, ReflectionPropertyContext, SingleLineComment, SourceFile, Spacing, code, useMeta, useMetaContext, useMetaSafe, usePowerlines, usePowerlinesContext, usePowerlinesSafe, useReflectionClass, useReflectionMethod, useReflectionParameter, useReflectionProperty };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as _alloy_js_core2 from "@alloy-js/core";
|
|
2
2
|
|
|
3
3
|
//#region src/markdown/components/front-matter.d.ts
|
|
4
4
|
interface FrontMatterProps {
|
|
@@ -9,7 +9,7 @@ interface FrontMatterProps {
|
|
|
9
9
|
*
|
|
10
10
|
* @see https://jekyllrb.com/docs/front-matter/
|
|
11
11
|
*/
|
|
12
|
-
declare function FrontMatter(props: FrontMatterProps):
|
|
12
|
+
declare function FrontMatter(props: FrontMatterProps): _alloy_js_core2.Children;
|
|
13
13
|
declare type __ΩFrontMatterProps = any[];
|
|
14
14
|
//#endregion
|
|
15
15
|
export { FrontMatter, FrontMatterProps, __ΩFrontMatterProps };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"front-matter.d.cts","names":[],"sources":["../../../src/markdown/components/front-matter.tsx"],"sourcesContent":[],"mappings":";;;UAoBiB,gBAAA;QACT;;AADR;AASA;;;;iBAAgB,WAAA,QAAmB,mBAAgB,
|
|
1
|
+
{"version":3,"file":"front-matter.d.cts","names":[],"sources":["../../../src/markdown/components/front-matter.tsx"],"sourcesContent":[],"mappings":";;;UAoBiB,gBAAA;QACT;;AADR;AASA;;;;iBAAgB,WAAA,QAAmB,mBAAgB,eAAA,CAAA"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as _alloy_js_core8 from "@alloy-js/core";
|
|
2
2
|
|
|
3
3
|
//#region src/markdown/components/front-matter.d.ts
|
|
4
4
|
interface FrontMatterProps {
|
|
@@ -9,7 +9,7 @@ interface FrontMatterProps {
|
|
|
9
9
|
*
|
|
10
10
|
* @see https://jekyllrb.com/docs/front-matter/
|
|
11
11
|
*/
|
|
12
|
-
declare function FrontMatter(props: FrontMatterProps):
|
|
12
|
+
declare function FrontMatter(props: FrontMatterProps): _alloy_js_core8.Children;
|
|
13
13
|
declare type __ΩFrontMatterProps = any[];
|
|
14
14
|
//#endregion
|
|
15
15
|
export { FrontMatter, FrontMatterProps, __ΩFrontMatterProps };
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { ComponentProps, SourceFileHeaderProps } from "../../types/components.cjs";
|
|
2
2
|
import { SourceFileProps as SourceFileProps$1 } from "../../core/components/source-file.cjs";
|
|
3
3
|
import { FrontMatterProps } from "./front-matter.cjs";
|
|
4
|
-
import * as
|
|
4
|
+
import * as _alloy_js_core6 from "@alloy-js/core";
|
|
5
5
|
|
|
6
6
|
//#region src/markdown/components/markdown-file.d.ts
|
|
7
7
|
type MarkdownFileProps = Omit<SourceFileProps$1, "filetype"> & ComponentProps & MarkdownFileHeaderProps;
|
|
@@ -11,7 +11,7 @@ type MarkdownFileProps = Omit<SourceFileProps$1, "filetype"> & ComponentProps &
|
|
|
11
11
|
* @param props - The properties for the source file.
|
|
12
12
|
* @returns The rendered source file component.
|
|
13
13
|
*/
|
|
14
|
-
declare function MarkdownFile(props: MarkdownFileProps):
|
|
14
|
+
declare function MarkdownFile(props: MarkdownFileProps): _alloy_js_core6.Children;
|
|
15
15
|
type MarkdownFileHeaderProps = SourceFileHeaderProps & {
|
|
16
16
|
frontMatter?: FrontMatterProps["data"];
|
|
17
17
|
};
|
|
@@ -21,7 +21,7 @@ type MarkdownFileHeaderProps = SourceFileHeaderProps & {
|
|
|
21
21
|
* @param props - The properties for the source file header.
|
|
22
22
|
* @returns The rendered source file header.
|
|
23
23
|
*/
|
|
24
|
-
declare function MarkdownFileHeader(props: MarkdownFileHeaderProps):
|
|
24
|
+
declare function MarkdownFileHeader(props: MarkdownFileHeaderProps): _alloy_js_core6.Children;
|
|
25
25
|
declare type __ΩMarkdownFileProps = any[];
|
|
26
26
|
declare type __ΩMarkdownFileHeaderProps = any[];
|
|
27
27
|
//#endregion
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { ComponentProps } from "../../types/components.cjs";
|
|
2
2
|
import { MarkdownTableColumnContextInterface } from "../contexts/markdown-table.cjs";
|
|
3
|
-
import * as
|
|
3
|
+
import * as _alloy_js_core3 from "@alloy-js/core";
|
|
4
4
|
|
|
5
5
|
//#region src/markdown/components/markdown-table.d.ts
|
|
6
6
|
interface MarkdownTableProps<T extends Record<string, any> = Record<string, any>> extends ComponentProps {
|
|
@@ -9,18 +9,18 @@ interface MarkdownTableProps<T extends Record<string, any> = Record<string, any>
|
|
|
9
9
|
/**
|
|
10
10
|
* Component that provides a context for rendering markdown tables.
|
|
11
11
|
*/
|
|
12
|
-
declare function MarkdownTable<T extends Record<string, any> = Record<string, any>>(props: MarkdownTableProps<T>):
|
|
12
|
+
declare function MarkdownTable<T extends Record<string, any> = Record<string, any>>(props: MarkdownTableProps<T>): _alloy_js_core3.Children;
|
|
13
13
|
type MarkdownTableColumnProps = ComponentProps & Partial<Pick<MarkdownTableColumnContextInterface, "align">> & Required<Pick<MarkdownTableColumnContextInterface, "name">> & {
|
|
14
14
|
width?: number;
|
|
15
15
|
};
|
|
16
16
|
/**
|
|
17
17
|
* Component that provides a context for rendering markdown tables.
|
|
18
18
|
*/
|
|
19
|
-
declare function MarkdownTableColumn(props: MarkdownTableColumnProps):
|
|
19
|
+
declare function MarkdownTableColumn(props: MarkdownTableColumnProps): _alloy_js_core3.Children;
|
|
20
20
|
/**
|
|
21
21
|
* Component that provides a context for rendering markdown tables.
|
|
22
22
|
*/
|
|
23
|
-
declare function MarkdownTableColumnHeader(props: MarkdownTableColumnProps):
|
|
23
|
+
declare function MarkdownTableColumnHeader(props: MarkdownTableColumnProps): _alloy_js_core3.Children;
|
|
24
24
|
declare type __ΩMarkdownTableProps = any[];
|
|
25
25
|
declare type __ΩMarkdownTableColumnProps = any[];
|
|
26
26
|
//#endregion
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { TSDocModuleProps } from "./tsdoc.cjs";
|
|
2
2
|
import { TypescriptFileProps } from "./typescript-file.cjs";
|
|
3
|
-
import * as
|
|
3
|
+
import * as _alloy_js_core17 from "@alloy-js/core";
|
|
4
4
|
|
|
5
5
|
//#region src/typescript/components/builtin-file.d.ts
|
|
6
6
|
type BuiltinFileProps = Omit<TypescriptFileProps, "path"> & Omit<TSDocModuleProps, "name"> & {
|
|
@@ -28,7 +28,7 @@ type BuiltinFileProps = Omit<TypescriptFileProps, "path"> & Omit<TSDocModuleProp
|
|
|
28
28
|
* @param props - The properties for the source file.
|
|
29
29
|
* @returns The rendered source file component.
|
|
30
30
|
*/
|
|
31
|
-
declare function BuiltinFile(props: BuiltinFileProps):
|
|
31
|
+
declare function BuiltinFile(props: BuiltinFileProps): _alloy_js_core17.Children;
|
|
32
32
|
declare type __ΩBuiltinFileProps = any[];
|
|
33
33
|
//#endregion
|
|
34
34
|
export { BuiltinFile, BuiltinFileProps, __ΩBuiltinFileProps };
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { TSDocModuleProps } from "./tsdoc.mjs";
|
|
2
2
|
import { TypescriptFileProps } from "./typescript-file.mjs";
|
|
3
|
-
import * as
|
|
3
|
+
import * as _alloy_js_core19 from "@alloy-js/core";
|
|
4
4
|
|
|
5
5
|
//#region src/typescript/components/builtin-file.d.ts
|
|
6
6
|
type BuiltinFileProps = Omit<TypescriptFileProps, "path"> & Omit<TSDocModuleProps, "name"> & {
|
|
@@ -28,7 +28,7 @@ type BuiltinFileProps = Omit<TypescriptFileProps, "path"> & Omit<TSDocModuleProp
|
|
|
28
28
|
* @param props - The properties for the source file.
|
|
29
29
|
* @returns The rendered source file component.
|
|
30
30
|
*/
|
|
31
|
-
declare function BuiltinFile(props: BuiltinFileProps):
|
|
31
|
+
declare function BuiltinFile(props: BuiltinFileProps): _alloy_js_core19.Children;
|
|
32
32
|
declare type __ΩBuiltinFileProps = any[];
|
|
33
33
|
//#endregion
|
|
34
34
|
export { BuiltinFile, BuiltinFileProps, __ΩBuiltinFileProps };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as _alloy_js_core16 from "@alloy-js/core";
|
|
2
2
|
import { VarDeclarationProps } from "@alloy-js/typescript";
|
|
3
3
|
|
|
4
4
|
//#region src/typescript/components/dynamic-import-statement.d.ts
|
|
@@ -26,7 +26,7 @@ interface DynamicImportStatementProps extends Omit<VarDeclarationProps, "initial
|
|
|
26
26
|
* @param props - The properties for the dynamic import statement.
|
|
27
27
|
* @returns A `VarDeclaration` component representing the dynamic import statement.
|
|
28
28
|
*/
|
|
29
|
-
declare function DynamicImportStatement(props: DynamicImportStatementProps):
|
|
29
|
+
declare function DynamicImportStatement(props: DynamicImportStatementProps): _alloy_js_core16.Children;
|
|
30
30
|
declare type __ΩDynamicImportStatementProps = any[];
|
|
31
31
|
//#endregion
|
|
32
32
|
export { DynamicImportStatement, DynamicImportStatementProps, __ΩDynamicImportStatementProps };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as _alloy_js_core15 from "@alloy-js/core";
|
|
2
2
|
import { VarDeclarationProps } from "@alloy-js/typescript";
|
|
3
3
|
|
|
4
4
|
//#region src/typescript/components/dynamic-import-statement.d.ts
|
|
@@ -26,7 +26,7 @@ interface DynamicImportStatementProps extends Omit<VarDeclarationProps, "initial
|
|
|
26
26
|
* @param props - The properties for the dynamic import statement.
|
|
27
27
|
* @returns A `VarDeclaration` component representing the dynamic import statement.
|
|
28
28
|
*/
|
|
29
|
-
declare function DynamicImportStatement(props: DynamicImportStatementProps):
|
|
29
|
+
declare function DynamicImportStatement(props: DynamicImportStatementProps): _alloy_js_core15.Children;
|
|
30
30
|
declare type __ΩDynamicImportStatementProps = any[];
|
|
31
31
|
//#endregion
|
|
32
32
|
export { DynamicImportStatement, DynamicImportStatementProps, __ΩDynamicImportStatementProps };
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { TypescriptFileProps } from "./typescript-file.cjs";
|
|
2
|
-
import * as
|
|
2
|
+
import * as _alloy_js_core15 from "@alloy-js/core";
|
|
3
3
|
import { ResolvedEntryTypeDefinition } from "powerlines/types/resolved";
|
|
4
4
|
|
|
5
5
|
//#region src/typescript/components/entry-file.d.ts
|
|
@@ -21,7 +21,7 @@ type EntryFileProps = TypescriptFileProps & {
|
|
|
21
21
|
* @param props - The properties for the source file.
|
|
22
22
|
* @returns The rendered source file component.
|
|
23
23
|
*/
|
|
24
|
-
declare function EntryFile(props: EntryFileProps):
|
|
24
|
+
declare function EntryFile(props: EntryFileProps): _alloy_js_core15.Children;
|
|
25
25
|
declare type __ΩEntryFileProps = any[];
|
|
26
26
|
//#endregion
|
|
27
27
|
export { EntryFile, EntryFileProps, __ΩEntryFileProps };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entry-file.d.cts","names":[],"sources":["../../../src/typescript/components/entry-file.tsx"],"sourcesContent":[],"mappings":";;;;;KA4BY,cAAA,GAAiB;;;AAA7B;AAoBA;;;;;;mBATmB;;;;;;;;iBASH,SAAA,QAAiB,iBAAc,
|
|
1
|
+
{"version":3,"file":"entry-file.d.cts","names":[],"sources":["../../../src/typescript/components/entry-file.tsx"],"sourcesContent":[],"mappings":";;;;;KA4BY,cAAA,GAAiB;;;AAA7B;AAoBA;;;;;;mBATmB;;;;;;;;iBASH,SAAA,QAAiB,iBAAc,gBAAA,CAAA"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { TypescriptFileProps } from "./typescript-file.mjs";
|
|
2
|
-
import * as
|
|
2
|
+
import * as _alloy_js_core13 from "@alloy-js/core";
|
|
3
3
|
import { ResolvedEntryTypeDefinition } from "powerlines/types/resolved";
|
|
4
4
|
|
|
5
5
|
//#region src/typescript/components/entry-file.d.ts
|
|
@@ -21,7 +21,7 @@ type EntryFileProps = TypescriptFileProps & {
|
|
|
21
21
|
* @param props - The properties for the source file.
|
|
22
22
|
* @returns The rendered source file component.
|
|
23
23
|
*/
|
|
24
|
-
declare function EntryFile(props: EntryFileProps):
|
|
24
|
+
declare function EntryFile(props: EntryFileProps): _alloy_js_core13.Children;
|
|
25
25
|
declare type __ΩEntryFileProps = any[];
|
|
26
26
|
//#endregion
|
|
27
27
|
export { EntryFile, EntryFileProps, __ΩEntryFileProps };
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ComponentProps } from "../../types/components.cjs";
|
|
2
|
-
import * as
|
|
2
|
+
import * as _alloy_js_core14 from "@alloy-js/core";
|
|
3
3
|
import { Children, Namekey, Refkey } from "@alloy-js/core";
|
|
4
4
|
import { ReflectionClass, ReflectionProperty } from "@powerlines/deepkit/vendor/type";
|
|
5
5
|
import { CommonDeclarationProps, TypeParameterDescriptor } from "@alloy-js/typescript";
|
|
@@ -35,7 +35,7 @@ interface InterfaceDeclarationPropertyProps extends Omit<InterfaceMemberProps, "
|
|
|
35
35
|
interface InterfaceExpressionProps {
|
|
36
36
|
children?: Children;
|
|
37
37
|
}
|
|
38
|
-
declare const InterfaceExpression:
|
|
38
|
+
declare const InterfaceExpression: _alloy_js_core14.Component<InterfaceExpressionProps>;
|
|
39
39
|
interface InterfaceMemberPropsBase {
|
|
40
40
|
type?: Children;
|
|
41
41
|
children?: Children;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ComponentProps } from "../../types/components.mjs";
|
|
2
|
-
import * as
|
|
2
|
+
import * as _alloy_js_core10 from "@alloy-js/core";
|
|
3
3
|
import { Children, Namekey, Refkey } from "@alloy-js/core";
|
|
4
4
|
import { ReflectionClass, ReflectionProperty } from "@powerlines/deepkit/vendor/type";
|
|
5
5
|
import { CommonDeclarationProps, TypeParameterDescriptor } from "@alloy-js/typescript";
|
|
@@ -35,7 +35,7 @@ interface InterfaceDeclarationPropertyProps extends Omit<InterfaceMemberProps, "
|
|
|
35
35
|
interface InterfaceExpressionProps {
|
|
36
36
|
children?: Children;
|
|
37
37
|
}
|
|
38
|
-
declare const InterfaceExpression:
|
|
38
|
+
declare const InterfaceExpression: _alloy_js_core10.Component<InterfaceExpressionProps>;
|
|
39
39
|
interface InterfaceMemberPropsBase {
|
|
40
40
|
type?: Children;
|
|
41
41
|
children?: Children;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ComponentProps } from "../../types/components.cjs";
|
|
2
|
-
import * as
|
|
2
|
+
import * as _alloy_js_core18 from "@alloy-js/core";
|
|
3
3
|
import { ReflectionClass, ReflectionProperty } from "@powerlines/deepkit/vendor/type";
|
|
4
4
|
import { VarDeclarationProps } from "@alloy-js/typescript";
|
|
5
5
|
|
|
@@ -17,11 +17,11 @@ interface ObjectDeclarationPropertyProps extends ComponentProps {
|
|
|
17
17
|
/**
|
|
18
18
|
* Generates a TypeScript object for the given reflection class.
|
|
19
19
|
*/
|
|
20
|
-
declare function ObjectDeclaration<T extends Record<string, any> = Record<string, any>>(props: ObjectDeclarationProps<T>):
|
|
20
|
+
declare function ObjectDeclaration<T extends Record<string, any> = Record<string, any>>(props: ObjectDeclarationProps<T>): _alloy_js_core18.Children;
|
|
21
21
|
/**
|
|
22
22
|
* Generates a TypeScript object property for the given reflection class.
|
|
23
23
|
*/
|
|
24
|
-
declare function ObjectDeclarationProperty(props: ObjectDeclarationPropertyProps):
|
|
24
|
+
declare function ObjectDeclarationProperty(props: ObjectDeclarationPropertyProps): _alloy_js_core18.Children;
|
|
25
25
|
declare type __ΩComputedRef = any[];
|
|
26
26
|
declare type __ΩObjectDeclarationProps = any[];
|
|
27
27
|
declare type __ΩObjectDeclarationPropertyProps = any[];
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ComponentProps } from "../../types/components.mjs";
|
|
2
|
-
import * as
|
|
2
|
+
import * as _alloy_js_core11 from "@alloy-js/core";
|
|
3
3
|
import { ReflectionClass, ReflectionProperty } from "@powerlines/deepkit/vendor/type";
|
|
4
4
|
import { VarDeclarationProps } from "@alloy-js/typescript";
|
|
5
5
|
|
|
@@ -17,11 +17,11 @@ interface ObjectDeclarationPropertyProps extends ComponentProps {
|
|
|
17
17
|
/**
|
|
18
18
|
* Generates a TypeScript object for the given reflection class.
|
|
19
19
|
*/
|
|
20
|
-
declare function ObjectDeclaration<T extends Record<string, any> = Record<string, any>>(props: ObjectDeclarationProps<T>):
|
|
20
|
+
declare function ObjectDeclaration<T extends Record<string, any> = Record<string, any>>(props: ObjectDeclarationProps<T>): _alloy_js_core11.Children;
|
|
21
21
|
/**
|
|
22
22
|
* Generates a TypeScript object property for the given reflection class.
|
|
23
23
|
*/
|
|
24
|
-
declare function ObjectDeclarationProperty(props: ObjectDeclarationPropertyProps):
|
|
24
|
+
declare function ObjectDeclarationProperty(props: ObjectDeclarationPropertyProps): _alloy_js_core11.Children;
|
|
25
25
|
declare type __ΩComputedRef = any[];
|
|
26
26
|
declare type __ΩObjectDeclarationProps = any[];
|
|
27
27
|
declare type __ΩObjectDeclarationPropertyProps = any[];
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as _alloy_js_core10 from "@alloy-js/core";
|
|
2
2
|
|
|
3
3
|
//#region src/typescript/components/property-name.d.ts
|
|
4
4
|
interface PropertyNameProps {
|
|
@@ -17,7 +17,7 @@ interface PropertyNameProps {
|
|
|
17
17
|
* @remarks
|
|
18
18
|
* If the name is not a valid JavaScript identifier, it will be quoted. If a `name` prop is provided, it will be used as the property name. Otherwise, the name will be taken from the {@link (MemberDeclarationContext:variable)}.
|
|
19
19
|
*/
|
|
20
|
-
declare function PropertyName(props: PropertyNameProps):
|
|
20
|
+
declare function PropertyName(props: PropertyNameProps): _alloy_js_core10.Children;
|
|
21
21
|
declare type __ΩPropertyNameProps = any[];
|
|
22
22
|
//#endregion
|
|
23
23
|
export { PropertyName, PropertyNameProps, __ΩPropertyNameProps };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as _alloy_js_core20 from "@alloy-js/core";
|
|
2
2
|
|
|
3
3
|
//#region src/typescript/components/property-name.d.ts
|
|
4
4
|
interface PropertyNameProps {
|
|
@@ -17,7 +17,7 @@ interface PropertyNameProps {
|
|
|
17
17
|
* @remarks
|
|
18
18
|
* If the name is not a valid JavaScript identifier, it will be quoted. If a `name` prop is provided, it will be used as the property name. Otherwise, the name will be taken from the {@link (MemberDeclarationContext:variable)}.
|
|
19
19
|
*/
|
|
20
|
-
declare function PropertyName(props: PropertyNameProps):
|
|
20
|
+
declare function PropertyName(props: PropertyNameProps): _alloy_js_core20.Children;
|
|
21
21
|
declare type __ΩPropertyNameProps = any[];
|
|
22
22
|
//#endregion
|
|
23
23
|
export { PropertyName, PropertyNameProps, __ΩPropertyNameProps };
|
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
import { TSDocProps } from "./tsdoc.mjs";
|
|
2
|
-
import * as
|
|
2
|
+
import * as _alloy_js_core16 from "@alloy-js/core";
|
|
3
3
|
|
|
4
4
|
//#region src/typescript/components/tsdoc-reflection.d.ts
|
|
5
5
|
/**
|
|
6
6
|
* Generates a TypeScript interface property for the given reflection class.
|
|
7
7
|
*/
|
|
8
|
-
declare function TSDocReflectionClass<T extends Record<string, any> = Record<string, any>>(props: TSDocProps):
|
|
8
|
+
declare function TSDocReflectionClass<T extends Record<string, any> = Record<string, any>>(props: TSDocProps): _alloy_js_core16.Children;
|
|
9
9
|
/**
|
|
10
10
|
* Generates a TypeScript interface property for the given reflection class.
|
|
11
11
|
*/
|
|
12
|
-
declare function TSDocReflectionProperty(props: TSDocProps):
|
|
12
|
+
declare function TSDocReflectionProperty(props: TSDocProps): _alloy_js_core16.Children;
|
|
13
13
|
/**
|
|
14
14
|
* Generates a TypeScript interface property for the given reflection class.
|
|
15
15
|
*/
|
|
16
|
-
declare function TSDocReflectionMethod(props: TSDocProps):
|
|
16
|
+
declare function TSDocReflectionMethod(props: TSDocProps): _alloy_js_core16.Children;
|
|
17
17
|
//#endregion
|
|
18
18
|
export { TSDocReflectionClass, TSDocReflectionMethod, TSDocReflectionProperty };
|
|
19
19
|
//# sourceMappingURL=tsdoc-reflection.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tsdoc.mjs","names":["childrenArray","For","List","Prose","Show","splitProps","stringifyDefaultValue","isSetString","isUndefined","usePowerlinesSafe","TSDoc","props","children","heading","_$createIntrinsic","string","_$createComponent","when","_$memo","length","TSDocTag","tag","Boolean","width","TSDocParams","parameters","normalizeParametersForDoc","each","param","TSDocParam","name","optional","doc","some","p","TSDocTitle","rest","_$mergeProps","TSDocDomain","TSDocAlias","TSDocPermission","TSDocDefaultValue","type","defaultValue","TSDocRemarks","hardline","TSDocLink","TSDocExample","tsx","fenced","language","TSDocReadonly","TSDocInternal","TSDocIgnore","TSDocHidden","TSDocAttributesTags","title","alias","permission","domain","readonly","internal","ignore","hidden","trim","a","filter","TSDocParamName","TSDocParamDescription","TSDocReturns","TSDocThrows","TSDocModule","prefix","context","config","framework"],"sources":["../../../src/typescript/components/tsdoc.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/powerlines\n Documentation: https://docs.stormsoftware.com/projects/powerlines\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport {\n Children,\n childrenArray,\n For,\n List,\n Prose,\n Show,\n splitProps\n} from \"@alloy-js/core\";\nimport { JSDocExampleProps, ParameterDescriptor } from \"@alloy-js/typescript\";\nimport { stringifyDefaultValue } from \"@powerlines/deepkit/utilities\";\nimport {\n ReflectionKind,\n ReflectionParameter,\n ReflectionProperty\n} from \"@powerlines/deepkit/vendor/type\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport { isUndefined } from \"@stryke/type-checks/is-undefined\";\nimport { usePowerlinesSafe } from \"../../core/contexts/context\";\nimport { ComponentProps } from \"../../types/components\";\n\nexport interface TSDocProps extends ComponentProps {\n heading?: Children;\n}\n\n/**\n * Generates a TypeScript interface for the given reflection class.\n */\nexport function TSDoc(props: TSDocProps) {\n const [{ children, heading }] = splitProps(props, [\"children\", \"heading\"]);\n\n return (\n <>\n /**\n <align string=\" * \">\n <hbr />\n <Show when={!isUndefined(heading)}>\n {heading}\n <Show\n when={\n !isUndefined(children) && childrenArray(() => children).length > 0\n }>\n <hbr />\n </Show>\n </Show>\n <Show\n when={\n !isUndefined(children) && childrenArray(() => children).length > 0\n }>\n <List>{childrenArray(() => children)}</List>\n </Show>\n </align>\n <hbr />\n {` */`}\n <hbr />\n </>\n );\n}\n\nexport interface TSDocTagProps extends ComponentProps {\n tag: string;\n}\n\n/**\n * Create a TSDoc `@<props.tag>` tag.\n */\nexport function TSDocTag(props: TSDocTagProps) {\n const [{ children, tag }] = splitProps(props, [\"children\", \"tag\"]);\n\n return (\n <>\n {`@${tag} `}\n <Show when={Boolean(children)}>\n <align width={2}>\n <Prose>{children}</Prose>\n </align>\n </Show>\n <hbr />\n </>\n );\n}\n\nexport interface TSDocParamsProps {\n parameters: ParameterDescriptor[] | string[];\n}\n\n/**\n * A component that creates a TSDoc block with `@param` tags for each parameter.\n */\nexport function TSDocParams(props: TSDocParamsProps) {\n const parameters = normalizeParametersForDoc(props.parameters);\n\n return (\n <For each={parameters}>\n {param => (\n <TSDocParam name={param.name} optional={param.optional}>\n {param.doc}\n </TSDocParam>\n )}\n </For>\n );\n}\n\nfunction normalizeParametersForDoc(\n parameters: ParameterDescriptor[] | string[]\n): ParameterDescriptor[] {\n if (parameters.some(p => typeof p === \"string\")) {\n return [];\n }\n\n return parameters as ParameterDescriptor[];\n}\n\n/**\n * Create a TSDoc `@title` tag.\n */\nexport function TSDocTitle(props: ComponentProps) {\n const [{ children }, rest] = splitProps(props, [\"children\"]);\n\n return (\n <TSDocTag {...rest} tag=\"title\">\n {children}\n </TSDocTag>\n );\n}\n\n/**\n * Create a TSDoc `@domain` tag.\n */\nexport function TSDocDomain(props: ComponentProps) {\n const [{ children }, rest] = splitProps(props, [\"children\"]);\n\n return (\n <TSDocTag {...rest} tag=\"domain\">\n {children}\n </TSDocTag>\n );\n}\n\n/**\n * Create a TSDoc `@alias` tag.\n */\nexport function TSDocAlias(props: ComponentProps) {\n const [{ children }, rest] = splitProps(props, [\"children\"]);\n\n return (\n <TSDocTag {...rest} tag=\"alias\">\n {children}\n </TSDocTag>\n );\n}\n\n/**\n * Create a TSDoc `@permission` tag.\n */\nexport function TSDocPermission(props: ComponentProps) {\n const [{ children }, rest] = splitProps(props, [\"children\"]);\n\n return (\n <TSDocTag {...rest} tag=\"permission\">\n {children}\n </TSDocTag>\n );\n}\n\nexport interface TSDocDefaultValueProps extends ComponentProps {\n type: ReflectionKind | ReflectionProperty | ReflectionParameter;\n defaultValue: any;\n}\n\n/**\n * Create a TSDoc `@defaultValue` tag.\n */\nexport function TSDocDefaultValue(props: TSDocDefaultValueProps) {\n const [{ type, defaultValue }] = splitProps(props, [\"type\", \"defaultValue\"]);\n\n return (\n <>\n {\"@defaultValue \"}\n <Show when={!isUndefined(defaultValue)}>\n <align width={2}>\n <Prose>{stringifyDefaultValue(type, defaultValue)}</Prose>\n </align>\n </Show>\n <hbr />\n </>\n );\n}\n\n/**\n * Create a TSDoc `@remarks` tag.\n */\nexport function TSDocRemarks(props: ComponentProps) {\n return (\n <>\n {\"@remarks \"}\n <hbr />\n <List hardline={true}>{childrenArray(() => props.children)}</List>\n </>\n );\n}\n\n/**\n * Create a TSDoc `@see` tag.\n */\nexport function TSDocLink(props: ComponentProps) {\n return <TSDocTag {...props} tag=\"see\" />;\n}\n\nexport interface TSDocExampleProps extends JSDocExampleProps {\n /**\n * Whether the file is a TSX file.\n *\n * @defaultValue false\n */\n tsx?: boolean;\n}\n\n/**\n * Create a TSDoc `@example` tag.\n */\nexport function TSDocExample(props: TSDocExampleProps) {\n const [{ tsx, fenced = true, language, children }] = splitProps(props, [\n \"tsx\",\n \"fenced\",\n \"language\",\n \"children\"\n ]);\n\n return (\n <>\n {\"@example \"}\n <hbr />\n <Show when={fenced}>\n ```{language || (tsx ? \"tsx\" : \"ts\")}\n <hbr />\n </Show>\n {children}\n <Show when={fenced}>\n <hbr />\n ```\n </Show>\n </>\n );\n}\n\n/**\n * Create a TSDoc `@readonly` tag.\n */\nexport function TSDocReadonly() {\n return <TSDocTag tag=\"readonly\" />;\n}\n\n/**\n * Create a TSDoc `@internal` tag.\n */\nexport function TSDocInternal() {\n return <TSDocTag tag=\"internal\" />;\n}\n\n/**\n * Create a TSDoc `@ignore` tag.\n */\nexport function TSDocIgnore() {\n return <TSDocTag tag=\"ignore\" />;\n}\n\n/**\n * Create a TSDoc `@hidden` tag.\n */\nexport function TSDocHidden() {\n return <TSDocTag tag=\"hidden\" />;\n}\n\nexport interface TSDocAttributesTagsProps {\n type?: ReflectionKind | ReflectionProperty | ReflectionParameter;\n title?: string;\n alias?: string[];\n permission?: string[];\n domain?: string;\n readonly?: boolean;\n internal?: boolean;\n ignore?: boolean;\n hidden?: boolean;\n defaultValue?: any;\n}\n\n/**\n * Generates a TypeScript interface property for the given reflection class.\n */\nexport function TSDocAttributesTags(props: TSDocAttributesTagsProps) {\n const [\n {\n type,\n title,\n alias,\n permission,\n domain,\n readonly,\n internal,\n ignore,\n hidden,\n defaultValue\n }\n ] = splitProps(props, [\n \"type\",\n \"title\",\n \"alias\",\n \"permission\",\n \"domain\",\n \"readonly\",\n \"internal\",\n \"ignore\",\n \"hidden\",\n \"defaultValue\"\n ]);\n\n return (\n <>\n <Show when={isSetString(title?.trim())}>\n <TSDocTitle>{title}</TSDocTitle>\n </Show>\n <Show\n when={\n !isUndefined(alias) &&\n alias.length > 0 &&\n alias.some(a => isSetString(a?.trim()))\n }>\n <For each={alias?.filter(a => isSetString(a?.trim())) ?? []}>\n {alias => <TSDocAlias>{alias}</TSDocAlias>}\n </For>\n </Show>\n <Show when={isSetString(domain?.trim())}>\n <TSDocDomain>{domain}</TSDocDomain>\n </Show>\n <Show\n when={\n !isUndefined(permission) &&\n permission.length > 0 &&\n permission.some(p => isSetString(p?.trim()))\n }>\n <For each={permission?.filter(p => isSetString(p?.trim())) ?? []}>\n {permission => <TSDocPermission>{permission}</TSDocPermission>}\n </For>\n </Show>\n <Show when={readonly === true}>\n <TSDocReadonly />\n </Show>\n <Show when={internal === true}>\n <TSDocInternal />\n </Show>\n <Show when={ignore === true}>\n <TSDocIgnore />\n </Show>\n <Show when={hidden === true}>\n <TSDocHidden />\n </Show>\n <Show when={!isUndefined(type) && !isUndefined(defaultValue)}>\n <TSDocDefaultValue\n type={\n type as ReflectionKind | ReflectionProperty | ReflectionParameter\n }\n defaultValue={defaultValue}\n />\n </Show>\n </>\n );\n}\n\nexport interface TSDocParamProps {\n name: Children;\n children?: Children;\n optional?: boolean;\n defaultValue?: Children;\n}\n\n/**\n * Create a TSDoc parameter set off with `@param`.\n */\nexport function TSDocParam(props: TSDocParamProps) {\n return (\n <>\n {\"@param \"}\n <TSDocParamName\n name={props.name}\n optional={props.optional}\n defaultValue={props.defaultValue}\n />\n <TSDocParamDescription children={props.children} />\n </>\n );\n}\n\ninterface TSDocParamNameProps {\n name: Children;\n optional?: boolean;\n defaultValue?: Children;\n}\n\nfunction TSDocParamName(props: TSDocParamNameProps) {\n return (\n <>\n <Show when={props.optional}>{\"[\"}</Show>\n {props.name}\n <Show when={Boolean(props.defaultValue)}>={props.defaultValue}</Show>\n <Show when={props.optional}>{\"]\"}</Show>\n </>\n );\n}\n\ninterface TSDocParamDescriptionProps {\n children?: Children;\n}\n\nfunction TSDocParamDescription(props: TSDocParamDescriptionProps) {\n return (\n <Show when={Boolean(props.children)}>\n {\" - \"}\n <align width={2}>\n <Prose>{props.children}</Prose>\n </align>\n </Show>\n );\n}\n\n/**\n * Create a TSDoc `@returns` tag.\n */\nexport function TSDocReturns(props: ComponentProps) {\n return <TSDocTag {...props} tag=\"returns\" />;\n}\n\n/**\n * Create a TSDoc `@throws` tag.\n */\nexport function TSDocThrows(props: ComponentProps) {\n return <TSDocTag {...props} tag=\"throws\" />;\n}\n\nexport interface TSDocModuleProps extends ComponentProps {\n /**\n * The prefix for the builtin module name\n *\n * @remarks\n * This value is populated from the Powerlines configuration output builtin prefix by default.\n *\n * @example\n * ```ts\n * /**\n * @module powerlines:my-module\n * \\/\n * ```\n */\n prefix?: string;\n\n /**\n * The name of the module\n *\n * @remarks\n * This will be used in the `@module` tag as well as the import path for the module, e.g. `storm:<name>`.\n *\n * @example\n * ```ts\n * import { MyModule } from \"powerlines:my-module\";\n * ```\n */\n name: Children;\n}\n\n/**\n * Generates a TSDoc `@module` tag for the given module name.\n */\nexport function TSDocModule(props: TSDocModuleProps) {\n const [{ children, name, prefix }] = splitProps(props, [\n \"children\",\n \"name\",\n \"prefix\"\n ]);\n\n const context = usePowerlinesSafe();\n\n return (\n <>\n /**\n <align string=\" * \">\n <hbr />\n <Show when={Boolean(children)}>\n <List hardline={true}>{childrenArray(() => children)}</List>\n <hbr />\n <hbr />\n </Show>\n {\"@module \"}\n {prefix || context?.config?.framework || \"powerlines\"}:{name}\n </align>\n <hbr />\n {` */`}\n </>\n );\n}\n"],"mappings":";;;;;;;;;;;SA4GqB0B,MAAAA,OAAAA;UAAAA,UAAAA,aAAAA,WAAAA,OAAAA,CAAAA,YAAAA,UAAAA,CAAAA;;;;;;;;;;mCAaZA;;MAAAA,IAAAA,WAAAA;AAAAA,cAAAA,UAAAA,sBAAAA;QAAAA,IAAAA,OAAAA;AAAAA,gBAAAA,WAAAA,CAAAA,CAAAA,CAAAA,YAAAA,SAAAA,CAAAA,EAAAA,IAAAA,oBAAAA,SAAAA,CAAAA,SAAAA;;QAAAA,IAAAA,WAAAA;AAAAA,gBAAAA,gBAAAA,OAAAA,EAAAA,CAAAA;;QAAAA,CAAAA,CAAAA;;MAAAA,CAAAA;KAAAA;;;;;8BAckB,MAAA,EAAA,IAAA,WAAA;AAAA,eAAA,oBAAA,SAAA;UAAA,CAAA;;MAAA,CAAA;KAAA;;GAAA,CAAA;EAAA,gBAAA,OAAA,EAAA,CAAA;EAAA;EAAA,gBAAA,OAAA,EAAA,CAAA;EAAA;;;;;SAgBtBN,SAAAA,OAAAA;OAAAA,CAAAA,EAAAA,UAAAA,SAAAA,WAAAA,OAAAA,CAAAA,YAAAA,MAAAA,CAAAA;;;;;;;;;;;sCAcU,UAAA,CAAA;;KAAA,CAAA;;GAAA,CAAA;EAAA,gBAAA,OAAA,EAAA,CAAA;EAAA;;;;;;;QAgBf,0BASA,MAAA,WAAA;;;;;;;;;;;;;;;;;;;;;SAuBkB,WAAA,OAAA;;;;;;;;;;SAuBlB,YAAA,OAAA;8BAAA,WAAA,OAAA,CAAA,WAAA,CAAA;;;;;;;;;SAewB,WAAA,OAaxB;8BAAA,WAAA,OAAA,CAAA,WAAA,CAAA;wBAAA,UAAA,WAAA,MAAA;EAAA,KAAA;;;;;;;;UAWsB,YAAA,QAAA,WAAA,OAAA,CAWtB,WAAA,CAAA;wBAAA,UAAA,WAAA,MAAA;EAAA,KAAA;EAAA;EAAA,CAAA,CAAA;;;;;;;;EAwBI;EAAA,gBAAA;;;;;;;;;;;;;;;;;;;;;SAqCgD,aAAA,OAAA;AAAA,QAAA;;;;;;;;;;;;;;;wBAuBhC,UAAA,WAAA,OAAA,EAAA,KAAA,OAAA,CAAA,CAAA;;;;;sBAepB,OAAA;8BAAA,UAAA,cAAA,WAAA,OAAA;EAAA;EAAA;;;;;;;kBAiBY,MAAA;GAAA,MAAA;GAAA,IAAA,WAAA;AAAA,WAAA;KAAA;;;;;;;;;;;;;;;;;;yBAeZ;wBAAA,UAAA,EAAA,KAAA,YAAA,CAAA;;;;;SAMgC,gBAAA;wBAAA,UAAA,EAAA,KAAA,YAAA,CAAA;;;;;SAAG,cAAA;wBAAA,UAAA,EAAA,KAAA,UAAA,CAAA;;;;;;;;;;;SAkBnC,oBAAA,OAAA;OAAA,CAAA,EAAA,MAAA,OAAA,OAAA,YAAA,kBAAA,UAAA,QAAA,QAAA,kBAAA,WAAA,OAAA;EAAA;;;;;;;;;EASA;EAAA,CAAA;;;;;;;;;;;;+DAG4BT,GAAAA,EAAAA,IAE5B,MAAA,MAAA,MAAA,YAAA,GAAA,MAAA,CAAA,CAAA;;GAAA,IAAA,WAAA;AAAA,WAAA,gBAAA,KAAA;KAAA,IAAA,OAAA;AAAA,aAAA,OAAA,QAAA,MAAA,YAAA,GAAA,MAAA,CAAA,CAAA,IAAA,EAAA;;KAAA,WAAA,YAAA,gBAAA,YAAA,EAAA,UAAA,SAAA,CAAA;KAAA,CAAA;;GAAA,CAAA;EAAA,gBAAA,MAAA;GAAA,IAAA,OAAA;AAAA,WAAA,YAAA,QAAA,MAAA,CAAA;;GAAA,IAAA,WAAA;AAAA,WAAA,gBAAA,aAAA,EAAA,UAAA,QAAA,CAAA;;GAAA,CAAA;EAAA,gBAAA,MAAA;GAAA,IAAA,OAAA;AAAA,WAAA,WAAA,CAAA,EAAA,CAAA,YAAA,WAAA,IAAA,WAAA,SAAA,GAAA,EAAA,IAAA,WAAA,MAAA,MAAA,YAAA,GAAA,MAAA,CAAA,CAAA;;GAAA,IAAA,WAAA;AAAA,WAAA,gBAkCA,KAAA;KAAA,IAAA,OAAA;AAAA,aAAA,YAAA,QAAA,MAAA,YAAA,GAAA,MAAA,CAAA,CAAA,IAAA,EAAA;;KAAA;;;;;;;;;;;;;;;;kBAamB"}
|
|
1
|
+
{"version":3,"file":"tsdoc.mjs","names":["childrenArray","For","List","Prose","Show","splitProps","stringifyDefaultValue","isSetString","isUndefined","usePowerlinesSafe","TSDoc","props","children","heading","_$createIntrinsic","string","_$createComponent","when","_$memo","length","TSDocTag","tag","Boolean","width","TSDocParams","parameters","normalizeParametersForDoc","each","param","TSDocParam","name","optional","doc","some","p","TSDocTitle","rest","_$mergeProps","TSDocDomain","TSDocAlias","TSDocPermission","TSDocDefaultValue","type","defaultValue","TSDocRemarks","hardline","TSDocLink","TSDocExample","tsx","fenced","language","TSDocReadonly","TSDocInternal","TSDocIgnore","TSDocHidden","TSDocAttributesTags","title","alias","permission","domain","readonly","internal","ignore","hidden","trim","a","filter","TSDocParamName","TSDocParamDescription","TSDocReturns","TSDocThrows","TSDocModule","prefix","context","config","framework"],"sources":["../../../src/typescript/components/tsdoc.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/powerlines\n Documentation: https://docs.stormsoftware.com/projects/powerlines\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport {\n Children,\n childrenArray,\n For,\n List,\n Prose,\n Show,\n splitProps\n} from \"@alloy-js/core\";\nimport { JSDocExampleProps, ParameterDescriptor } from \"@alloy-js/typescript\";\nimport { stringifyDefaultValue } from \"@powerlines/deepkit/utilities\";\nimport {\n ReflectionKind,\n ReflectionParameter,\n ReflectionProperty\n} from \"@powerlines/deepkit/vendor/type\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport { isUndefined } from \"@stryke/type-checks/is-undefined\";\nimport { usePowerlinesSafe } from \"../../core/contexts/context\";\nimport { ComponentProps } from \"../../types/components\";\n\nexport interface TSDocProps extends ComponentProps {\n heading?: Children;\n}\n\n/**\n * Generates a TypeScript interface for the given reflection class.\n */\nexport function TSDoc(props: TSDocProps) {\n const [{ children, heading }] = splitProps(props, [\"children\", \"heading\"]);\n\n return (\n <>\n /**\n <align string=\" * \">\n <hbr />\n <Show when={!isUndefined(heading)}>\n {heading}\n <Show\n when={\n !isUndefined(children) && childrenArray(() => children).length > 0\n }>\n <hbr />\n </Show>\n </Show>\n <Show\n when={\n !isUndefined(children) && childrenArray(() => children).length > 0\n }>\n <List>{childrenArray(() => children)}</List>\n </Show>\n </align>\n <sbr />\n {` */`}\n <hbr />\n </>\n );\n}\n\nexport interface TSDocTagProps extends ComponentProps {\n tag: string;\n}\n\n/**\n * Create a TSDoc `@<props.tag>` tag.\n */\nexport function TSDocTag(props: TSDocTagProps) {\n const [{ children, tag }] = splitProps(props, [\"children\", \"tag\"]);\n\n return (\n <>\n {`@${tag} `}\n <Show when={Boolean(children)}>\n <align width={2}>\n <Prose>{children}</Prose>\n </align>\n </Show>\n <hbr />\n </>\n );\n}\n\nexport interface TSDocParamsProps {\n parameters: ParameterDescriptor[] | string[];\n}\n\n/**\n * A component that creates a TSDoc block with `@param` tags for each parameter.\n */\nexport function TSDocParams(props: TSDocParamsProps) {\n const parameters = normalizeParametersForDoc(props.parameters);\n\n return (\n <For each={parameters}>\n {param => (\n <TSDocParam name={param.name} optional={param.optional}>\n {param.doc}\n </TSDocParam>\n )}\n </For>\n );\n}\n\nfunction normalizeParametersForDoc(\n parameters: ParameterDescriptor[] | string[]\n): ParameterDescriptor[] {\n if (parameters.some(p => typeof p === \"string\")) {\n return [];\n }\n\n return parameters as ParameterDescriptor[];\n}\n\n/**\n * Create a TSDoc `@title` tag.\n */\nexport function TSDocTitle(props: ComponentProps) {\n const [{ children }, rest] = splitProps(props, [\"children\"]);\n\n return (\n <TSDocTag {...rest} tag=\"title\">\n {children}\n </TSDocTag>\n );\n}\n\n/**\n * Create a TSDoc `@domain` tag.\n */\nexport function TSDocDomain(props: ComponentProps) {\n const [{ children }, rest] = splitProps(props, [\"children\"]);\n\n return (\n <TSDocTag {...rest} tag=\"domain\">\n {children}\n </TSDocTag>\n );\n}\n\n/**\n * Create a TSDoc `@alias` tag.\n */\nexport function TSDocAlias(props: ComponentProps) {\n const [{ children }, rest] = splitProps(props, [\"children\"]);\n\n return (\n <TSDocTag {...rest} tag=\"alias\">\n {children}\n </TSDocTag>\n );\n}\n\n/**\n * Create a TSDoc `@permission` tag.\n */\nexport function TSDocPermission(props: ComponentProps) {\n const [{ children }, rest] = splitProps(props, [\"children\"]);\n\n return (\n <TSDocTag {...rest} tag=\"permission\">\n {children}\n </TSDocTag>\n );\n}\n\nexport interface TSDocDefaultValueProps extends ComponentProps {\n type: ReflectionKind | ReflectionProperty | ReflectionParameter;\n defaultValue: any;\n}\n\n/**\n * Create a TSDoc `@defaultValue` tag.\n */\nexport function TSDocDefaultValue(props: TSDocDefaultValueProps) {\n const [{ type, defaultValue }] = splitProps(props, [\"type\", \"defaultValue\"]);\n\n return (\n <>\n {\"@defaultValue \"}\n <Show when={!isUndefined(defaultValue)}>\n <align width={2}>\n <Prose>{stringifyDefaultValue(type, defaultValue)}</Prose>\n </align>\n </Show>\n <hbr />\n </>\n );\n}\n\n/**\n * Create a TSDoc `@remarks` tag.\n */\nexport function TSDocRemarks(props: ComponentProps) {\n return (\n <>\n {\"@remarks \"}\n <hbr />\n <List hardline={true}>{childrenArray(() => props.children)}</List>\n </>\n );\n}\n\n/**\n * Create a TSDoc `@see` tag.\n */\nexport function TSDocLink(props: ComponentProps) {\n return <TSDocTag {...props} tag=\"see\" />;\n}\n\nexport interface TSDocExampleProps extends JSDocExampleProps {\n /**\n * Whether the file is a TSX file.\n *\n * @defaultValue false\n */\n tsx?: boolean;\n}\n\n/**\n * Create a TSDoc `@example` tag.\n */\nexport function TSDocExample(props: TSDocExampleProps) {\n const [{ tsx, fenced = true, language, children }] = splitProps(props, [\n \"tsx\",\n \"fenced\",\n \"language\",\n \"children\"\n ]);\n\n return (\n <>\n {\"@example \"}\n <hbr />\n <Show when={fenced}>\n ```{language || (tsx ? \"tsx\" : \"ts\")}\n <hbr />\n </Show>\n {children}\n <Show when={fenced}>\n <hbr />\n ```\n </Show>\n </>\n );\n}\n\n/**\n * Create a TSDoc `@readonly` tag.\n */\nexport function TSDocReadonly() {\n return <TSDocTag tag=\"readonly\" />;\n}\n\n/**\n * Create a TSDoc `@internal` tag.\n */\nexport function TSDocInternal() {\n return <TSDocTag tag=\"internal\" />;\n}\n\n/**\n * Create a TSDoc `@ignore` tag.\n */\nexport function TSDocIgnore() {\n return <TSDocTag tag=\"ignore\" />;\n}\n\n/**\n * Create a TSDoc `@hidden` tag.\n */\nexport function TSDocHidden() {\n return <TSDocTag tag=\"hidden\" />;\n}\n\nexport interface TSDocAttributesTagsProps {\n type?: ReflectionKind | ReflectionProperty | ReflectionParameter;\n title?: string;\n alias?: string[];\n permission?: string[];\n domain?: string;\n readonly?: boolean;\n internal?: boolean;\n ignore?: boolean;\n hidden?: boolean;\n defaultValue?: any;\n}\n\n/**\n * Generates a TypeScript interface property for the given reflection class.\n */\nexport function TSDocAttributesTags(props: TSDocAttributesTagsProps) {\n const [\n {\n type,\n title,\n alias,\n permission,\n domain,\n readonly,\n internal,\n ignore,\n hidden,\n defaultValue\n }\n ] = splitProps(props, [\n \"type\",\n \"title\",\n \"alias\",\n \"permission\",\n \"domain\",\n \"readonly\",\n \"internal\",\n \"ignore\",\n \"hidden\",\n \"defaultValue\"\n ]);\n\n return (\n <>\n <Show when={isSetString(title?.trim())}>\n <TSDocTitle>{title}</TSDocTitle>\n </Show>\n <Show\n when={\n !isUndefined(alias) &&\n alias.length > 0 &&\n alias.some(a => isSetString(a?.trim()))\n }>\n <For each={alias?.filter(a => isSetString(a?.trim())) ?? []}>\n {alias => <TSDocAlias>{alias}</TSDocAlias>}\n </For>\n </Show>\n <Show when={isSetString(domain?.trim())}>\n <TSDocDomain>{domain}</TSDocDomain>\n </Show>\n <Show\n when={\n !isUndefined(permission) &&\n permission.length > 0 &&\n permission.some(p => isSetString(p?.trim()))\n }>\n <For each={permission?.filter(p => isSetString(p?.trim())) ?? []}>\n {permission => <TSDocPermission>{permission}</TSDocPermission>}\n </For>\n </Show>\n <Show when={readonly === true}>\n <TSDocReadonly />\n </Show>\n <Show when={internal === true}>\n <TSDocInternal />\n </Show>\n <Show when={ignore === true}>\n <TSDocIgnore />\n </Show>\n <Show when={hidden === true}>\n <TSDocHidden />\n </Show>\n <Show when={!isUndefined(type) && !isUndefined(defaultValue)}>\n <TSDocDefaultValue\n type={\n type as ReflectionKind | ReflectionProperty | ReflectionParameter\n }\n defaultValue={defaultValue}\n />\n </Show>\n </>\n );\n}\n\nexport interface TSDocParamProps {\n name: Children;\n children?: Children;\n optional?: boolean;\n defaultValue?: Children;\n}\n\n/**\n * Create a TSDoc parameter set off with `@param`.\n */\nexport function TSDocParam(props: TSDocParamProps) {\n return (\n <>\n {\"@param \"}\n <TSDocParamName\n name={props.name}\n optional={props.optional}\n defaultValue={props.defaultValue}\n />\n <TSDocParamDescription children={props.children} />\n </>\n );\n}\n\ninterface TSDocParamNameProps {\n name: Children;\n optional?: boolean;\n defaultValue?: Children;\n}\n\nfunction TSDocParamName(props: TSDocParamNameProps) {\n return (\n <>\n <Show when={props.optional}>{\"[\"}</Show>\n {props.name}\n <Show when={Boolean(props.defaultValue)}>={props.defaultValue}</Show>\n <Show when={props.optional}>{\"]\"}</Show>\n </>\n );\n}\n\ninterface TSDocParamDescriptionProps {\n children?: Children;\n}\n\nfunction TSDocParamDescription(props: TSDocParamDescriptionProps) {\n return (\n <Show when={Boolean(props.children)}>\n {\" - \"}\n <align width={2}>\n <Prose>{props.children}</Prose>\n </align>\n </Show>\n );\n}\n\n/**\n * Create a TSDoc `@returns` tag.\n */\nexport function TSDocReturns(props: ComponentProps) {\n return <TSDocTag {...props} tag=\"returns\" />;\n}\n\n/**\n * Create a TSDoc `@throws` tag.\n */\nexport function TSDocThrows(props: ComponentProps) {\n return <TSDocTag {...props} tag=\"throws\" />;\n}\n\nexport interface TSDocModuleProps extends ComponentProps {\n /**\n * The prefix for the builtin module name\n *\n * @remarks\n * This value is populated from the Powerlines configuration output builtin prefix by default.\n *\n * @example\n * ```ts\n * /**\n * @module powerlines:my-module\n * \\/\n * ```\n */\n prefix?: string;\n\n /**\n * The name of the module\n *\n * @remarks\n * This will be used in the `@module` tag as well as the import path for the module, e.g. `storm:<name>`.\n *\n * @example\n * ```ts\n * import { MyModule } from \"powerlines:my-module\";\n * ```\n */\n name: Children;\n}\n\n/**\n * Generates a TSDoc `@module` tag for the given module name.\n */\nexport function TSDocModule(props: TSDocModuleProps) {\n const [{ children, name, prefix }] = splitProps(props, [\n \"children\",\n \"name\",\n \"prefix\"\n ]);\n\n const context = usePowerlinesSafe();\n\n return (\n <>\n /**\n <align string=\" * \">\n <hbr />\n <Show when={Boolean(children)}>\n <List hardline={true}>{childrenArray(() => children)}</List>\n <hbr />\n <hbr />\n </Show>\n {\"@module \"}\n {prefix || context?.config?.framework || \"powerlines\"}:{name}\n </align>\n <hbr />\n {` */`}\n </>\n );\n}\n"],"mappings":";;;;;;;;;;;SA4GqB0B,MAAAA,OAAAA;UAAAA,UAAAA,aAAAA,WAAAA,OAAAA,CAAAA,YAAAA,UAAAA,CAAAA;;;;;;;;;;mCAaZA;;MAAAA,IAAAA,WAAAA;AAAAA,cAAAA,UAAAA,sBAAAA;QAAAA,IAAAA,OAAAA;AAAAA,gBAAAA,WAAAA,CAAAA,CAAAA,CAAAA,YAAAA,SAAAA,CAAAA,EAAAA,IAAAA,oBAAAA,SAAAA,CAAAA,SAAAA;;QAAAA,IAAAA,WAAAA;AAAAA,gBAAAA,gBAAAA,OAAAA,EAAAA,CAAAA;;QAAAA,CAAAA,CAAAA;;MAAAA,CAAAA;KAAAA;;;;;8BAckB,MAAA,EAAA,IAAA,WAAA;AAAA,eAAA,oBAAA,SAAA;UAAA,CAAA;;MAAA,CAAA;KAAA;;GAAA,CAAA;EAAA,gBAAA,OAAA,EAAA,CAAA;EAAA;EAAA,gBAAA,OAAA,EAAA,CAAA;EAAA;;;;;SAgBtBN,SAAAA,OAAAA;OAAAA,CAAAA,EAAAA,UAAAA,SAAAA,WAAAA,OAAAA,CAAAA,YAAAA,MAAAA,CAAAA;;;;;;;;;;;sCAcU,UAAA,CAAA;;KAAA,CAAA;;GAAA,CAAA;EAAA,gBAAA,OAAA,EAAA,CAAA;EAAA;;;;;;;QAgBf,0BASA,MAAA,WAAA;;;;;;;;;;;;;;;;;;;;;SAuBkB,WAAA,OAAA;;;;;;;;;;SAuBlB,YAAA,OAAA;8BAAA,WAAA,OAAA,CAAA,WAAA,CAAA;;;;;;;;;SAewB,WAAA,OAaxB;8BAAA,WAAA,OAAA,CAAA,WAAA,CAAA;wBAAA,UAAA,WAAA,MAAA;EAAA,KAAA;;;;;;;;UAWsB,YAAA,QAAA,WAAA,OAAA,CAWtB,WAAA,CAAA;wBAAA,UAAA,WAAA,MAAA;EAAA,KAAA;EAAA;EAAA,CAAA,CAAA;;;;;;;;EAwBI;EAAA,gBAAA;;;;;;;;;;;;;;;;;;;;;SAqCgD,aAAA,OAAA;AAAA,QAAA;;;;;;;;;;;;;;;wBAuBhC,UAAA,WAAA,OAAA,EAAA,KAAA,OAAA,CAAA,CAAA;;;;;sBAepB,OAAA;8BAAA,UAAA,cAAA,WAAA,OAAA;EAAA;EAAA;;;;;;;kBAiBY,MAAA;GAAA,MAAA;GAAA,IAAA,WAAA;AAAA,WAAA;KAAA;;;;;;;;;;;;;;;;;;yBAeZ;wBAAA,UAAA,EAAA,KAAA,YAAA,CAAA;;;;;SAMgC,gBAAA;wBAAA,UAAA,EAAA,KAAA,YAAA,CAAA;;;;;SAAG,cAAA;wBAAA,UAAA,EAAA,KAAA,UAAA,CAAA;;;;;;;;;;;SAkBnC,oBAAA,OAAA;OAAA,CAAA,EAAA,MAAA,OAAA,OAAA,YAAA,kBAAA,UAAA,QAAA,QAAA,kBAAA,WAAA,OAAA;EAAA;;;;;;;;;EASA;EAAA,CAAA;;;;;;;;;;;;+DAG4BT,GAAAA,EAAAA,IAE5B,MAAA,MAAA,MAAA,YAAA,GAAA,MAAA,CAAA,CAAA;;GAAA,IAAA,WAAA;AAAA,WAAA,gBAAA,KAAA;KAAA,IAAA,OAAA;AAAA,aAAA,OAAA,QAAA,MAAA,YAAA,GAAA,MAAA,CAAA,CAAA,IAAA,EAAA;;KAAA,WAAA,YAAA,gBAAA,YAAA,EAAA,UAAA,SAAA,CAAA;KAAA,CAAA;;GAAA,CAAA;EAAA,gBAAA,MAAA;GAAA,IAAA,OAAA;AAAA,WAAA,YAAA,QAAA,MAAA,CAAA;;GAAA,IAAA,WAAA;AAAA,WAAA,gBAAA,aAAA,EAAA,UAAA,QAAA,CAAA;;GAAA,CAAA;EAAA,gBAAA,MAAA;GAAA,IAAA,OAAA;AAAA,WAAA,WAAA,CAAA,EAAA,CAAA,YAAA,WAAA,IAAA,WAAA,SAAA,GAAA,EAAA,IAAA,WAAA,MAAA,MAAA,YAAA,GAAA,MAAA,CAAA,CAAA;;GAAA,IAAA,WAAA;AAAA,WAAA,gBAkCA,KAAA;KAAA,IAAA,OAAA;AAAA,aAAA,YAAA,QAAA,MAAA,YAAA,GAAA,MAAA,CAAA,CAAA,IAAA,EAAA;;KAAA;;;;;;;;;;;;;;;;kBAamB"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as _alloy_js_core9 from "@alloy-js/core";
|
|
2
2
|
import { CommonDeclarationProps, TypeParameterDescriptor } from "@alloy-js/typescript";
|
|
3
3
|
|
|
4
4
|
//#region src/typescript/components/type-declaration.d.ts
|
|
@@ -8,7 +8,7 @@ interface TypeDeclarationProps extends CommonDeclarationProps {
|
|
|
8
8
|
*/
|
|
9
9
|
typeParameters?: TypeParameterDescriptor[] | string[];
|
|
10
10
|
}
|
|
11
|
-
declare const TypeDeclaration:
|
|
11
|
+
declare const TypeDeclaration: _alloy_js_core9.Component<TypeDeclarationProps>;
|
|
12
12
|
declare type __ΩTypeDeclarationProps = any[];
|
|
13
13
|
//#endregion
|
|
14
14
|
export { TypeDeclaration, TypeDeclarationProps, __ΩTypeDeclarationProps };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"type-declaration.d.cts","names":[],"sources":["../../../src/typescript/components/type-declaration.tsx"],"sourcesContent":[],"mappings":";;;;UA4BiB,oBAAA,SAA6B;;;AAA9C;EAOa,cAAA,CAAA,EAHM,uBAGS,EAAA,GAAA,MAAA,EAAA;;cAAf,iBAAe,
|
|
1
|
+
{"version":3,"file":"type-declaration.d.cts","names":[],"sources":["../../../src/typescript/components/type-declaration.tsx"],"sourcesContent":[],"mappings":";;;;UA4BiB,oBAAA,SAA6B;;;AAA9C;EAOa,cAAA,CAAA,EAHM,uBAGS,EAAA,GAAA,MAAA,EAAA;;cAAf,iBAAe,eAAA,CAAA,UAAA"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as _alloy_js_core14 from "@alloy-js/core";
|
|
2
2
|
import { CommonDeclarationProps, TypeParameterDescriptor } from "@alloy-js/typescript";
|
|
3
3
|
|
|
4
4
|
//#region src/typescript/components/type-declaration.d.ts
|
|
@@ -8,7 +8,7 @@ interface TypeDeclarationProps extends CommonDeclarationProps {
|
|
|
8
8
|
*/
|
|
9
9
|
typeParameters?: TypeParameterDescriptor[] | string[];
|
|
10
10
|
}
|
|
11
|
-
declare const TypeDeclaration:
|
|
11
|
+
declare const TypeDeclaration: _alloy_js_core14.Component<TypeDeclarationProps>;
|
|
12
12
|
declare type __ΩTypeDeclarationProps = any[];
|
|
13
13
|
//#endregion
|
|
14
14
|
export { TypeDeclaration, TypeDeclarationProps, __ΩTypeDeclarationProps };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as _alloy_js_core9 from "@alloy-js/core";
|
|
2
2
|
import { ScopePropsWithInfo, ScopePropsWithValue } from "@alloy-js/core";
|
|
3
3
|
|
|
4
4
|
//#region src/typescript/contexts/lexical-scope.d.ts
|
|
@@ -8,7 +8,7 @@ type LexicalScopeProps = LexicalScopePropsWithScopeValue | LexicalScopePropsWith
|
|
|
8
8
|
/**
|
|
9
9
|
* A lexical scope for TypeScript, which contains declaration spaces for types and values. Declaration components will create symbols in this scope.
|
|
10
10
|
*/
|
|
11
|
-
declare function LexicalScope(props: LexicalScopeProps):
|
|
11
|
+
declare function LexicalScope(props: LexicalScopeProps): _alloy_js_core9.Children;
|
|
12
12
|
declare type __ΩLexicalScopePropsWithScopeValue = any[];
|
|
13
13
|
declare type __ΩLexicalScopePropsWithScopeInfo = any[];
|
|
14
14
|
declare type __ΩLexicalScopeProps = any[];
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@powerlines/plugin-alloy",
|
|
3
|
-
"version": "0.23.
|
|
3
|
+
"version": "0.23.3",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "A package containing various Alloy framework components and helper utilities.",
|
|
6
6
|
"repository": {
|
|
@@ -195,6 +195,34 @@
|
|
|
195
195
|
"default": "./dist/core/contexts/reflection.mjs"
|
|
196
196
|
}
|
|
197
197
|
},
|
|
198
|
+
"./core/helpers": {
|
|
199
|
+
"require": {
|
|
200
|
+
"types": "./dist/core/helpers/index.d.cts",
|
|
201
|
+
"default": "./dist/core/helpers/index.cjs"
|
|
202
|
+
},
|
|
203
|
+
"import": {
|
|
204
|
+
"types": "./dist/core/helpers/index.d.mts",
|
|
205
|
+
"default": "./dist/core/helpers/index.mjs"
|
|
206
|
+
},
|
|
207
|
+
"default": {
|
|
208
|
+
"types": "./dist/core/helpers/index.d.mts",
|
|
209
|
+
"default": "./dist/core/helpers/index.mjs"
|
|
210
|
+
}
|
|
211
|
+
},
|
|
212
|
+
"./core/helpers/code": {
|
|
213
|
+
"require": {
|
|
214
|
+
"types": "./dist/core/helpers/code.d.cts",
|
|
215
|
+
"default": "./dist/core/helpers/code.cjs"
|
|
216
|
+
},
|
|
217
|
+
"import": {
|
|
218
|
+
"types": "./dist/core/helpers/code.d.mts",
|
|
219
|
+
"default": "./dist/core/helpers/code.mjs"
|
|
220
|
+
},
|
|
221
|
+
"default": {
|
|
222
|
+
"types": "./dist/core/helpers/code.d.mts",
|
|
223
|
+
"default": "./dist/core/helpers/code.mjs"
|
|
224
|
+
}
|
|
225
|
+
},
|
|
198
226
|
"./helpers": {
|
|
199
227
|
"require": {
|
|
200
228
|
"types": "./dist/helpers/index.d.cts",
|
|
@@ -726,8 +754,8 @@
|
|
|
726
754
|
"@alloy-js/markdown": "0.23.0-dev.1",
|
|
727
755
|
"@alloy-js/rollup-plugin": "^0.1.0",
|
|
728
756
|
"@alloy-js/typescript": "0.23.0-dev.4",
|
|
729
|
-
"@powerlines/deepkit": "^0.6.
|
|
730
|
-
"@powerlines/plugin-babel": "^0.12.
|
|
757
|
+
"@powerlines/deepkit": "^0.6.57",
|
|
758
|
+
"@powerlines/plugin-babel": "^0.12.286",
|
|
731
759
|
"@storm-software/config-tools": "^1.189.0",
|
|
732
760
|
"@stryke/capnp": "^0.12.68",
|
|
733
761
|
"@stryke/convert": "^0.6.40",
|
|
@@ -740,14 +768,14 @@
|
|
|
740
768
|
"@stryke/types": "^0.10.39",
|
|
741
769
|
"@stryke/unique-id": "^0.3.54",
|
|
742
770
|
"defu": "^6.1.4",
|
|
743
|
-
"powerlines": "^0.38.
|
|
771
|
+
"powerlines": "^0.38.44",
|
|
744
772
|
"prettier": "^3.8.1",
|
|
745
773
|
"unctx": "^2.5.0"
|
|
746
774
|
},
|
|
747
775
|
"devDependencies": {
|
|
748
|
-
"@powerlines/plugin-plugin": "^0.12.
|
|
776
|
+
"@powerlines/plugin-plugin": "^0.12.228",
|
|
749
777
|
"@types/node": "^24.10.13"
|
|
750
778
|
},
|
|
751
779
|
"publishConfig": { "access": "public" },
|
|
752
|
-
"gitHead": "
|
|
780
|
+
"gitHead": "8e49aaca5d2d4b15e0ddd89bd2b5aa6682cc64b6"
|
|
753
781
|
}
|