-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
publish-config.ts
86 lines (76 loc) · 1.88 KB
/
publish-config.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
/**
* @file Interfaces - PublishConfig
* @module pkg-types/interfaces/PublishConfig
*/
import type { Access, Bin, Browser, Registry } from '#src/types'
import type { JsonObject } from '@flex-development/tutils'
/**
* Set of configuration values to use when a package is published.
*
* @see https://docs.npmjs.com/cli/v9/configuring-npm/package-json#publishconfig
* @see https://yarnpkg.com/configuration/manifest#publishConfig
*
* @extends {JsonObject}
*/
interface PublishConfig extends JsonObject {
/**
* Package access level.
*/
access?: Access
/**
* Replacement for top-level `bin` field.
*
* **Note**: Only modifies the manifest stored in the package tarball, not the
* real `package.json` file.
*
* @packageManager yarn
*/
bin?: Bin
/**
* Replacement for top-level `browser` field.
*
* **Note**: Only modifies the manifest stored in the package tarball, not the
* real `package.json` file.
*
* @packageManager yarn
*/
browser?: Browser
/**
* Additional files that must have the executable flag (`+x`) set even if they
* aren't directly accessible through the `bin` field.
*
* @packageManager yarn
*/
executableFiles?: string[]
/**
* Replacement for top-level `main` field.
*
* **Note**: Only modifies the manifest stored in the package tarball, not the
* real `package.json` file.
*
* @packageManager yarn
*/
main?: string
/**
* Replacement for top-level `module` field.
*
* **Note**: Only modifies the manifest stored in the package tarball, not the
* real `package.json` file.
*
* @packageManager yarn
*/
module?: string
/**
* Package registry URL.
*/
registry?: Registry
/**
* Distribution tag.
*
* @see https://docs.npmjs.com/cli/commands/npm-dist-tag
*
* @default 'latest'
*/
tag?: string
}
export type { PublishConfig as default }