UNPKG

4.98 kBTypeScriptView Raw
1import cosmiconfig from 'cosmiconfig';
2import { ArgsType } from './cli/args';
3import { ILogger } from './utils/logger';
4export default class Config {
5 logger: ILogger;
6 constructor(logger: ILogger);
7 /**
8 * Load the .autorc from the file system, set up defaults, combine with CLI args
9 * load the extends property, load the plugins and start the git remote interface.
10 */
11 loadConfig(args: ArgsType): Promise<{
12 labels: import("./release").ILabelDefinitionMap;
13 skipReleaseLabels: any;
14 command: string;
15 githubApi?: string | undefined;
16 plugins?: string[] | undefined;
17 owner?: string | undefined;
18 repo?: string | undefined;
19 verbose?: boolean | undefined;
20 veryVerbose?: boolean | undefined;
21 onlyLabels?: boolean | undefined;
22 dryRun?: boolean | undefined;
23 } | {
24 labels: import("./release").ILabelDefinitionMap;
25 skipReleaseLabels: any;
26 command: string;
27 githubApi?: string | undefined;
28 plugins?: string[] | undefined;
29 owner?: string | undefined;
30 repo?: string | undefined;
31 verbose?: boolean | undefined;
32 veryVerbose?: boolean | undefined;
33 dryRun?: boolean | undefined;
34 } | {
35 labels: import("./release").ILabelDefinitionMap;
36 skipReleaseLabels: any;
37 command: string;
38 githubApi?: string | undefined;
39 plugins?: string[] | undefined;
40 owner?: string | undefined;
41 repo?: string | undefined;
42 verbose?: boolean | undefined;
43 veryVerbose?: boolean | undefined;
44 pr?: number | undefined;
45 } | {
46 labels: import("./release").ILabelDefinitionMap;
47 skipReleaseLabels: any;
48 command: string;
49 githubApi?: string | undefined;
50 plugins?: string[] | undefined;
51 owner?: string | undefined;
52 repo?: string | undefined;
53 verbose?: boolean | undefined;
54 veryVerbose?: boolean | undefined;
55 pr: number;
56 url?: string | undefined;
57 context?: string | undefined;
58 dryRun?: boolean | undefined;
59 } | {
60 labels: import("./release").ILabelDefinitionMap;
61 skipReleaseLabels: any;
62 command: string;
63 githubApi?: string | undefined;
64 plugins?: string[] | undefined;
65 owner?: string | undefined;
66 repo?: string | undefined;
67 verbose?: boolean | undefined;
68 veryVerbose?: boolean | undefined;
69 sha?: string | undefined;
70 pr?: number | undefined;
71 url: string;
72 state: "error" | "pending" | "success" | "failure";
73 description: string;
74 context: string;
75 dryRun?: boolean | undefined;
76 } | {
77 labels: import("./release").ILabelDefinitionMap;
78 skipReleaseLabels: any;
79 command: string;
80 githubApi?: string | undefined;
81 plugins?: string[] | undefined;
82 owner?: string | undefined;
83 repo?: string | undefined;
84 verbose?: boolean | undefined;
85 veryVerbose?: boolean | undefined;
86 pr: number;
87 message: string;
88 context?: string | undefined;
89 dryRun?: boolean | undefined;
90 } | {
91 labels: import("./release").ILabelDefinitionMap;
92 skipReleaseLabels: any;
93 command: string;
94 githubApi?: string | undefined;
95 plugins?: string[] | undefined;
96 owner?: string | undefined;
97 repo?: string | undefined;
98 verbose?: boolean | undefined;
99 veryVerbose?: boolean | undefined;
100 noVersionPrefix?: boolean | undefined;
101 jira?: string | undefined;
102 dryRun?: boolean | undefined;
103 useVersion?: string | undefined;
104 slack?: string | undefined;
105 name?: string | undefined;
106 email?: string | undefined;
107 } | {
108 labels: import("./release").ILabelDefinitionMap;
109 skipReleaseLabels: any;
110 command: string;
111 githubApi?: string | undefined;
112 plugins?: string[] | undefined;
113 owner?: string | undefined;
114 repo?: string | undefined;
115 verbose?: boolean | undefined;
116 veryVerbose?: boolean | undefined;
117 onlyPublishWithReleaseLabel?: boolean | undefined;
118 } | {
119 labels: import("./release").ILabelDefinitionMap;
120 skipReleaseLabels: any;
121 command: string;
122 githubApi?: string | undefined;
123 plugins?: string[] | undefined;
124 owner?: string | undefined;
125 repo?: string | undefined;
126 verbose?: boolean | undefined;
127 veryVerbose?: boolean | undefined;
128 dryRun?: boolean | undefined;
129 slack?: string | undefined;
130 }>;
131 /**
132 * Loads a config from a path, package name, or special `auto-config` pattern
133 *
134 * ex: auto-config-MY_CONFIG
135 * ex: @MY_CONFIG/auto-config
136 *
137 * @param extend Path or name of config to find
138 */
139 loadExtendConfig(extend: string): cosmiconfig.Config;
140}