@shd101wyy/yo 0.1.12 → 0.1.13

package/out/types/src/build-runner.d.ts

@@ -16,7 +16,7 @@ export declare function stageRuntimeFiles(runtimeFiles: readonly string[], outpu
 export declare function runBuild(options: BuildOptions): Promise<void>;
 export interface DAGNode {
     name: string;
-    kind: "artifact" | "test" | "run" | "step";
+    kind: "artifact" | "test" | "run" | "step" | "doc";
     dependsOn: string[];
 }
 export declare function buildDAG(registry: BuildRegistry, rootStepName: string): DAGNode[];

package/out/types/src/doc/builder.d.ts

@@ -0,0 +1,21 @@
+import type { Token } from "../token";
+import type { ModuleValue } from "../value";
+import type { DocExtractionResult } from "./extractor";
+import type { DocModule } from "./model";
+export interface BuildDocModuleOptions {
+    name: string;
+    path: string;
+    moduleValue: ModuleValue;
+    extraction: DocExtractionResult;
+    tokens: Token[];
+    includePrivate?: boolean;
+}
+export declare function buildDocModule(options: BuildDocModuleOptions): DocModule;
+export interface BuildDocModuleFromTokensOptions {
+    name: string;
+    path: string;
+    extraction: DocExtractionResult;
+    tokens: Token[];
+}
+export declare function buildDocModuleFromTokens(options: BuildDocModuleFromTokensOptions): DocModule;
+export declare function buildCrossReferences(modules: DocModule[]): void;

package/out/types/src/doc/builder.test.d.ts

@@ -0,0 +1 @@
+export {};

package/out/types/src/doc/extractor.d.ts

@@ -0,0 +1,27 @@
+import type { Token } from "../token";
+export interface DocComment {
+    content: string;
+    inner: boolean;
+    position: Token["position"];
+    modulePath: string;
+}
+export interface DocAssociation {
+    comment: DocComment;
+    declarationName: string;
+    declarationPosition: Token["position"] | null;
+}
+export interface DocExtractionResult {
+    moduleDoc: DocComment | null;
+    declarations: DocAssociation[];
+}
+export interface InlineDocResult {
+    docs: Map<string, string>;
+}
+export declare function stripDocLineComment(value: string): string;
+export declare function stripDocBlockComment(value: string): string;
+export declare function extractDocComments(tokens: Token[]): DocExtractionResult;
+export declare function extractInlineDocs(tokens: Token[], startIndex: number, endIndex: number): InlineDocResult;
+export declare function findMatchingParens(tokens: Token[], searchStart: number): {
+    open: number;
+    close: number;
+} | null;

package/out/types/src/doc/extractor.test.d.ts

@@ -0,0 +1 @@
+export {};

package/out/types/src/doc/model.d.ts

@@ -0,0 +1,87 @@
+export type DocItemKind = "function" | "struct" | "object" | "enum" | "newtype" | "union" | "trait" | "module" | "constant" | "type-alias" | "type-function";
+export interface DocParam {
+    name: string;
+    type: string;
+    isComptime: boolean;
+    isImplicit: boolean;
+    defaultValue?: string;
+    doc?: string;
+}
+export interface DocField {
+    name: string;
+    type: string;
+    doc?: string;
+    defaultValue?: string;
+}
+export interface DocVariant {
+    name: string;
+    fields?: DocField[];
+    doc?: string;
+    discriminant?: string;
+}
+export interface DocAssociatedType {
+    name: string;
+    doc?: string;
+    constraint?: string;
+}
+export interface DocFunction {
+    name: string;
+    doc?: string;
+    signature: string;
+    parameters: DocParam[];
+    returnType: string;
+    typeParams?: DocParam[];
+    effects?: DocParam[];
+    isMethod: boolean;
+    selfType?: string;
+    returns?: string;
+    errors?: string;
+    deprecated?: string;
+    examples?: string;
+}
+export interface DocType {
+    name: string;
+    doc?: string;
+    kind: DocItemKind;
+    signature: string;
+    typeParams?: DocParam[];
+    fields?: DocField[];
+    variants?: DocVariant[];
+    methods: DocFunction[];
+    traitImpls: string[];
+    deprecated?: string;
+    examples?: string;
+}
+export interface DocTrait {
+    name: string;
+    doc?: string;
+    kind: "trait" | "module" | "trait-function" | "module-function";
+    signature: string;
+    typeParams?: DocParam[];
+    associatedTypes?: DocAssociatedType[];
+    methods: DocFunction[];
+    implementors: string[];
+    deprecated?: string;
+    examples?: string;
+}
+export interface DocConstant {
+    name: string;
+    doc?: string;
+    type: string;
+    value?: string;
+    deprecated?: string;
+}
+export interface DocModule {
+    name: string;
+    path: string;
+    doc?: string;
+    functions: DocFunction[];
+    types: DocType[];
+    traits: DocTrait[];
+    constants: DocConstant[];
+    submodules: DocModule[];
+}
+export interface DocModel {
+    name: string;
+    modules: DocModule[];
+}

package/out/types/src/doc/render-html.d.ts

@@ -0,0 +1,23 @@
+import type { DocModel } from "./model";
+export declare function destroyMarkdownRenderer(): void;
+declare function escapeHtml(text: string): string;
+declare function moduleToFilename(name: string): string;
+declare function moduleDisplayName(name: string): string;
+declare function moduleGroup(name: string): string;
+declare function generateCSS(): string;
+declare function generateSearchJS(): string;
+interface SearchEntry {
+    name: string;
+    kind: string;
+    href: string;
+    doc?: string;
+    module: string;
+}
+declare function buildSearchIndex(model: DocModel): SearchEntry[];
+declare function firstSentence(text: string): string;
+export interface RenderHtmlOptions {
+    model: DocModel;
+    outputDir: string;
+}
+export declare function renderDocSite(options: RenderHtmlOptions): Promise<void>;
+export { escapeHtml, buildSearchIndex, firstSentence, generateCSS, generateSearchJS, moduleToFilename, moduleDisplayName, moduleGroup, };

package/out/types/src/doc/render-html.test.d.ts

@@ -0,0 +1 @@
+export {};

package/out/types/src/doc/render-json.d.ts

@@ -0,0 +1,7 @@
+import type { DocModel } from "./model";
+export interface RenderJsonOptions {
+    model: DocModel;
+    outputDir: string;
+    pretty?: boolean;
+}
+export declare function renderDocJson(options: RenderJsonOptions): void;

package/out/types/src/doc/render-json.test.d.ts

@@ -0,0 +1 @@
+export {};

package/out/types/src/doc/render-markdown.d.ts

@@ -0,0 +1,13 @@
+import type { DocModel, DocModule, DocFunction, DocType, DocTrait, DocConstant } from "./model";
+declare function renderFunction(fn: DocFunction): string;
+declare function renderType(type: DocType): string;
+declare function renderTrait(trait: DocTrait): string;
+declare function renderConstant(constant: DocConstant): string;
+declare function renderModule(mod: DocModule): string;
+declare function renderIndex(model: DocModel): string;
+export interface RenderMarkdownOptions {
+    model: DocModel;
+    outputDir: string;
+}
+export declare function renderDocMarkdown(options: RenderMarkdownOptions): void;
+export { renderFunction as renderFunctionMd, renderType as renderTypeMd, renderTrait as renderTraitMd, renderConstant as renderConstantMd, renderModule as renderModuleMd, renderIndex as renderIndexMd, };

package/out/types/src/doc/render-markdown.test.d.ts

@@ -0,0 +1 @@
+export {};

package/out/types/src/doc/sections.d.ts

@@ -0,0 +1,7 @@
+export interface ParsedDocComment {
+    summary: string;
+    description: string;
+    sections: Map<string, string>;
+}
+export declare function parseDocComment(text: string): ParsedDocComment;
+export declare function isKnownSection(name: string): boolean;

package/out/types/src/doc/sections.test.d.ts

@@ -0,0 +1 @@
+export {};

package/out/types/src/doc-command.d.ts

@@ -0,0 +1,10 @@
+export type DocFormat = "html" | "markdown" | "json";
+export interface DocCommandOptions {
+    input: string;
+    outputDir: string;
+    includePrivate: boolean;
+    verbose: boolean;
+    title?: string;
+    format?: DocFormat;
+}
+export declare function runDoc(options: DocCommandOptions): Promise<void>;

package/out/types/src/env.d.ts

@@ -21,6 +21,7 @@ export interface Variable {
     isFromEffectSpread?: boolean;
     isEffectParam?: boolean;
     isModuleLevel?: boolean;
+    docComment?: string;
 }
 export type WhereClauseConstraints = {
     someType: SomeType;

package/out/types/src/evaluator/builtins/build.d.ts

@@ -73,6 +73,17 @@ export interface ImportedModule {
     resolvedRoot?: string;
     propagatedSystemLibraries?: string[];
 }
+export interface BuildDocConfig {
+    name: string;
+    root: string;
+    outputDir: string;
+    format: string;
+    includePrivate: boolean;
+    includeDeps: boolean;
+    title: string;
+    logo: string;
+    favicon: string;
+}
 export declare class BuildRegistry {
     artifacts: BuildArtifact[];
     testSuites: BuildTestSuite[];
@@ -83,6 +94,7 @@ export declare class BuildRegistry {
     systemLibraries: BuildSystemLibrary[];
     dependencyArtifacts: DependencyArtifactRef[];
     modules: BuildModuleEntry[];
+    docConfigs: BuildDocConfig[];
     cliOptions: Map<string, string>;
     declaredOptions: Map<string, {
         description: string;
@@ -109,6 +121,8 @@ export declare class BuildRegistry {
     findTest(name: string): BuildTestSuite | undefined;
     findRunStep(name: string): BuildRunStep | undefined;
     findStep(name: string): BuildStep | undefined;
+    findDocumentation(name: string): BuildDocConfig | undefined;
+    registerDocumentation(config: BuildDocConfig): void;
     private checkDuplicateArtifactName;
     findDependency(name: string): BuildGitDependency | undefined;
     findPathDependency(name: string): BuildPathDependency | undefined;
@@ -123,6 +137,9 @@ export declare class BuildRegistry {
     } | {
         kind: "run";
         value: BuildRunStep;
+    } | {
+        kind: "doc";
+        value: BuildDocConfig;
     } | {
         kind: "step";
         value: BuildStep;

package/out/types/src/evaluator/context.d.ts

@@ -69,6 +69,7 @@ export interface EvaluatorContext {
     isInsideIoAsyncCall?: boolean;
     isInsideGivenHandler?: boolean;
     isEvaluatingGenericImplSpecialization?: boolean;
+    docCommentLookup?: Map<string, string>;
 }
 export interface ArgValues {
     forallArgs: {

package/out/types/src/expr.d.ts

@@ -64,7 +64,7 @@ export interface EvaluatedExprData {
     caseExecuted?: boolean;
     isPrimitiveMatch?: boolean;
     primitivePatternValues?: (Value | undefined)[];
-    comment?: string;
+    docComment?: string;
     deferredDupExpressions?: Expr[];
     deferredDropExpressions?: Expr[];
     consumedVariableDropExpressions?: Expr[];
@@ -600,6 +600,7 @@ export declare const BuiltinFunctions: {
     __yo_build_add_import: string[];
     __yo_build_add_cflags: string[];
     __yo_build_dep_module: string[];
+    __yo_build_doc: string[];
     asm: string[];
     global_asm: string[];
 };

package/out/types/src/token.d.ts

@@ -17,6 +17,10 @@ export declare enum TokenType {
     Comma = ",",
     SingleLineComment = "single_line_comment",
     MultiLineComment = "multi_line_comment",
+    DocLineComment = "doc_line_comment",
+    InnerDocLineComment = "inner_doc_line_comment",
+    DocBlockComment = "doc_block_comment",
+    InnerDocBlockComment = "inner_doc_block_comment",
     Whitespace = "whitespace",
     TemplateString = "template_string"
 }