UNPKG

2.45 kBTypeScriptView Raw
1export declare type SupportedFrameworks = 'react' | 'react-native' | 'vue' | 'vue3' | 'angular' | 'mithril' | 'riot' | 'ember' | 'marionette' | 'marko' | 'meteor' | 'preact' | 'svelte' | 'rax' | 'aurelia' | 'html' | 'web-components' | 'server';
2export declare enum ProjectType {
3 UNDETECTED = "UNDETECTED",
4 UNSUPPORTED = "UNSUPPORTED",
5 REACT_SCRIPTS = "REACT_SCRIPTS",
6 METEOR = "METEOR",
7 REACT = "REACT",
8 REACT_NATIVE = "REACT_NATIVE",
9 REACT_PROJECT = "REACT_PROJECT",
10 WEBPACK_REACT = "WEBPACK_REACT",
11 VUE = "VUE",
12 VUE3 = "VUE3",
13 SFC_VUE = "SFC_VUE",
14 ANGULAR = "ANGULAR",
15 EMBER = "EMBER",
16 ALREADY_HAS_STORYBOOK = "ALREADY_HAS_STORYBOOK",
17 UPDATE_PACKAGE_ORGANIZATIONS = "UPDATE_PACKAGE_ORGANIZATIONS",
18 WEB_COMPONENTS = "WEB_COMPONENTS",
19 MITHRIL = "MITHRIL",
20 MARIONETTE = "MARIONETTE",
21 MARKO = "MARKO",
22 HTML = "HTML",
23 RIOT = "RIOT",
24 PREACT = "PREACT",
25 SVELTE = "SVELTE",
26 RAX = "RAX",
27 AURELIA = "AURELIA",
28 SERVER = "SERVER"
29}
30export declare const SUPPORTED_FRAMEWORKS: SupportedFrameworks[];
31export declare enum CoreBuilder {
32 Webpack4 = "webpack4",
33 Webpack5 = "webpack5",
34 Vite = "vite"
35}
36export declare type Builder = CoreBuilder | (string & {});
37export declare enum SupportedLanguage {
38 JAVASCRIPT = "javascript",
39 TYPESCRIPT = "typescript"
40}
41export declare type TemplateMatcher = {
42 files?: boolean[];
43 dependencies?: boolean[];
44 peerDependencies?: boolean[];
45};
46export declare type TemplateConfiguration = {
47 preset: ProjectType;
48 /** will be checked both against dependencies and devDependencies */
49 dependencies?: string[] | {
50 [dependency: string]: (version: string) => boolean;
51 };
52 peerDependencies?: string[] | {
53 [dependency: string]: (version: string) => boolean;
54 };
55 files?: string[];
56 matcherFunction: (matcher: TemplateMatcher) => boolean;
57};
58/**
59 * Configuration to match a storybook preset template.
60 *
61 * This has to be an array sorted in order of specificity/priority.
62 * Reason: both REACT and WEBPACK_REACT have react as dependency,
63 * therefore WEBPACK_REACT has to come first, as it's more specific.
64 */
65export declare const supportedTemplates: TemplateConfiguration[];
66export declare const unsupportedTemplate: TemplateConfiguration;
67export declare const installableProjectTypes: string[];