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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
# libnpmteam
[![npm version](https://img.shields.io/npm/v/libnpmteam.svg)](https://npm.im/libnpmteam)
[![license](https://img.shields.io/npm/l/libnpmteam.svg)](https://npm.im/libnpmteam)
[![GitHub Actions](https://github.com/npm/libnpmteam/workflows/Node%20CI/badge.svg)](https://github.com/npm/libnpmteam/workflows/Node%20CI/badge.svg)
[![Coverage Status](https://coveralls.io/repos/github/npm/libnpmteam/badge.svg?branch=latest)](https://coveralls.io/github/npm/libnpmteam?branch=latest)
[`libnpmteam`](https://github.com/npm/libnpmteam) is a Node.js
library that provides programmatic access to the guts of the npm CLI's `npm
team` command and its various subcommands.
## Example
```javascript
const access = require('libnpmteam')
// List all teams for the @npm org.
console.log(await team.lsTeams('npm'))
```
## Publishing
1. Manually create CHANGELOG.md file
1. Commit changes to CHANGELOG.md
```bash
$ git commit -m "chore: updated CHANGELOG.md"
```
1. Run `npm version {newVersion}`
```bash
# Example
$ npm version patch
# 1. Runs `coverage` and `lint` scripts
# 2. Bumps package version; and **create commit/tag**
# 3. Runs `npm publish`; publishing directory with **unpushed commit**
# 4. Runs `git push origin --follow-tags`
```
## Table of Contents
* [Installing](#install)
* [Example](#example)
* [API](#api)
* [team opts](#opts)
* [`create()`](#create)
* [`destroy()`](#destroy)
* [`add()`](#add)
* [`rm()`](#rm)
* [`lsTeams()`](#ls-teams)
* [`lsTeams.stream()`](#ls-teams-stream)
* [`lsUsers()`](#ls-users)
* [`lsUsers.stream()`](#ls-users-stream)
### Install
`$ npm install libnpmteam`
### API
#### <a name="opts"></a> `opts` for `libnpmteam` commands
`libnpmteam` uses [`npm-registry-fetch`](https://npm.im/npm-registry-fetch).
All options are passed through directly to that library, so please refer to [its
own `opts`
documentation](https://www.npmjs.com/package/npm-registry-fetch#fetch-options)
for options that can be passed in.
A couple of options of note for those in a hurry:
* `opts.token` - can be passed in and will be used as the authentication token for the registry. For other ways to pass in auth details, see the n-r-f docs.
* `opts.otp` - certain operations will require an OTP token to be passed in. If a `libnpmteam` command fails with `err.code === EOTP`, please retry the request with `{otp: <2fa token>}`
#### <a name="create"></a> `> team.create(team, [opts]) -> Promise`
Creates a team named `team`. Team names use the format `@<scope>:<name>`, with
the `@` being optional.
Additionally, `opts.description` may be passed in to include a description.
##### Example
```javascript
await team.create('@npm:cli', {token: 'myregistrytoken'})
// The @npm:cli team now exists.
```
#### <a name="destroy"></a> `> team.destroy(team, [opts]) -> Promise`
Destroys a team named `team`. Team names use the format `@<scope>:<name>`, with
the `@` being optional.
##### Example
```javascript
await team.destroy('@npm:cli', {token: 'myregistrytoken'})
// The @npm:cli team has been destroyed.
```
#### <a name="add"></a> `> team.add(user, team, [opts]) -> Promise`
Adds `user` to `team`.
##### Example
```javascript
await team.add('zkat', '@npm:cli', {token: 'myregistrytoken'})
// @zkat now belongs to the @npm:cli team.
```
#### <a name="rm"></a> `> team.rm(user, team, [opts]) -> Promise`
Removes `user` from `team`.
##### Example
```javascript
await team.rm('zkat', '@npm:cli', {token: 'myregistrytoken'})
// @zkat is no longer part of the @npm:cli team.
```
#### <a name="ls-teams"></a> `> team.lsTeams(scope, [opts]) -> Promise`
Resolves to an array of team names belonging to `scope`.
##### Example
```javascript
await team.lsTeams('@npm', {token: 'myregistrytoken'})
=>
[
'npm:cli',
'npm:web',
'npm:registry',
'npm:developers'
]
```
#### <a name="ls-teams-stream"></a> `> team.lsTeams.stream(scope, [opts]) -> Stream`
Returns a stream of teams belonging to `scope`.
For a Promise-based version of these results, see [`team.lsTeams()`](#ls-teams).
##### Example
```javascript
for await (let team of team.lsTeams.stream('@npm', {token: 'myregistrytoken'})) {
console.log(team)
}
// outputs
// npm:cli
// npm:web
// npm:registry
// npm:developers
```
#### <a name="ls-users"></a> `> team.lsUsers(team, [opts]) -> Promise`
Resolves to an array of usernames belonging to `team`.
For a streamed version of these results, see [`team.lsUsers.stream()`](#ls-users-stream).
##### Example
```javascript
await team.lsUsers('@npm:cli', {token: 'myregistrytoken'})
=>
[
'iarna',
'zkat'
]
```
#### <a name="ls-users-stream"></a> `> team.lsUsers.stream(team, [opts]) -> Stream`
Returns a stream of usernames belonging to `team`.
For a Promise-based version of these results, see [`team.lsUsers()`](#ls-users).
##### Example
```javascript
for await (let user of team.lsUsers.stream('@npm:cli', {token: 'myregistrytoken'})) {
console.log(user)
}
// outputs
// iarna
// zkat
```
|