midi-shell-commands 1.0.0 → 1.1.2

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 (51) hide show
  1. package/.github/workflows/release.yml +54 -0
  2. package/.github/workflows/verify-pr.yml +37 -0
  3. package/.nvmrc +1 -0
  4. package/.releaserc.json +20 -0
  5. package/README.md +20 -2
  6. package/coverage/base.css +224 -0
  7. package/coverage/block-navigation.js +87 -0
  8. package/coverage/clover.xml +343 -0
  9. package/coverage/coverage-final.json +16 -0
  10. package/coverage/favicon.png +0 -0
  11. package/coverage/index.html +131 -0
  12. package/coverage/midi-shell-commands/index.html +116 -0
  13. package/coverage/midi-shell-commands/lib/check-inputs.js.html +112 -0
  14. package/coverage/midi-shell-commands/lib/clean-up-inputs.js.html +112 -0
  15. package/coverage/midi-shell-commands/lib/clean-up-watcher.js.html +115 -0
  16. package/coverage/midi-shell-commands/lib/escape-path.js.html +106 -0
  17. package/coverage/midi-shell-commands/lib/index.html +311 -0
  18. package/coverage/midi-shell-commands/lib/initialize-midi.js.html +112 -0
  19. package/coverage/midi-shell-commands/lib/initialize-scripts-directory.js.html +196 -0
  20. package/coverage/midi-shell-commands/lib/invoke-scripts.js.html +139 -0
  21. package/coverage/midi-shell-commands/lib/listen-to-input.js.html +118 -0
  22. package/coverage/midi-shell-commands/lib/log.js.html +94 -0
  23. package/coverage/midi-shell-commands/lib/map-message-to-file-names.js.html +106 -0
  24. package/coverage/midi-shell-commands/lib/post-install.js.html +490 -0
  25. package/coverage/midi-shell-commands/lib/refresh-scripts.js.html +124 -0
  26. package/coverage/midi-shell-commands/lib/report-errors.js.html +100 -0
  27. package/coverage/midi-shell-commands/lib/state.js.html +106 -0
  28. package/coverage/midi-shell-commands/midi-shell-commands.js.html +106 -0
  29. package/coverage/prettify.css +1 -0
  30. package/coverage/prettify.js +2 -0
  31. package/coverage/sort-arrow-sprite.png +0 -0
  32. package/coverage/sorter.js +210 -0
  33. package/eslint.config.js +12 -0
  34. package/lib/check-inputs.js +9 -0
  35. package/lib/clean-up-inputs.js +9 -0
  36. package/lib/clean-up-watcher.js +10 -0
  37. package/lib/escape-path.js +7 -0
  38. package/lib/initialize-midi.js +9 -0
  39. package/lib/initialize-scripts-directory.js +37 -0
  40. package/lib/invoke-scripts.js +18 -0
  41. package/lib/listen-to-input.js +11 -0
  42. package/lib/log.js +3 -0
  43. package/lib/map-message-to-file-names.js +7 -0
  44. package/lib/post-install.js +135 -0
  45. package/lib/refresh-scripts.js +13 -0
  46. package/lib/report-errors.js +5 -0
  47. package/lib/state.js +7 -0
  48. package/midi-shell-commands.js +8 -0
  49. package/package.json +29 -9
  50. package/renovate.json +26 -0
  51. package/index.js +0 -67
@@ -0,0 +1,54 @@
1
+ name: Release
2
+
3
+ on:
4
+ merge_group:
5
+ branches:
6
+ - main
7
+ push:
8
+ branches:
9
+ - main
10
+ workflow_dispatch:
11
+
12
+ # Needed for semantic-release to create GitHub releases and publish to npm via OIDC
13
+ permissions:
14
+ contents: write
15
+ issues: write
16
+ pull-requests: write
17
+ id-token: write
18
+
19
+ concurrency:
20
+ group: Release
21
+ cancel-in-progress: false
22
+
23
+ jobs:
24
+ release:
25
+ name: Semantic Release
26
+ environment: Release
27
+ # Ensure releases run only when code reaches main via GitHub Merge Queue, or when manually dispatched
28
+ runs-on: ubuntu-latest
29
+ steps:
30
+ - name: Checkout
31
+ uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
32
+ with:
33
+ fetch-depth: 0
34
+ - name: Setup Node.js
35
+ uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
36
+ with:
37
+ node-version-file: '.nvmrc'
38
+ cache: npm
39
+ registry-url: 'https://registry.npmjs.org'
40
+ - name: Update npm
41
+ run: npm install -g npm@latest
42
+ - name: Install dependencies
43
+ run: npm ci
44
+ - name: Run ESLint
45
+ run: npm run lint
46
+ - name: Run unit tests
47
+ run: npm run test:ci
48
+ - name: Semantic Release
49
+ if: ${{ github.event_name == 'push' }}
50
+ uses: cycjimmy/semantic-release-action@9cc899c47e6841430bbaedb43de1560a568dfd16 # v5.0.0
51
+ env:
52
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
53
+ NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
54
+ NPM_CONFIG_PROVENANCE: true
@@ -0,0 +1,37 @@
1
+ name: Verify PR
2
+
3
+ on:
4
+ pull_request:
5
+
6
+ jobs:
7
+ lint:
8
+ name: Lint
9
+ runs-on: ubuntu-latest
10
+ steps:
11
+ - name: Checkout
12
+ uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
13
+ - name: Setup Node.js
14
+ uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
15
+ with:
16
+ node-version-file: '.nvmrc'
17
+ cache: npm
18
+ - name: Install dependencies
19
+ run: npm ci
20
+ - name: Run ESLint
21
+ run: npm run lint
22
+
23
+ test:
24
+ name: Test
25
+ runs-on: ubuntu-latest
26
+ steps:
27
+ - name: Checkout
28
+ uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
29
+ - name: Setup Node.js
30
+ uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
31
+ with:
32
+ node-version-file: '.nvmrc'
33
+ cache: npm
34
+ - name: Install dependencies
35
+ run: npm ci
36
+ - name: Run unit tests
37
+ run: npm run test:ci
package/.nvmrc ADDED
@@ -0,0 +1 @@
1
+ 24.9.0
@@ -0,0 +1,20 @@
1
+ {
2
+ "branches": [
3
+ "main"
4
+ ],
5
+ "plugins": [
6
+ "@semantic-release/commit-analyzer",
7
+ "@semantic-release/release-notes-generator",
8
+ "@semantic-release/npm",
9
+ [
10
+ "@semantic-release/git",
11
+ {
12
+ "assets": [
13
+ "package.json",
14
+ "package-lock.json"
15
+ ]
16
+ }
17
+ ],
18
+ "@semantic-release/github"
19
+ ]
20
+ }
package/README.md CHANGED
@@ -46,6 +46,9 @@ The application periodically checks for new MIDI input devices and will start li
46
46
 
47
47
  chmod +x ./scripts/*.sh
48
48
 
49
+ On macOS, a LaunchAgent will be installed on npm install that automatically runs this tool in the background watching
50
+ `~/Documents/MidiShellCommands` at login. See Daemon mode below.
51
+
49
52
  ## Usage
50
53
 
51
54
  You can run the tool in a few ways:
@@ -64,7 +67,7 @@ You can run the tool in a few ways:
64
67
 
65
68
  - Or directly with Node, specifying the path to your scripts directory:
66
69
 
67
- node index.js ./scripts
70
+ node midi-shell-commands.js ./scripts
68
71
 
69
72
  Replace `./scripts` with the path to your own directory containing executable scripts.
70
73
 
@@ -95,6 +98,21 @@ Make it executable:
95
98
  chmod +x scripts/noteon.60.sh
96
99
  ```
97
100
 
101
+ ## Daemon mode (macOS)
102
+
103
+ - On macOS, when you run `npm install` for this package, it will:
104
+ - Create the directory `~/Documents/MidiShellCommands` if it does not exist.
105
+ - Install a LaunchAgent at `~/Library/LaunchAgents/com.midi-shell-commands.plist` that starts `midi-shell-commands` at login, watching
106
+ that directory.
107
+ - Attempt to load the LaunchAgent immediately so it begins running right away.
108
+ - Logs can be found at `~/Library/Logs/midi-shell-commands.stdout.log` and `~/Library/Logs/midi-shell-commands.stderr.log`.
109
+ - To manage the LaunchAgent manually:
110
+ - Reload:
111
+ `launchctl unload ~/Library/LaunchAgents/com.midi-shell-commands.plist && launchctl load -w ~/Library/LaunchAgents/com.midi-shell-commands.plist`
112
+ - Disable autostart: `launchctl unload -w ~/Library/LaunchAgents/com.midi-shell-commands.plist`
113
+ - Remove: delete the plist file and unload it.
114
+ - If you run `midi-shell-commands` with no arguments, it will also default to watching `~/Documents/MidiShellCommands`.
115
+
98
116
  ## Notes and behavior
99
117
 
100
118
  - Only non-hidden files in the scripts directory are considered (files not starting with a dot).
@@ -118,7 +136,7 @@ chmod +x scripts/noteon.60.sh
118
136
 
119
137
  ## Development
120
138
 
121
- - Main entry: `index.js`
139
+ - Main entry: `midi-shell-commands.js`
122
140
  - Dependencies: `easymidi`
123
141
  - Helpful npm scripts:
124
142
  - `npm start` — starts the watcher using `./scripts` as the scripts directory.
@@ -0,0 +1,224 @@
1
+ body, html {
2
+ margin:0; padding: 0;
3
+ height: 100%;
4
+ }
5
+ body {
6
+ font-family: Helvetica Neue, Helvetica, Arial;
7
+ font-size: 14px;
8
+ color:#333;
9
+ }
10
+ .small { font-size: 12px; }
11
+ *, *:after, *:before {
12
+ -webkit-box-sizing:border-box;
13
+ -moz-box-sizing:border-box;
14
+ box-sizing:border-box;
15
+ }
16
+ h1 { font-size: 20px; margin: 0;}
17
+ h2 { font-size: 14px; }
18
+ pre {
19
+ font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
20
+ margin: 0;
21
+ padding: 0;
22
+ -moz-tab-size: 2;
23
+ -o-tab-size: 2;
24
+ tab-size: 2;
25
+ }
26
+ a { color:#0074D9; text-decoration:none; }
27
+ a:hover { text-decoration:underline; }
28
+ .strong { font-weight: bold; }
29
+ .space-top1 { padding: 10px 0 0 0; }
30
+ .pad2y { padding: 20px 0; }
31
+ .pad1y { padding: 10px 0; }
32
+ .pad2x { padding: 0 20px; }
33
+ .pad2 { padding: 20px; }
34
+ .pad1 { padding: 10px; }
35
+ .space-left2 { padding-left:55px; }
36
+ .space-right2 { padding-right:20px; }
37
+ .center { text-align:center; }
38
+ .clearfix { display:block; }
39
+ .clearfix:after {
40
+ content:'';
41
+ display:block;
42
+ height:0;
43
+ clear:both;
44
+ visibility:hidden;
45
+ }
46
+ .fl { float: left; }
47
+ @media only screen and (max-width:640px) {
48
+ .col3 { width:100%; max-width:100%; }
49
+ .hide-mobile { display:none!important; }
50
+ }
51
+
52
+ .quiet {
53
+ color: #7f7f7f;
54
+ color: rgba(0,0,0,0.5);
55
+ }
56
+ .quiet a { opacity: 0.7; }
57
+
58
+ .fraction {
59
+ font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
60
+ font-size: 10px;
61
+ color: #555;
62
+ background: #E8E8E8;
63
+ padding: 4px 5px;
64
+ border-radius: 3px;
65
+ vertical-align: middle;
66
+ }
67
+
68
+ div.path a:link, div.path a:visited { color: #333; }
69
+ table.coverage {
70
+ border-collapse: collapse;
71
+ margin: 10px 0 0 0;
72
+ padding: 0;
73
+ }
74
+
75
+ table.coverage td {
76
+ margin: 0;
77
+ padding: 0;
78
+ vertical-align: top;
79
+ }
80
+ table.coverage td.line-count {
81
+ text-align: right;
82
+ padding: 0 5px 0 20px;
83
+ }
84
+ table.coverage td.line-coverage {
85
+ text-align: right;
86
+ padding-right: 10px;
87
+ min-width:20px;
88
+ }
89
+
90
+ table.coverage td span.cline-any {
91
+ display: inline-block;
92
+ padding: 0 5px;
93
+ width: 100%;
94
+ }
95
+ .missing-if-branch {
96
+ display: inline-block;
97
+ margin-right: 5px;
98
+ border-radius: 3px;
99
+ position: relative;
100
+ padding: 0 4px;
101
+ background: #333;
102
+ color: yellow;
103
+ }
104
+
105
+ .skip-if-branch {
106
+ display: none;
107
+ margin-right: 10px;
108
+ position: relative;
109
+ padding: 0 4px;
110
+ background: #ccc;
111
+ color: white;
112
+ }
113
+ .missing-if-branch .typ, .skip-if-branch .typ {
114
+ color: inherit !important;
115
+ }
116
+ .coverage-summary {
117
+ border-collapse: collapse;
118
+ width: 100%;
119
+ }
120
+ .coverage-summary tr { border-bottom: 1px solid #bbb; }
121
+ .keyline-all { border: 1px solid #ddd; }
122
+ .coverage-summary td, .coverage-summary th { padding: 10px; }
123
+ .coverage-summary tbody { border: 1px solid #bbb; }
124
+ .coverage-summary td { border-right: 1px solid #bbb; }
125
+ .coverage-summary td:last-child { border-right: none; }
126
+ .coverage-summary th {
127
+ text-align: left;
128
+ font-weight: normal;
129
+ white-space: nowrap;
130
+ }
131
+ .coverage-summary th.file { border-right: none !important; }
132
+ .coverage-summary th.pct { }
133
+ .coverage-summary th.pic,
134
+ .coverage-summary th.abs,
135
+ .coverage-summary td.pct,
136
+ .coverage-summary td.abs { text-align: right; }
137
+ .coverage-summary td.file { white-space: nowrap; }
138
+ .coverage-summary td.pic { min-width: 120px !important; }
139
+ .coverage-summary tfoot td { }
140
+
141
+ .coverage-summary .sorter {
142
+ height: 10px;
143
+ width: 7px;
144
+ display: inline-block;
145
+ margin-left: 0.5em;
146
+ background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
147
+ }
148
+ .coverage-summary .sorted .sorter {
149
+ background-position: 0 -20px;
150
+ }
151
+ .coverage-summary .sorted-desc .sorter {
152
+ background-position: 0 -10px;
153
+ }
154
+ .status-line { height: 10px; }
155
+ /* yellow */
156
+ .cbranch-no { background: yellow !important; color: #111; }
157
+ /* dark red */
158
+ .red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
159
+ .low .chart { border:1px solid #C21F39 }
160
+ .highlighted,
161
+ .highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
162
+ background: #C21F39 !important;
163
+ }
164
+ /* medium red */
165
+ .cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
166
+ /* light red */
167
+ .low, .cline-no { background:#FCE1E5 }
168
+ /* light green */
169
+ .high, .cline-yes { background:rgb(230,245,208) }
170
+ /* medium green */
171
+ .cstat-yes { background:rgb(161,215,106) }
172
+ /* dark green */
173
+ .status-line.high, .high .cover-fill { background:rgb(77,146,33) }
174
+ .high .chart { border:1px solid rgb(77,146,33) }
175
+ /* dark yellow (gold) */
176
+ .status-line.medium, .medium .cover-fill { background: #f9cd0b; }
177
+ .medium .chart { border:1px solid #f9cd0b; }
178
+ /* light yellow */
179
+ .medium { background: #fff4c2; }
180
+
181
+ .cstat-skip { background: #ddd; color: #111; }
182
+ .fstat-skip { background: #ddd; color: #111 !important; }
183
+ .cbranch-skip { background: #ddd !important; color: #111; }
184
+
185
+ span.cline-neutral { background: #eaeaea; }
186
+
187
+ .coverage-summary td.empty {
188
+ opacity: .5;
189
+ padding-top: 4px;
190
+ padding-bottom: 4px;
191
+ line-height: 1;
192
+ color: #888;
193
+ }
194
+
195
+ .cover-fill, .cover-empty {
196
+ display:inline-block;
197
+ height: 12px;
198
+ }
199
+ .chart {
200
+ line-height: 0;
201
+ }
202
+ .cover-empty {
203
+ background: white;
204
+ }
205
+ .cover-full {
206
+ border-right: none !important;
207
+ }
208
+ pre.prettyprint {
209
+ border: none !important;
210
+ padding: 0 !important;
211
+ margin: 0 !important;
212
+ }
213
+ .com { color: #999 !important; }
214
+ .ignore-none { color: #999; font-weight: normal; }
215
+
216
+ .wrapper {
217
+ min-height: 100%;
218
+ height: auto !important;
219
+ height: 100%;
220
+ margin: 0 auto -48px;
221
+ }
222
+ .footer, .push {
223
+ height: 48px;
224
+ }
@@ -0,0 +1,87 @@
1
+ /* eslint-disable */
2
+ var jumpToCode = (function init() {
3
+ // Classes of code we would like to highlight in the file view
4
+ var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
5
+
6
+ // Elements to highlight in the file listing view
7
+ var fileListingElements = ['td.pct.low'];
8
+
9
+ // We don't want to select elements that are direct descendants of another match
10
+ var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
11
+
12
+ // Selector that finds elements on the page to which we can jump
13
+ var selector =
14
+ fileListingElements.join(', ') +
15
+ ', ' +
16
+ notSelector +
17
+ missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
18
+
19
+ // The NodeList of matching elements
20
+ var missingCoverageElements = document.querySelectorAll(selector);
21
+
22
+ var currentIndex;
23
+
24
+ function toggleClass(index) {
25
+ missingCoverageElements
26
+ .item(currentIndex)
27
+ .classList.remove('highlighted');
28
+ missingCoverageElements.item(index).classList.add('highlighted');
29
+ }
30
+
31
+ function makeCurrent(index) {
32
+ toggleClass(index);
33
+ currentIndex = index;
34
+ missingCoverageElements.item(index).scrollIntoView({
35
+ behavior: 'smooth',
36
+ block: 'center',
37
+ inline: 'center'
38
+ });
39
+ }
40
+
41
+ function goToPrevious() {
42
+ var nextIndex = 0;
43
+ if (typeof currentIndex !== 'number' || currentIndex === 0) {
44
+ nextIndex = missingCoverageElements.length - 1;
45
+ } else if (missingCoverageElements.length > 1) {
46
+ nextIndex = currentIndex - 1;
47
+ }
48
+
49
+ makeCurrent(nextIndex);
50
+ }
51
+
52
+ function goToNext() {
53
+ var nextIndex = 0;
54
+
55
+ if (
56
+ typeof currentIndex === 'number' &&
57
+ currentIndex < missingCoverageElements.length - 1
58
+ ) {
59
+ nextIndex = currentIndex + 1;
60
+ }
61
+
62
+ makeCurrent(nextIndex);
63
+ }
64
+
65
+ return function jump(event) {
66
+ if (
67
+ document.getElementById('fileSearch') === document.activeElement &&
68
+ document.activeElement != null
69
+ ) {
70
+ // if we're currently focused on the search input, we don't want to navigate
71
+ return;
72
+ }
73
+
74
+ switch (event.which) {
75
+ case 78: // n
76
+ case 74: // j
77
+ goToNext();
78
+ break;
79
+ case 66: // b
80
+ case 75: // k
81
+ case 80: // p
82
+ goToPrevious();
83
+ break;
84
+ }
85
+ };
86
+ })();
87
+ window.addEventListener('keydown', jumpToCode);