UNPKG

1.41 kBTypeScriptView Raw
1import { CrossbowConfiguration } from "./config";
2import { CrossbowInput, CLI, CrossbowReporter } from "./index";
3import { Tasks } from "./task.resolve";
4import Rx = require("rx");
5import { ReportTypes } from "./reporter.resolve";
6import * as file from "./file.utils";
7export interface DocsError {
8 type: DocsErrorTypes | ReportTypes;
9}
10export interface DocsInputFileNotFoundError extends DocsError {
11 file: file.ExternalFile;
12}
13export interface DocsOutputFileExistsError extends DocsInputFileNotFoundError {
14}
15export declare enum DocsErrorTypes {
16 DocsInputFileNotFound,
17 DocsOutputFileExists,
18}
19export declare const docStartComment = "<!--crossbow-docs-start-->";
20export declare const docEndComment = "<!--crossbow-docs-end-->";
21export declare const hasRegExp: RegExp;
22export declare const hasExistingComments: (inputString: any) => boolean;
23export declare const readmeRegExp: RegExp;
24export interface DocsFileOutput {
25 file: file.ExternalFile;
26 content: string;
27}
28export interface DocsCommandOutput {
29 tasks: Tasks;
30 errors: DocsError[];
31 markdown?: string;
32 output?: DocsFileOutput[];
33}
34export declare type DocsCommandComplete = Rx.Observable<{
35 setup: DocsCommandOutput;
36}>;
37export default function handleIncomingDocsCommand(cli: CLI, input: CrossbowInput, config: CrossbowConfiguration, reporter: CrossbowReporter): Rx.Observable<{
38 setup: DocsCommandOutput;
39}>;