UNPKG

7.8 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright Google LLC All Rights Reserved.
4 *
5 * Use of this source code is governed by an MIT-style license that can be
6 * found in the LICENSE file at https://angular.io/license
7 */
8/**
9 * This file was automatically generated by json-schema-to-typescript.
10 * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
11 * and run json-schema-to-typescript to regenerate this file.
12 */
13export declare type JsonSchemaForNpmPackageJsonFiles = CoreProperties & JspmDefinition & ({
14 bundleDependencies?: BundledDependency;
15 [k: string]: any;
16} | {
17 bundledDependencies?: BundledDependency;
18 [k: string]: any;
19}) & {
20 [k: string]: any;
21};
22/**
23 * A person who has been involved in creating or maintaining this package
24 */
25export declare type Person = {
26 [k: string]: any;
27} | string;
28/**
29 * Run AFTER the package is published
30 */
31export declare type ScriptsPublishAfter = string;
32/**
33 * Run AFTER the package is installed
34 */
35export declare type ScriptsInstallAfter = string;
36/**
37 * Run BEFORE the package is uninstalled
38 */
39export declare type ScriptsUninstallBefore = string;
40/**
41 * Run BEFORE bump the package version
42 */
43export declare type ScriptsVersionBefore = string;
44/**
45 * Run by the 'npm test' command
46 */
47export declare type ScriptsTest = string;
48/**
49 * Run by the 'npm stop' command
50 */
51export declare type ScriptsStop = string;
52/**
53 * Run by the 'npm start' command
54 */
55export declare type ScriptsStart = string;
56/**
57 * Run by the 'npm restart' command. Note: 'npm restart' will run the stop and start scripts if no restart script is provided.
58 */
59export declare type ScriptsRestart = string;
60/**
61 * Array of package names that will be bundled when publishing the package.
62 */
63export declare type BundledDependency = string[];
64export interface CoreProperties {
65 /**
66 * The name of the package.
67 */
68 name?: string;
69 /**
70 * Version must be parseable by node-semver, which is bundled with npm as a dependency.
71 */
72 version?: string;
73 /**
74 * This helps people discover your package, as it's listed in 'npm search'.
75 */
76 description?: string;
77 /**
78 * This helps people discover your package as it's listed in 'npm search'.
79 */
80 keywords?: string[];
81 /**
82 * The url to the project homepage.
83 */
84 homepage?: string;
85 /**
86 * The url to your project's issue tracker and / or the email address to which issues should be reported. These are helpful for people who encounter issues with your package.
87 */
88 bugs?: {
89 [k: string]: any;
90 } | string;
91 /**
92 * You should specify a license for your package so that people know how they are permitted to use it, and any restrictions you're placing on it.
93 */
94 license?: string;
95 /**
96 * You should specify a license for your package so that people know how they are permitted to use it, and any restrictions you're placing on it.
97 */
98 licenses?: {
99 type?: string;
100 url?: string;
101 [k: string]: any;
102 }[];
103 author?: Person;
104 /**
105 * A list of people who contributed to this package.
106 */
107 contributors?: Person[];
108 /**
109 * A list of people who maintains this package.
110 */
111 maintainers?: Person[];
112 /**
113 * The 'files' field is an array of files to include in your project. If you name a folder in the array, then it will also include the files inside that folder.
114 */
115 files?: string[];
116 /**
117 * The main field is a module ID that is the primary entry point to your program.
118 */
119 main?: string;
120 bin?: string | {
121 [k: string]: any;
122 };
123 /**
124 * Specify either a single file or an array of filenames to put in place for the man program to find.
125 */
126 man?: string[];
127 directories?: {
128 /**
129 * If you specify a 'bin' directory, then all the files in that folder will be used as the 'bin' hash.
130 */
131 bin?: string;
132 /**
133 * Put markdown files in here. Eventually, these will be displayed nicely, maybe, someday.
134 */
135 doc?: string;
136 /**
137 * Put example scripts in here. Someday, it might be exposed in some clever way.
138 */
139 example?: string;
140 /**
141 * Tell people where the bulk of your library is. Nothing special is done with the lib folder in any way, but it's useful meta info.
142 */
143 lib?: string;
144 /**
145 * A folder that is full of man pages. Sugar to generate a 'man' array by walking the folder.
146 */
147 man?: string;
148 test?: string;
149 [k: string]: any;
150 };
151 /**
152 * Specify the place where your code lives. This is helpful for people who want to contribute.
153 */
154 repository?: {
155 [k: string]: any;
156 } | string;
157 /**
158 * The 'scripts' member is an object hash of script commands that are run at various times in the lifecycle of your package. The key is the lifecycle event, and the value is the command to run at that point.
159 */
160 scripts?: {
161 /**
162 * Run BEFORE the package is published (Also run on local npm install without any arguments)
163 */
164 prepublish?: string;
165 publish?: ScriptsPublishAfter;
166 postpublish?: ScriptsPublishAfter;
167 /**
168 * Run BEFORE the package is installed
169 */
170 preinstall?: string;
171 install?: ScriptsInstallAfter;
172 postinstall?: ScriptsInstallAfter;
173 preuninstall?: ScriptsUninstallBefore;
174 uninstall?: ScriptsUninstallBefore;
175 /**
176 * Run AFTER the package is uninstalled
177 */
178 postuninstall?: string;
179 preversion?: ScriptsVersionBefore;
180 version?: ScriptsVersionBefore;
181 /**
182 * Run AFTER bump the package version
183 */
184 postversion?: string;
185 pretest?: ScriptsTest;
186 test?: ScriptsTest;
187 posttest?: ScriptsTest;
188 prestop?: ScriptsStop;
189 stop?: ScriptsStop;
190 poststop?: ScriptsStop;
191 prestart?: ScriptsStart;
192 start?: ScriptsStart;
193 poststart?: ScriptsStart;
194 prerestart?: ScriptsRestart;
195 restart?: ScriptsRestart;
196 postrestart?: ScriptsRestart;
197 [k: string]: string | undefined;
198 };
199 /**
200 * A 'config' hash can be used to set configuration parameters used in package scripts that persist across upgrades.
201 */
202 config?: {
203 [k: string]: any;
204 };
205 dependencies?: Dependency;
206 devDependencies?: Dependency;
207 optionalDependencies?: Dependency;
208 peerDependencies?: Dependency;
209 engines?: {
210 [k: string]: string;
211 };
212 engineStrict?: boolean;
213 /**
214 * You can specify which operating systems your module will run on
215 */
216 os?: string[];
217 /**
218 * If your code only runs on certain cpu architectures, you can specify which ones.
219 */
220 cpu?: string[];
221 /**
222 * If your package is primarily a command-line application that should be installed globally, then set this value to true to provide a warning if it is installed locally.
223 */
224 preferGlobal?: boolean;
225 /**
226 * If set to true, then npm will refuse to publish it.
227 */
228 private?: boolean;
229 publishConfig?: {
230 [k: string]: any;
231 };
232 dist?: {
233 shasum?: string;
234 tarball?: string;
235 [k: string]: any;
236 };
237 readme?: string;
238 [k: string]: any;
239}
240/**
241 * Dependencies are specified with a simple hash of package name to version range. The version range is a string which has one or more space-separated descriptors. Dependencies can also be identified with a tarball or git URL.
242 */
243export interface Dependency {
244 [k: string]: string;
245}
246export interface JspmDefinition {
247 jspm?: CoreProperties;
248 [k: string]: any;
249}