Skip to content
This repository has been archived by the owner on Mar 4, 2022. It is now read-only.

Misc updates: global require, Ctrl-c + SIGINT #105

Merged
merged 2 commits into from
Nov 22, 2019
Merged

Misc updates: global require, Ctrl-c + SIGINT #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cab13ac
Add nodejs-dashboard to global NODE_PATH. Add SIGINT
ryan-roemer Nov 21, 2019
4b5957a
Update changelog.
ryan-roemer Nov 21, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Change log

## UNRELEASED

- **Fixed**: Support global installs of `nodejs-dashboard`. Add the `node_modules` directory from wherever `nodejs-dashboard` is installed to `NODE_PATH` to support `node -r nodejs-dashboard` required for full usage. [\#90]
- *Internal*: Use SIGINT for Ctrl-c. [\#93]

## [v0.5.0] - 2019-11-21

- **Breaking**: Update node engines to `8`+
Expand Down Expand Up @@ -57,6 +62,7 @@
- *Internal*: Remove dependency on root-require, update repo url in package.json [\#2]
- *Internal*: Test scaffolding and basic reporter integration test [\#3]

[v0.5.0]: https://github.com/FormidableLabs/nodejs-dashboard/compare/v0.4.3...v0.5.0
[v0.4.3]: https://github.com/FormidableLabs/nodejs-dashboard/compare/v0.4.1...v0.4.3
[v0.4.1]: https://github.com/FormidableLabs/nodejs-dashboard/compare/v0.4.0...v0.4.1
[v0.4.0]: https://github.com/FormidableLabs/nodejs-dashboard/compare/v0.3.0...v0.4.0
Expand All @@ -66,6 +72,8 @@
[v0.1.2]: https://github.com/FormidableLabs/nodejs-dashboard/compare/v0.1.1...v0.1.2
[v0.1.1]: https://github.com/FormidableLabs/nodejs-dashboard/compare/v0.1.0...v0.1.1

[\#93]: https://github.com/FormidableLabs/nodejs-dashboard/pull/93
[\#90]: https://github.com/FormidableLabs/nodejs-dashboard/issues/90
[\#76]: https://github.com/FormidableLabs/nodejs-dashboard/pull/76
[\#68]: https://github.com/FormidableLabs/nodejs-dashboard/pull/72
[\#67]: https://github.com/FormidableLabs/nodejs-dashboard/pull/70
Expand Down
16 changes: 15 additions & 1 deletion bin/nodejs-dashboard.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,23 @@ process.env[config.PORT_KEY] = port;
process.env[config.REFRESH_INTERVAL_KEY] = program.refreshinterval;
process.env[config.BLOCKED_THRESHOLD_KEY] = program.eventdelay;

// Enhance `NODE_PATH` to include the dashboard such that `require("nodejs-dashboard")`
// works even if globally installed.
// See: https://github.com/FormidableLabs/nodejs-dashboard/issues/90
const IS_WIN = process.platform.indexOf("win") === 0;
const DELIM = IS_WIN ? ";" : ":";
const DASHBOARD_PATH = path.resolve(__dirname, "../..");
const NODE_PATH = (process.env.NODE_PATH || "")
.split(DELIM)
.filter(Boolean)
.concat(DASHBOARD_PATH)
.join(DELIM);

const child = spawn(command, args, {
env: process.env,
env: {
...process.env,
NODE_PATH
},
stdio: [null, null, null, null],
detached: true
});
Expand Down
2 changes: 1 addition & 1 deletion lib/dashboard.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Dashboard.prototype._configureKeys = function () {
// this key will be watched on the global screen
this.screen.ignoreLocked = ["C-c"];
this.screen.key("C-c", () => {
process.exit(0); // eslint-disable-line no-process-exit
process.kill(process.pid, "SIGINT");
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep this looks right! The only thing we did different in webpack-dashboard was listen for "escape" and "q" as valid keys to trigger sending SIGINT. We could consider doing that here as well.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea! Added #106 to allow some discussion first.

});

// watch for key events on the main container; not the screen
Expand Down