updating tutorial files (denoland#845)

Co-authored-by: Marvin Hagemeister <[email protected]>
dandv · Sep 17, 2024 · da64ba0 · da64ba0
1 parent 1a80726
commit da64ba0
Show file tree

Hide file tree

Showing 52 changed files with 141 additions and 255 deletions.
diff --git a/_config.ts b/_config.ts
@@ -81,6 +81,7 @@ site.copy("runtime/tutorials/images");
 site.copy("deploy/manual/images");
 site.copy("deno.json");
 site.copy("go.json");
+site.copy("oldurls.json");
 site.copy("server.ts");
 site.copy("middleware.ts");
 site.copy("examples");

diff --git a/examples/command-line-arguments.ts b/examples/command-line-arguments.ts
@@ -1,5 +1,5 @@
 /**
- * @title Command Line Arguments
+ * @title Command line arguments
  * @difficulty beginner
  * @tags cli
  * @run <url> Deno Sushi --help --version=1.0.0 --no-color

diff --git a/examples/create-remove-directories.ts b/examples/create-remove-directories.ts
@@ -1,5 +1,5 @@
 /**
- * @title Creating & Removing Directories
+ * @title Creating & removing directories
  * @difficulty beginner
  * @tags cli
  * @run --allow-write <url>

diff --git a/examples/deleting-files.ts b/examples/deleting-files.ts
@@ -1,5 +1,5 @@
 /**
- * @title Deleting Files
+ * @title Deleting files
  * @difficulty beginner
  * @tags cli
  * @resource {https://docs.deno.com/api/deno/~/Deno.remove} Doc: Deno.remove

diff --git a/examples/dependency-management.ts b/examples/dependency-management.ts
diff --git a/examples/dns-queries.ts b/examples/dns-queries.ts
@@ -1,5 +1,5 @@
 /**
- * @title Running DNS Queries
+ * @title Running DNS queries
  * @difficulty beginner
  * @tags cli, deploy
  * @run --allow-net <url>

diff --git a/examples/environment-variables.ts b/examples/environment-variables.ts
@@ -1,5 +1,5 @@
 /**
- * @title Environment Variables
+ * @title Environment variables
  * @difficulty beginner
  * @tags cli, deploy
  * @run --allow-env <url>

diff --git a/examples/hello-world.ts b/examples/hello-world.ts
@@ -1,5 +1,5 @@
 /**
- * @title Hello World
+ * @title Hello world
  * @difficulty beginner
  * @tags cli, deploy, web
  * @run <url>

diff --git a/examples/hex-base64-encoding.ts b/examples/hex-base64-encoding.ts
@@ -1,5 +1,5 @@
 /**
- * @title Hex and Base64 Encoding
+ * @title Hex and base64 encoding
  * @difficulty beginner
  * @tags cli
  * @run <url>

diff --git a/examples/http-requests.ts b/examples/http-requests.ts
@@ -1,5 +1,5 @@
 /**
- * @title HTTP Requests
+ * @title HTTP requests
  * @difficulty beginner
  * @tags cli, deploy, web
  * @run --allow-net <url>

diff --git a/examples/http-server-files.ts b/examples/http-server-files.ts
@@ -1,5 +1,5 @@
 /**
- * @title HTTP Server: Serving Files
+ * @title HTTP server: Serving files
  * @difficulty intermediate
  * @tags cli, deploy
  * @run --allow-net --allow-read <url>

diff --git a/examples/http-server-routing.ts b/examples/http-server-routing.ts
@@ -1,5 +1,5 @@
 /**
- * @title HTTP Server: Routing
+ * @title HTTP server: Routing
  * @difficulty intermediate
  * @tags cli, deploy
  * @run --allow-net <url>

diff --git a/examples/http-server-streaming.ts b/examples/http-server-streaming.ts
@@ -1,5 +1,5 @@
 /**
- * @title HTTP Server: Streaming
+ * @title HTTP server: Streaming
  * @difficulty intermediate
  * @tags cli, deploy
  * @run --allow-net <url>

diff --git a/examples/http-server-websocket.ts b/examples/http-server-websocket.ts
@@ -1,5 +1,5 @@
 /**
- * @title HTTP Server: WebSockets
+ * @title HTTP server: WebSockets
  * @difficulty intermediate
  * @tags cli, deploy
  * @run --allow-net <url>

diff --git a/examples/http-server.ts b/examples/http-server.ts
@@ -1,5 +1,5 @@
 /**
- * @title HTTP Server: Hello World
+ * @title HTTP Server: Hello world
  * @difficulty intermediate
  * @tags cli, deploy
  * @run --allow-net <url>

diff --git a/examples/import-export.ts b/examples/import-export.ts
@@ -1,5 +1,5 @@
 /**
- * @title Importing & Exporting
+ * @title Importing & exporting
  * @difficulty beginner
  * @tags cli, deploy
  * @resource {/examples/dependency-management} Example: Dependency Management

diff --git a/examples/kv-watch.ts b/examples/kv-watch.ts
@@ -1,5 +1,5 @@
 /**
- * @title Deno KV Watch
+ * @title Deno KV watch
  * @difficulty intermediate
  * @tags cli, deploy
  * @run --unstable-kv <url>

diff --git a/examples/kv.ts b/examples/kv.ts
@@ -1,5 +1,5 @@
 /**
- * @title Deno KV: Key/Value Database
+ * @title Deno KV: Key/Value database
  * @difficulty intermediate
  * @tags cli, deploy
  * @run --unstable-kv <url>

diff --git a/examples/moving-renaming-files.ts b/examples/moving-renaming-files.ts
@@ -1,5 +1,5 @@
 /**
- * @title Moving/Renaming Files
+ * @title Moving/Renaming files
  * @difficulty beginner
  * @tags cli
  * @run --allow-read=./ --allow-write=./ <url>

diff --git a/examples/os-signals.ts b/examples/os-signals.ts
@@ -1,5 +1,5 @@
 /**
- * @title Handling OS Signals
+ * @title Handling OS signals
  * @difficulty beginner
  * @tags cli
  * @run <url>

diff --git a/examples/permissions.ts b/examples/permissions.ts
@@ -1,5 +1,5 @@
 /**
- * @title Permission Management
+ * @title Permission management
  * @difficulty beginner
  * @tags cli
  * @run <url>

diff --git a/examples/pid.ts b/examples/pid.ts
@@ -1,5 +1,5 @@
 /**
- * @title Process Information
+ * @title Process information
  * @difficulty beginner
  * @tags cli
  * @run <url>

diff --git a/examples/piping-streams.ts b/examples/piping-streams.ts
@@ -1,5 +1,5 @@
 /**
- * @title Piping Streams
+ * @title Piping streams
  * @difficulty intermediate
  * @tags cli
  * @run --allow-net --allow-read --allow-write <url>

diff --git a/examples/prompts.ts b/examples/prompts.ts
@@ -1,5 +1,5 @@
 /**
- * @title Input Prompts
+ * @title Input prompts
  * @difficulty beginner
  * @tags cli, web
  * @run <url>

diff --git a/examples/queues.ts b/examples/queues.ts
@@ -1,5 +1,5 @@
 /**
- * @title Deno Queues
+ * @title Deno queues
  * @difficulty intermediate
  * @tags cli, deploy
  * @run --unstable-kv <url>

diff --git a/examples/reading-files.ts b/examples/reading-files.ts
@@ -1,5 +1,5 @@
 /**
- * @title Reading Files
+ * @title Reading files
  * @difficulty beginner
  * @tags cli, deploy
  * @run --allow-read <url>

diff --git a/examples/streaming-files.ts b/examples/streaming-files.ts
@@ -1,5 +1,5 @@
 /**
- * @title Streaming File Operations
+ * @title Streaming file operations
  * @difficulty intermediate
  * @tags cli
  * @run --allow-read --allow-write <url>

diff --git a/examples/subprocesses-output.ts b/examples/subprocesses-output.ts
@@ -1,5 +1,5 @@
 /**
- * @title Subprocesses: Collecting Output
+ * @title Subprocesses: Collecting output
  * @difficulty intermediate
  * @tags cli
  * @run --allow-run <url>

diff --git a/examples/symlinks.ts b/examples/symlinks.ts
@@ -1,5 +1,5 @@
 /**
- * @title Creating & Resolving Symlinks
+ * @title Creating & resolving symlinks
  * @difficulty beginner
  * @tags cli
  * @run --allow-write --allow-read <url>

diff --git a/examples/tcp-connector.ts b/examples/tcp-connector.ts
@@ -1,5 +1,5 @@
 /**
- * @title TCP Connector: Ping
+ * @title TCP connector: Ping
  * @difficulty intermediate
  * @tags cli
  * @run --allow-net <url>

diff --git a/examples/tcp-listener.ts b/examples/tcp-listener.ts
@@ -1,5 +1,5 @@
 /**
- * @title TCP Listener: Ping
+ * @title TCP listener: Ping
  * @difficulty intermediate
  * @tags cli
  * @run --allow-net <url>

diff --git a/examples/temporary-files.ts b/examples/temporary-files.ts
@@ -1,5 +1,5 @@
 /**
- * @title Temporary Files & Directories
+ * @title Temporary files & directories
  * @difficulty beginner
  * @tags cli
  * @run --allow-read --allow-write <url>

diff --git a/examples/timers.ts b/examples/timers.ts
@@ -1,5 +1,5 @@
 /**
- * @title Timeouts & Intervals
+ * @title Timeouts & intervals
  * @difficulty beginner
  * @tags cli, deploy, web
  * @run <url>

diff --git a/examples/tls-connector.ts b/examples/tls-connector.ts
@@ -1,5 +1,5 @@
 /**
- * @title TCP/TLS Connector: Ping
+ * @title TCP/TLS connector: Ping
  * @difficulty intermediate
  * @tags cli
  * @run --allow-net --allow-read <url>

diff --git a/examples/tls-listener.ts b/examples/tls-listener.ts
@@ -1,5 +1,5 @@
 /**
- * @title TCP/TLS Listener: Ping
+ * @title TCP/TLS listener: Ping
  * @difficulty intermediate
  * @tags cli
  * @run --allow-net --allow-read <url>

diff --git a/examples/udp-connector.ts b/examples/udp-connector.ts
@@ -1,5 +1,5 @@
 /**
- * @title UDP Connector: Ping
+ * @title UDP connector: Ping
  * @difficulty intermediate
  * @tags cli
  * @run --allow-net --unstable-net <url>

diff --git a/examples/udp-listener.ts b/examples/udp-listener.ts
@@ -1,5 +1,5 @@
 /**
- * @title UDP Listener: Ping
+ * @title UDP listener: Ping
  * @difficulty intermediate
  * @tags cli
  * @run --allow-net --unstable-net <url>

diff --git a/examples/unix-cat.ts b/examples/unix-cat.ts
@@ -0,0 +1,19 @@
+/**
+ * @title Unix cat
+ * @difficulty beginner
+ * @tags cli
+ * @run --allow-read cat.ts file1 file2
+ * @resource {https://docs.deno.com/api/deno/~/Deno.args} Deno args API docs
+ * @resource {https://docs.deno.com/api/deno/~/Deno.open} Deno open API docs
+ * @resource {https://docs.deno.com/api/deno/~/Deno.stdout} Deno stdout API docs
+ * @resource {https://docs.deno.com/api/deno/~/Deno.FsFile#property_readable} Deno File System API docs
+ * @group File System
+ *
+ * In Unix, the `cat` command is a utility that reads files and writes them to standard output. You can use Deno to mimic the behavior of the `cat` command. <br><br> In this program each command-line argument is assumed to be a filename, the file is opened, and printed to stdout (e.g. the console).
+ */
+
+// Create a script that reads the contents of one or more files and writes them to standard output.
+for (const filename of Deno.args) {
+  const file = await Deno.open(filename);
+  await file.readable.pipeTo(Deno.stdout.writable, { preventClose: true });
+}
diff --git a/examples/url-parsing.ts b/examples/url-parsing.ts
@@ -1,5 +1,5 @@
 /**
- * @title Manipulating & Parsing URLs
+ * @title Manipulating & parsing URLs
  * @difficulty beginner
  * @tags cli, deploy, web
  * @run <url>

diff --git a/examples/uuids.ts b/examples/uuids.ts
@@ -1,5 +1,5 @@
 /**
- * @title Generating & Validating UUIDs
+ * @title Generating & validating UUIDs
  * @difficulty beginner
  * @tags cli, deploy, web
  * @run <url>

diff --git a/examples/web-workers.ts b/examples/web-workers.ts
@@ -1,5 +1,5 @@
 /**
- * @title Web Workers
+ * @title Web workers
  * @difficulty intermediate
  * @tags cli, web
  * @resource {https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers} MDN: Web Workers

diff --git a/examples/webassembly.ts b/examples/webassembly.ts
@@ -1,5 +1,5 @@
 /**
- * @title Web Assembly
+ * @title Web assembly
  * @difficulty intermediate
  * @tags cli, deploy, web
  * @run <url>

diff --git a/examples/writing-files.ts b/examples/writing-files.ts
@@ -1,5 +1,5 @@
 /**
- * @title Writing Files
+ * @title Writing files
  * @difficulty beginner
  * @tags cli
  * @run --allow-read --allow-write <url>

diff --git a/examples/writing-tests.ts b/examples/writing-tests.ts
@@ -1,5 +1,5 @@
 /**
- * @title Writing Tests
+ * @title Writing tests
  * @difficulty beginner
  * @tags cli
  * @run deno test --allow-read --allow-write <url>

diff --git a/oldurls.json b/oldurls.json
@@ -0,0 +1,5 @@
+{
+  "/runtime/manual/examples/read_write_files/": "/examples/",
+  "/runtime/tutorials/unix_cat/": "/examples/unix-cat/",
+  "/examples/dependency-management/": "/runtime/fundamentals/configuration/#dependencies"
+}
diff --git a/runtime/_data.ts b/runtime/_data.ts
@@ -212,14 +212,15 @@ export const sidebar = [
       "/runtime/tutorials/init_project/",
       "/runtime/tutorials/fetch_data/",
       "/runtime/tutorials/http_server/",
-      "/runtime/tutorials/read_write_files/",
+      "/examples/reading-files/",
+      "/examples/writing-files/",
       "/runtime/tutorials/hashbang/",
       "/runtime/tutorials/cjs_to_esm/",
       "/runtime/tutorials/connecting_to_databases/",
       {
         label: "Advanced Examples",
         items: [
-          "/runtime/tutorials/unix_cat/",
+          "/examples/unix-cat/",
           "/runtime/tutorials/file_server/",
           "/runtime/tutorials/tcp_echo/",
           "/runtime/tutorials/subprocess/",

diff --git a/runtime/reference/cli/bundler.md b/runtime/reference/cli/bundler.md
@@ -15,7 +15,7 @@ Use [deno_emit](https://github.com/denoland/deno_emit),
 Deno, which includes all dependencies of the specified input. For example:
 
 ```bash
-deno bundle https://deno.land/[email protected]/examples/colors.tsts colors.bundle.js
+$ deno bundle https://deno.land/[email protected]/examples/colors.tsts colors.bundle.js
 Bundle https://deno.land/[email protected]/examples/colors.ts
 Download https://deno.land/[email protected]/examples/colors.ts
 Download https://deno.land/[email protected]/fmt/colors.ts