Skip to content

Externalize EventEmitter3 dependency #688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
EzraBrooks merged 9 commits into from
Mar 20, 2024
Merged

Externalize EventEmitter3 dependency #688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
69ee2bb
Remove all remaining Grunt tasks in favor of Vite configs
EzraBrooks Feb 20, 2024
05dea17
Externalize EventEmitter3 dependency
EzraBrooks Feb 20, 2024
46ccd90
Merge branch 'develop' into externalize-eventemitter3-dependency
MatthijsBurgh Feb 21, 2024
6494b8a
Merge branch 'develop' into externalize-eventemitter3-dependency
EzraBrooks Mar 18, 2024
3a85db9
Add test that ROSLIB is accessible globally from importing the UMD bu…
EzraBrooks Mar 18, 2024
c3c0374
Merge branch 'develop' into externalize-eventemitter3-dependency
EzraBrooks Mar 20, 2024
1a9c5bd
add test for EventEmitter's presence
EzraBrooks Mar 20, 2024
6f52736
Fix examples
EzraBrooks Mar 20, 2024
9920e14
fix typo
EzraBrooks Mar 20, 2024
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
1 change: 1 addition & 0 deletions examples/action_client.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
<html>
<head>
<meta charset="utf-8" />
<script src="https://unpkg.com/eventemitter3@latest/dist/eventemitter3.umd.min.js"></script>
<script src="../dist/RosLib.umd.cjs"></script>

<script>
Expand Down
1 change: 1 addition & 0 deletions examples/action_server.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
<html>
<head>
<meta charset="utf-8" />
<script src="https://unpkg.com/eventemitter3@latest/dist/eventemitter3.umd.min.js"></script>
<script src="../dist/RosLib.umd.cjs"></script>

<script>
Expand Down
1 change: 1 addition & 0 deletions examples/math.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
<html>
<head>
<meta charset="utf-8" />
<script src="https://unpkg.com/eventemitter3@latest/dist/eventemitter3.umd.min.js"></script>
<script src="../dist/RosLib.umd.cjs"></script>

<script>
Expand Down
1 change: 1 addition & 0 deletions examples/ros2_action_client.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
<html>
<head>
<meta charset="utf-8" />
<script src="https://unpkg.com/eventemitter3@latest/dist/eventemitter3.umd.min.js"></script>
<script src="../dist/RosLib.umd.cjs"></script>

<script>
Expand Down
1 change: 1 addition & 0 deletions examples/ros2_action_server.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
<html>
<head>
<meta charset="utf-8" />
<script src="https://unpkg.com/eventemitter3@latest/dist/eventemitter3.umd.min.js"></script>
<script src="../dist/RosLib.umd.cjs"></script>

<script>
Expand Down
1 change: 1 addition & 0 deletions examples/ros2_simple.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
<html>
<head>
<meta charset="utf-8" />
<script src="https://unpkg.com/eventemitter3@latest/dist/eventemitter3.umd.min.js"></script>
<script src="../dist/RosLib.umd.cjs"></script>

<script>
Expand Down
1 change: 1 addition & 0 deletions examples/simple.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
<html>
<head>
<meta charset="utf-8" />
<script src="https://unpkg.com/eventemitter3@latest/dist/eventemitter3.umd.min.js"></script>
<script src="../dist/RosLib.umd.cjs"></script>

<script>
Expand Down
3 changes: 2 additions & 1 deletion examples/tf.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
<html>
<head>
<meta charset="utf-8" />
<script src="../build/roslib.js"></script>
<script src="https://unpkg.com/eventemitter3@latest/dist/eventemitter3.umd.min.js"></script>
<script src="../dist/RosLib.umd.cjs"></script>

<script>
// Connecting to ROS
Expand Down
3 changes: 2 additions & 1 deletion examples/urdf.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
<html>
<head>
<meta charset="utf-8" />
<script src="../build/roslib.js"></script>
<script src="https://unpkg.com/eventemitter3@latest/dist/eventemitter3.umd.min.js"></script>
<script src="../dist/RosLib.umd.cjs"></script>

<script>
/**
Expand Down
14 changes: 14 additions & 0 deletions test/cdn-import.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import { describe, it, expect } from 'vitest';
import '../dist/RosLib.umd.cjs';
import { readFileSync } from 'fs';
import path from 'path';

describe('Using as if imported from a CDN', () => {
it('Adds itself to the global namespace', () => {
expect(globalThis.ROSLIB).toBeTruthy();
})
it('Does not include EventEmitter in the bundle', () => {
// Read the bundled output of the file, check for `.on=function`, which is a reliable way to detect `EventEmitter.on` being defined.
expect(readFileSync(path.resolve(__dirname, '../dist/RosLib.umd.cjs')).includes('.on=function')).toBeFalsy();
})
});
5 changes: 4 additions & 1 deletion vite.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,10 @@ export default defineConfig({
rollupOptions: {
// make sure to externalize deps that shouldn't be bundled
// into your library
external: ['ws', 'src/util/decompressPng.js'],
external: ['eventemitter3', 'ws', 'src/util/decompressPng.js'],
output: {
globals: { eventemitter3: 'EventEmitter3' }
}
},
},
test: {
Expand Down