Move examples to their own package (#1110)

EzraBrooks · web-flow · commit daaa81ab8252 · 2025-11-20T10:12:44.000-07:00
diff --git a/README.md b/README.md
@@ -6,3 +6,4 @@ See the READMEs of individual packages for more information.
 ## Packages
 
 - [roslibjs](./packages/roslib/README.md)
+- [roslibjs examples](./packages/roslib-examples/README.md)
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@robot-web-tools/workspace",
+  "//": "TODO: add a workspace name in the future once we have everything in a consistent namespace like @robot-web-tools/* on npm",
   "workspaces": [
     "packages/*"
   ]
diff --git a/packages/roslib-examples/README.md b/packages/roslib-examples/README.md
@@ -0,0 +1,5 @@
+# roslib-examples
+
+## Running the examples
+
+Run `npm start` to view the examples in your browser.
diff --git a/packages/roslib-examples/package.json b/packages/roslib-examples/package.json
@@ -0,0 +1,38 @@
+{
+  "name": "roslib-examples",
+  "version": "2.0.0",
+  "description": "Example usage of roslibjs",
+  "keywords": [
+    "ROS",
+    "ros",
+    "roslib",
+    "roslibjs",
+    "robot"
+  ],
+  "homepage": "https://github.com/RobotWebTools/roslibjs#readme",
+  "bugs": {
+    "url": "https://github.com/RobotWebTools/roslibjs/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/RobotWebTools/roslibjs.git"
+  },
+  "license": "BSD-2-Clause",
+  "author": "Robot Webtools Team <robot-web-tools@googlegroups.com> (https://robotwebtools.github.io)",
+  "contributors": [
+    {
+      "name": "Ezra Brooks",
+      "email": "ezra@brooks.cx",
+      "url": "https://github.com/EzraBrooks"
+    }
+  ],
+  "scripts": {
+    "start": "http-server .. -o /roslib-examples/src/index.html"
+  },
+  "devDependencies": {
+    "http-server": "^14.1.1"
+  },
+  "dependencies": {
+    "roslib": "^2.0.0"
+  }
+}
diff --git a/packages/roslib-examples/src/action_client.html b/packages/roslib-examples/src/action_client.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <meta charset="utf-8" />
-    <script src="../importmap.js"></script>
+    <script src="/roslib/importmap.js"></script>
 
     <script type="module">
       import * as ROSLIB from "roslib";
diff --git a/packages/roslib-examples/src/action_server.html b/packages/roslib-examples/src/action_server.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <meta charset="utf-8" />
-    <script src="../importmap.js"></script>
+    <script src="/roslib/importmap.js"></script>
 
     <script type="module">
       import * as ROSLIB from "roslib";
diff --git a/packages/roslib-examples/src/index.html b/packages/roslib-examples/src/index.html
diff --git a/packages/roslib-examples/src/math.html b/packages/roslib-examples/src/math.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <meta charset="utf-8" />
-    <script src="../importmap.js"></script>
+    <script src="/roslib/importmap.js"></script>
 
     <script type="module">
       import * as ROSLIB from "roslib";
diff --git a/packages/roslib-examples/src/node_simple.ts b/packages/roslib-examples/src/node_simple.ts
@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 // Connecting to ROS
-import * as ROSLIB from "../src/RosLib.ts";
+import * as ROSLIB from "roslib";
 
 const ros = new ROSLIB.Ros({
   url: "ws://localhost:9090",
diff --git a/packages/roslib-examples/src/ros2_action_client.html b/packages/roslib-examples/src/ros2_action_client.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <meta charset="utf-8" />
-    <script src="../importmap.js"></script>
+    <script src="/roslib/importmap.js"></script>
 
     <script type="module">
       import * as ROSLIB from "roslib";
diff --git a/packages/roslib-examples/src/ros2_action_server.html b/packages/roslib-examples/src/ros2_action_server.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <meta charset="utf-8" />
-    <script src="../importmap.js"></script>
+    <script src="/roslib/importmap.js"></script>
 
     <script type="module">
       import * as ROSLIB from "roslib";
diff --git a/packages/roslib-examples/src/ros2_simple.html b/packages/roslib-examples/src/ros2_simple.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <meta charset="utf-8" />
-    <script src="../importmap.js"></script>
+    <script src="/roslib/importmap.js"></script>
 
     <script type="module">
       import * as ROSLIB from "roslib";
diff --git a/packages/roslib-examples/src/simple.html b/packages/roslib-examples/src/simple.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <meta charset="utf-8" />
-    <script src="../importmap.js"></script>
+    <script src="/roslib/importmap.js"></script>
 
     <script type="module">
       import * as ROSLIB from "roslib";
diff --git a/packages/roslib-examples/src/tf.html b/packages/roslib-examples/src/tf.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <meta charset="utf-8" />
-    <script src="../importmap.js"></script>
+    <script src="/roslib/importmap.js"></script>
 
     <script type="module">
       import * as ROSLIB from "roslib";
diff --git a/packages/roslib-examples/src/urdf.html b/packages/roslib-examples/src/urdf.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <meta charset="utf-8" />
-    <script src="../importmap.js"></script>
+    <script src="/roslib/importmap.js"></script>
 
     <script type="module">
       /**
diff --git a/packages/roslib/README.md b/packages/roslib/README.md
@@ -30,7 +30,7 @@ npm install roslib
    });
    ```
 
-   Try running `npm run examples` for some complete examples!
+   Check out the `roslib-examples` package for some complete examples!
 
 2. Check that you have the websocket server is running on
    port 9090. Something like this should do:
diff --git a/packages/roslib/package.json b/packages/roslib/package.json
@@ -29,7 +29,6 @@
     "eslint-plugin-jsdoc": "^61.1.12",
     "eslint-plugin-prettier": "^5.5.4",
     "globals": "^16.0.0",
-    "http-server": "^14.1.1",
     "jiti": "^2.6.1",
     "jsdom": "^27.0.0",
     "jspm": "^4.2.0",
@@ -53,7 +52,6 @@
     "ws": "^8.0.0"
   },
   "directories": {
-    "example": "examples",
     "test": "test"
   },
   "engines": {
@@ -68,8 +66,7 @@
     "//": "The sed expression for eventemitter3 is because the package metadata is incorrect in EventEmitter3's package.json",
     "generate-importmap": "jspm install --release --provider unpkg && sed -i.bak 's;eventemitter3@5.0.1/index.mjs;eventemitter3@5.0.1/dist/eventemitter3.esm.js;' importmap.js && rm importmap.js.bak",
     "prepare": "npm run build && npm run generate-importmap",
-    "make-changelog": "changelog-maker RobotWebTools roslibjs --markdown | cat - CHANGELOG.md > NEW_CHANGELOG.md && mv NEW_CHANGELOG.md CHANGELOG.md",
-    "examples": "http-server . -o /examples/index.html"
+    "make-changelog": "changelog-maker RobotWebTools roslibjs --markdown | cat - CHANGELOG.md > NEW_CHANGELOG.md && mv NEW_CHANGELOG.md CHANGELOG.md"
   },
   "repository": {
     "type": "git",

Original file line number	Diff line number	Diff line change
`@@ -6,3 +6,4 @@ See the READMEs of individual packages for more information.`
`6`	`6`	`## Packages`
`7`	`7`
`8`	`8`	`- [roslibjs](./packages/roslib/README.md)`
	`9`	`+- [roslibjs examples](./packages/roslib-examples/README.md)`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "@robot-web-tools/workspace",`
	`2`	`+ "//": "TODO: add a workspace name in the future once we have everything in a consistent namespace like @robot-web-tools/* on npm",`
`3`	`3`	`"workspaces": [`
`4`	`4`	`"packages/*"`
`5`	`5`	`]`