sendscript 1.0.2 → 1.0.3

package/CHANGELOG.md

@@ -4,8 +4,15 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v1.0.3](https://github.com/bas080/sendscript/compare/v1.0.2...v1.0.3)
+
+- Make examples import module not relative file [`0a5e1c8`](https://github.com/bas080/sendscript/commit/0a5e1c8ec2527d63d1e248f63568668058de388c)
+- Fix repository url in package.json [`d4f1e79`](https://github.com/bas080/sendscript/commit/d4f1e79a75daea28905c9b680b31e517526588d3)
+
 #### [v1.0.2](https://github.com/bas080/sendscript/compare/v1.0.1...v1.0.2)
 
+> 4 May 2025
+
 - Improve the typescript example [`6f75ed6`](https://github.com/bas080/sendscript/commit/6f75ed6a4b4db94217fde41ae50bc6b92a2cffda)
 - Move errors to own module [`90d69a3`](https://github.com/bas080/sendscript/commit/90d69a337f92518c8dd5c2ad47dd9b1add80d0c3)
 

package/README.md

@@ -33,7 +33,11 @@ needs.
 For this example we'll use [socket.io][socket.io].
 
 ```bash
-npm install --no-save socket.io socket.io-client
+npm link &&
+  npm install --no-save \
+    socket.io \
+    socket.io-client \
+    sendscript
 ```
 
 > We use the `--no-save` option because it's only for demonstration purposes.
@@ -57,7 +61,7 @@ Here a socket.io server that runs SendScript programs.
 // ./example/server.socket.io.mjs
 
 import { Server } from 'socket.io'
-import Parse from '../parse.mjs'
+import Parse from 'sendscript/parse.mjs'
 import * as math from './math.mjs'
 
 const parse = Parse(math)
@@ -87,8 +91,8 @@ Now for a client that sends a program to the server.
 // ./example/client.socket.io.mjs
 
 import socketClient from 'socket.io-client'
-import stringify from '../stringify.mjs'
-import module from '../module.mjs'
+import stringify from 'sendscript/stringify.mjs'
+import module from 'sendscript/module.mjs'
 import * as math from './math.mjs'
 import assert from 'node:assert'
 
@@ -218,12 +222,12 @@ send(square(add(1, 2)))
 We'll also generate the docs for this module.
 
 ```bash
+npm install --no-save \
+  typedoc \
+  typedoc-plugin-markdown
+
 typedoc --plugin typedoc-plugin-markdown --out ./example/typescript/docs ./example/typescript/math.ts
 ```
-```
-[info] Loaded plugin typedoc-plugin-markdown
-[info] markdown generated at ./example/typescript/docs
-```
 
 You can see the docs [here](./example/typescript/docs/globals.md)
 
@@ -242,11 +246,11 @@ npm t -- report text-summary
 ```
 ```
 
-> sendscript@1.0.2 test
+> sendscript@1.0.3 test
 > tap -R silent
 
 
-> sendscript@1.0.2 test
+> sendscript@1.0.3 test
 > tap report text-summary
 
 

package/README.mz

@@ -18,7 +18,11 @@ needs.
 For this example we'll use [socket.io][socket.io].
 
 ```bash bash > /dev/null
-npm install --no-save socket.io socket.io-client
+npm link &&
+  npm install --no-save \
+    socket.io \
+    socket.io-client \
+    sendscript
 ```
 
 > We use the `--no-save` option because it's only for demonstration purposes.
@@ -42,7 +46,7 @@ Here a socket.io server that runs SendScript programs.
 // ./example/server.socket.io.mjs
 
 import { Server } from 'socket.io'
-import Parse from '../parse.mjs'
+import Parse from 'sendscript/parse.mjs'
 import * as math from './math.mjs'
 
 const parse = Parse(math)
@@ -72,8 +76,8 @@ Now for a client that sends a program to the server.
 // ./example/client.socket.io.mjs
 
 import socketClient from 'socket.io-client'
-import stringify from '../stringify.mjs'
-import module from '../module.mjs'
+import stringify from 'sendscript/stringify.mjs'
+import module from 'sendscript/module.mjs'
 import * as math from './math.mjs'
 import assert from 'node:assert'
 
@@ -168,7 +172,11 @@ cat ./example/typescript/client.ts
 
 We'll also generate the docs for this module.
 
-```bash bash
+```bash bash 1>&2
+npm install --no-save \
+  typedoc \
+  typedoc-plugin-markdown
+
 typedoc --plugin typedoc-plugin-markdown --out ./example/typescript/docs ./example/typescript/math.ts
 ```
 

package/example/client.socket.io.mjs

@@ -1,8 +1,8 @@
 // ./example/client.socket.io.mjs
 
 import socketClient from 'socket.io-client'
-import stringify from '../stringify.mjs'
-import module from '../module.mjs'
+import stringify from 'sendscript/stringify.mjs'
+import module from 'sendscript/module.mjs'
 import * as math from './math.mjs'
 import assert from 'node:assert'
 

package/example/server.socket.io.mjs

@@ -1,7 +1,7 @@
 // ./example/server.socket.io.mjs
 
 import { Server } from 'socket.io'
-import Parse from '../parse.mjs'
+import Parse from 'sendscript/parse.mjs'
 import * as math from './math.mjs'
 
 const parse = Parse(math)

package/example/typescript/docs/README.md

@@ -22,7 +22,11 @@ needs.
 For this example we'll use [socket.io][socket.io].
 
 ```bash
-npm install --no-save socket.io socket.io-client
+npm link &&
+  npm install --no-save \
+    socket.io \
+    socket.io-client \
+    sendscript
 ```
 
 > We use the `--no-save` option because it's only for demonstration purposes.
@@ -46,7 +50,7 @@ Here a socket.io server that runs SendScript programs.
 // ./example/server.socket.io.mjs
 
 import { Server } from 'socket.io'
-import Parse from '../parse.mjs'
+import Parse from 'sendscript/parse.mjs'
 import * as math from './math.mjs'
 
 const parse = Parse(math)
@@ -76,8 +80,8 @@ Now for a client that sends a program to the server.
 // ./example/client.socket.io.mjs
 
 import socketClient from 'socket.io-client'
-import stringify from '../stringify.mjs'
-import module from '../module.mjs'
+import stringify from 'sendscript/stringify.mjs'
+import module from 'sendscript/module.mjs'
 import * as math from './math.mjs'
 import assert from 'node:assert'
 

package/example/typescript/docs/functions/add.md

@@ -8,7 +8,7 @@
 
 > **add**(`a`, `b`): `number`
 
-Defined in: [math.ts:1](https://github.com/bas080/sendscript/blob/6f75ed6a4b4db94217fde41ae50bc6b92a2cffda/example/typescript/math.ts#L1)
+Defined in: [math.ts:1](https://github.com/bas080/sendscript/blob/0a5e1c8ec2527d63d1e248f63568668058de388c/example/typescript/math.ts#L1)
 
 ## Parameters
 

package/example/typescript/docs/functions/square.md

@@ -8,7 +8,7 @@
 
 > **square**(`a`): `number`
 
-Defined in: [math.ts:2](https://github.com/bas080/sendscript/blob/6f75ed6a4b4db94217fde41ae50bc6b92a2cffda/example/typescript/math.ts#L2)
+Defined in: [math.ts:2](https://github.com/bas080/sendscript/blob/0a5e1c8ec2527d63d1e248f63568668058de388c/example/typescript/math.ts#L2)
 
 ## Parameters
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sendscript",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Blur the line between server and client code.",
   "module": true,
   "main": "index.mjs",
@@ -13,7 +13,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git@github.com:bas080/sendscript.git"
+    "url": "git+ssh://git@github.com/bas080/sendscript.git"
   },
   "scripts": {
     "test": "tap",