This repository has been archived by the owner on Jul 13, 2020. It is now read-only.
/
PackageJson.ts
146 lines (105 loc) · 2.57 KB
/
PackageJson.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/*
* Copyright © 2019 Atomist, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Typed representation of a package.json file
*/
export interface PackageJson {
name: string;
version: string;
description?: string;
keywords?: string[];
homepage?: string;
bugs?: string | Bugs;
license?: string;
author?: string | Author;
readonly contributors?: string[] | Author[];
readonly files?: string[];
readonly main?: string;
readonly bin?: string | BinMap;
readonly man?: string | string[];
readonly directories?: Directories;
repository?: string | Repository;
readonly scripts?: ScriptsMap;
readonly config?: Config;
readonly dependencies?: DependencyMap;
readonly devDependencies?: DependencyMap;
readonly peerDependencies?: DependencyMap;
readonly optionalDependencies?: DependencyMap;
readonly bundledDependencies?: string[];
readonly engines?: Engines;
readonly os?: string[];
readonly cpu?: string[];
readonly preferGlobal?: boolean;
readonly private?: boolean;
readonly publishConfig?: PublishConfig;
}
/**
* An author or contributor
*/
export interface Author {
name: string;
email?: string;
homepage?: string;
}
/**
* A map of exposed bin commands
*/
export interface BinMap {
[commandName: string]: string;
}
/**
* A bugs link
*/
export interface Bugs {
email?: string;
url: string;
}
export interface Config {
name?: string;
config?: any;
}
/**
* A map of dependencies
*/
export interface DependencyMap {
[dependencyName: string]: string;
/* note: index types */
}
/**
* CommonJS package structure
*/
export interface Directories {
lib?: string;
bin?: string;
man?: string;
doc?: string;
example?: string;
}
export interface Engines {
node?: string;
npm?: string;
}
export interface PublishConfig {
registry?: string;
}
/**
* A project repository
*/
export interface Repository {
type: string;
url: string;
}
export type ScriptsMap = Record<string, string>;