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