mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
f0ce987bc1
Note that this *trivially* updates project urls by adding the NPM url to the end, even when the urls are almost identical or the DT one is outdated. I'll clean up the urls in a later commit. This PR is unfinished! Please do not merge it yet.
131 lines
2.9 KiB
TypeScript
131 lines
2.9 KiB
TypeScript
// Type definitions for idyll 2.10
|
|
// Project: https://github.com/idyll-lang/idyll/tree/master/packages/idyll-cli, https://github.com/idyll-lang/idyll
|
|
// Definitions by: Thanh Ngo <https://github.com/iocat>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.8
|
|
|
|
import { EventEmitter } from "events";
|
|
import { Options as CompilerOptions } from "idyll-compiler";
|
|
|
|
interface Options {
|
|
/**
|
|
* Monitor input files and rebuild on changes
|
|
*/
|
|
watch?: boolean;
|
|
/**
|
|
* The datasets directory
|
|
*/
|
|
datasets?: string;
|
|
/**
|
|
* Whether to minify output build
|
|
*/
|
|
minify?: boolean;
|
|
/**
|
|
*
|
|
* Pre-render HTML as part of the build
|
|
*/
|
|
ssr?: boolean;
|
|
/**
|
|
* The components directory
|
|
*/
|
|
components?: boolean;
|
|
/**
|
|
* The default component directory
|
|
* This corresponds to where the idyll-components package stays
|
|
*/
|
|
defaultComponents?: boolean;
|
|
/**
|
|
* The layout defined in idyll-layouts package
|
|
*/
|
|
layout?: string;
|
|
/**
|
|
* The theme defined in idyll-theme package
|
|
*/
|
|
theme?: string;
|
|
/**
|
|
* The output directory for compiled documents
|
|
*/
|
|
output?: string;
|
|
/**
|
|
* Custom port to bind the local server to.
|
|
*/
|
|
port?: number;
|
|
/**
|
|
* Temporary directory used by idyll
|
|
*/
|
|
temp?: string;
|
|
/**
|
|
* path to HTML template
|
|
*
|
|
*/
|
|
template?: string;
|
|
|
|
/**
|
|
* Custom CSS file to include in output
|
|
*/
|
|
css?: string;
|
|
/**
|
|
* Custom browserify transforms to apply.
|
|
*/
|
|
transform?: string[];
|
|
/**
|
|
* Compiler options
|
|
*/
|
|
compiler?: CompilerOptions;
|
|
/**
|
|
* the idyll file to be compiled into
|
|
*/
|
|
inputFile?: string;
|
|
|
|
/**
|
|
* used internally by IdyllInstance
|
|
*/
|
|
inputConfig?: {
|
|
components: any;
|
|
transform: any[];
|
|
compiler: CompilerOptions;
|
|
};
|
|
}
|
|
|
|
type PredefinedFile =
|
|
| "APP_PATH"
|
|
| "CSS_INPUT_FILE"
|
|
| "DATA_DIR"
|
|
| "HTML_TEMPLATE_FILE"
|
|
| "IDYLL_INPUT_FILE"
|
|
| "INPUT_DIR"
|
|
| "PACKAGE_FILE"
|
|
| "OUTPUT_DIR"
|
|
| "TMP_DIR"
|
|
| "CSS_OUTPUT_FILE"
|
|
| "HTML_OUTPUT_FILE"
|
|
| "JS_OUTPUT_FILE";
|
|
|
|
type ComponentFiles = "COMPONENT_DIRS" | "DEFAULT_COMPONENT_DIRS";
|
|
|
|
type Paths = Record<PredefinedFile, string> & Record<ComponentFiles, string[]>;
|
|
|
|
declare class IdyllInstance extends EventEmitter {
|
|
/**
|
|
* Returns internal paths used by idyll-cli
|
|
*/
|
|
getPaths(): Paths;
|
|
/**
|
|
* Returns idyll compiling's options
|
|
*/
|
|
getOptions(): Options;
|
|
/**
|
|
*
|
|
* if indexIdyllMarkup is provided, compiles it
|
|
*
|
|
* Otherwise, compiles and optionally watches
|
|
* the idyll file at IOptions.inputFile
|
|
*
|
|
*/
|
|
build(indexIdyllMarkup?: string | null): this;
|
|
}
|
|
|
|
declare function idyll(options: Options, callback?: () => void): IdyllInstance;
|
|
|
|
export = idyll;
|