@mattpolzin/harmony 6.0.0 → 6.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +36 -25
  2. package/harmony +1733 -1686
  3. package/man/harmony.1 +24 -83
  4. package/package.json +1 -1
package/man/harmony.1 CHANGED
@@ -1,6 +1,6 @@
1
1
  .\" Automatically generated by Pandoc 3.7.0.2
2
2
  .\"
3
- .TH "harmony" "1" "" "Version 6.0.0" "Harmony User\(cqs Guide"
3
+ .TH "harmony" "1" "" "Version 6.1.1" "Harmony User\(cqs Guide"
4
4
  .SH NAME
5
5
  Harmony \- Harmonize with coworkers around GitHub reviewing
6
6
  .SH SYNOPSIS
@@ -96,8 +96,22 @@ Alternatively, you can build Harmony with Docker (see Docker Build).
96
96
  Tests can be run with \f[CR]make test\f[R].
97
97
  You\(cqll need a few common tools in your \f[CR]PATH\f[R] to run all the
98
98
  tests: \- \f[CR]realpath\f[R] \- \f[CR]sed\f[R] \- \f[CR]xargs\f[R]
99
- .SS Installation
100
- For any installation, you need to have a GitHub \c
99
+ .SS Bash completion
100
+ Set up Bash completion by adding the following to your Bash resource
101
+ file or profile:
102
+ .IP
103
+ .EX
104
+ eval \(dq$(harmony \-\-bash\-completion\-script)\(dq
105
+ .EE
106
+ .SS Zsh completion
107
+ Zsh completion is supported via \f[CR]bashcompinit\f[R] and can be
108
+ loaded by adding the following to your Zsh resource file or profile:
109
+ .IP
110
+ .EX
111
+ eval \(dq$(harmony \-\-zsh\-completion\-script)\(dq
112
+ .EE
113
+ .SS Initial configuration
114
+ For most things harmony does, you need to have a GitHub \c
101
115
  .UR https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token
102
116
  Personal Access Token
103
117
  .UE \c
@@ -118,80 +132,7 @@ The first time you start Harmony, it will ask you to configure your PAT
118
132
  if you don\(cqt want to use the Environment variable.
119
133
  You only need one of (a) the ENV var and (b) the config property and the
120
134
  environment variable will take precedence if you have both set.
121
- .SS NPM
122
- You can install Harmony via npm directly by running
123
- \f[CR]npm install \-g \(atmattpolzin/harmony\f[R].
124
- .SS GitHub Release
125
- You can install any Harmony release by downloading the
126
- \f[CR]harmony\-npm.tar.gz\f[R] file from the GitHub Release page,
127
- unzipping it, and running \f[CR]npm install \-\-global\f[R].
128
- .SS Nix Flake
129
- You can add Harmony to your Flake inputs as follows:
130
- .IP
131
- .EX
132
- inputs = {
133
- ...
134
- harmony.url = \(dqgithub:mattpolzin/harmony\(dq;
135
- harmony.inputs.nixpkgs.follows = \(dqnixpkgs\(dq;
136
- };
137
- .EE
138
135
  .PP
139
- Then, in your outputs, bring Harmony into a package install list as
140
- \f[CR]harmony.packages.<system>.harmony\f[R].
141
- .PP
142
- Harmony builds are cached in Cachix so you can take advantage of those
143
- builds by adding \f[CR]https://gh\-harmony.cachix.org\f[R] to the list
144
- of \f[CR]substituters\f[R] and
145
- \f[CR]gh\-harmony.cachix.org\-1:KX5tTtEt3Y6an8pywe3Cy6jR9bUo+1Cl7hJmh+5eI4I=\f[R]
146
- to the list of \f[CR]trusted\-public\-keys\f[R].
147
- .SS From Source
148
- The build script assumes a HEAD build of Idris 2 is installed on your
149
- system.
150
- For an alternative, see the Docker Build instructions below.
151
- .PP
152
- Build Harmony from source with a call to \f[CR]make\f[R].
153
- Then install it globally with \f[CR]make install\f[R].
154
- .SS Docker Build
155
- If you want to build Harmony without installing Idris 2 on your system,
156
- you can build Harmony within a Docker container and then install the
157
- resulting Javascript onto your system.
158
- .PP
159
- First, download the latest nightly Docker image:
160
- .IP
161
- .EX
162
- docker pull mattpolzin2/idris\-docker:nightly
163
- .EE
164
- .PP
165
- Then, from a directory containing this Harmony git repository, build
166
- Harmony:
167
- .IP
168
- .EX
169
- docker run \-\-rm \-v \(dq$(pwd):/build\(dq \(rs
170
- mattpolzin2/idris\-docker:nightly \(rs
171
- bash \-c \(dqapt\-get update && apt\-get install \-y git && cd /build && make\(dq
172
- .EE
173
- .PP
174
- At this point you are done with Docker.
175
- From the same directory, install Harmony globally:
176
- .IP
177
- .EX
178
- npm install \-\-global
179
- .EE
180
- .SS Bash completion
181
- Set up Bash completion by adding the following to your Bash resource
182
- file or profile:
183
- .IP
184
- .EX
185
- eval \(dq$(harmony \-\-bash\-completion\-script)\(dq
186
- .EE
187
- .SS Zsh completion
188
- Zsh completion is supported via \f[CR]bashcompinit\f[R] and can be
189
- loaded by adding the following to your Zsh resource file or profile:
190
- .IP
191
- .EX
192
- eval \(dq$(harmony \-\-zsh\-completion\-script)\(dq
193
- .EE
194
- .SS Usage
195
136
  The first time you start Harmony in any particular folder, you will be
196
137
  asked to provide some information about the GitHub repository you are
197
138
  working with.
@@ -227,13 +168,13 @@ Would you like harmony to comment when it requests reviewers? [Y/n]
227
168
  Would you like harmony to request team reviews in addition to individuals when it requests reviewers? [Y/n]
228
169
  Creating config...
229
170
  .EE
230
- .PP
231
- Once configured, Harmony supports the following commands:
232
- \f[CR]config\f[R], \f[CR]branch\f[R], \f[CR]pr\f[R], \f[CR]quick\f[R],
233
- \f[CR]label\f[R], \f[CR]request\f[R] (also aliased to \f[CR]rq\f[R]),
234
- \f[CR]contribute\f[R], \f[CR]whoami\f[R], \f[CR]reflect\f[R],
235
- \f[CR]list\f[R], \f[CR]graph\f[R], \f[CR]health\f[R], and
236
- \f[CR]sync\f[R].
171
+ .SS Usage
172
+ Once configured, Harmony supports the following commands that are
173
+ documented below: \f[CR]config\f[R], \f[CR]branch\f[R], \f[CR]pr\f[R],
174
+ \f[CR]quick\f[R], \f[CR]label\f[R], \f[CR]request\f[R] (also aliased to
175
+ \f[CR]rq\f[R]), \f[CR]contribute\f[R], \f[CR]whoami\f[R],
176
+ \f[CR]reflect\f[R], \f[CR]list\f[R], \f[CR]graph\f[R],
177
+ \f[CR]health\f[R], and \f[CR]sync\f[R].
237
178
  .PP
238
179
  \f[B]Note on color output:\f[R] Harmony uses colored output for some
239
180
  commands.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mattpolzin/harmony",
3
- "version": "6.0.0",
3
+ "version": "6.1.1",
4
4
  "engines": {
5
5
  "node": ">=18.0.0"
6
6
  },