Skip to content
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.

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

docs(website/manual): Manual introduction improvements #3157

Merged
merged 13 commits into from
Oct 21, 2019
119 changes: 59 additions & 60 deletions website/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,89 +2,88 @@

[toc]

## Disclaimer

A word of caution: Deno is very much under development. We encourage brave early
adopters, but expect bugs large and small. The API is subject to change without
notice. [Bug reports](https://github.com/denoland/deno/issues) do help!

## Introduction

A secure JavaScript/TypeScript runtime built with V8, Rust, and Tokio
# Deno Manual

### Philosophy
[toc]
andyfleming marked this conversation as resolved.
Show resolved Hide resolved

Deno aims to be a productive and secure scripting environment for the modern
programmer.
## Project Status / Disclaimer
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Calling this "Project Status" makes it a little friendlier.


Deno will always be distributed as a single executable. Given a URL to a Deno
program, it is runnable with nothing more than
[the 10 megabyte zipped executable](https://github.com/denoland/deno/releases).
Deno explicitly takes on the role of both runtime and package manager. It uses a
standard browser-compatible protocol for loading modules: URLs.
**A word of caution: Deno is very much under development.**

Deno provides security guarantees about how programs can access your system with
the default being the most restrictive secure sandbox.
We encourage brave early adopters, but expect bugs large and small. The API is subject to change without
notice. [Bug reports](https://github.com/denoland/deno/issues) do help!

Deno provides <a href="https://github.com/denoland/deno/tree/master/std">a set
of reviewed (audited) standard modules</a> that are guaranteed to work with
Deno.
We are [actively working towards 1.0](https://github.com/denoland/deno/issues/2473), but there is no date guarantee.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adds a link for those who want to follow the latest on 1.0.


### Goals
## Introduction

- Support TypeScript out of the box.
Deno is a JavaScript/TypeScript runtime with secure defaults and a great developer experience.

- Uses "ES Modules" and does not support `require()`. Like the browser, allows
imports from URLs:
It's built on V8, Rust, and Tokio.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it's a little weird to call it a "secure runtime". "Secure defaults" feels more accurate and to the point. It also leaves less room for argument.

I also added that it has a "great developer experience". I don't think this has historically been a first-class goal, but I think it's in alignment with the project and is part of where we provide value.

I also purposely separated the note about what it's built on. It's somewhat relevant, but it's not the purpose of the project.


```ts
import * as log from "https://deno.land/std/log/mod.ts";
```
### Feature Highlights

- Remote code is fetched and cached on first execution, and never updated until
the code is run with the `--reload` flag. (So, this will still work on an
airplane. See `~/.deno/src` for details on the cache.)
* Secure by default. No file, network, or environment access (unless explicitly enabled).
* Supports TypeScript out of the box.
* Ships a single executable (`deno`).
* Has built in utilities like a dependency inspector (`deno info`) and a code formatter (`deno fmt`).
* Has [a set of reviewed (audited) standard modules](https://github.com/denoland/deno/tree/master/std) that are guaranteed to work with Deno.
* Scripts can be bundled into a single javascript file.

- File system and network access can be controlled in order to run sandboxed
code. Access between V8 (unprivileged) and Rust (privileged) is only done via
serialized messages. This makes it easy to audit. For example, to enable write
access use the flag `--allow-write` or for network access `--allow-net`.
##### On the Roadmap

- Only ship a single executable.
* Native modules in Rust.
* Scripts can be bundled into a binary with the deno runtime.
* This makes distribution simple and script startup very fast.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I created a new section called "Feature Highlights" which helps clean up some of the items in the goal section that weren't really goals per se.

I also think this is an important spot to pitch newcomers on our key features.

I added "Native modules in Rust" because I believe that's a goal and it's 🔥.

I added "Scripts can be bundled into a binary with the deno runtime" because it's also a feature we are pursuing and is a great differentiator.


- Always dies on uncaught errors.
### Philosophy

- Browser compatible: The subset of Deno programs which are written completely
in JavaScript and do not use the global `Deno` namespace (or feature test for
it), ought to also be able to be run in a modern web browser without change.
Deno aims to be a productive and secure scripting environment for the modern programmer.

- [Aims to support top-level `await`.](https://github.com/denoland/deno/issues/471)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Forgot to mention that I purposely deleted this since it's (most likely) going to be standard in javascript anyway.

Deno will always be distributed as a single executable. Given a URL to a Deno program, it is runnable with nothing more than [the 10 megabyte zipped executable](https://github.com/denoland/deno/releases). Deno explicitly takes on the role of both runtime and package manager. It uses a standard browser-compatible protocol for loading modules: URLs.

- Be able to serve HTTP efficiently.
([Currently it is relatively slow.](https://deno.land/benchmarks.html#req-per-sec))
Among other things, Deno is a great replacement for utility scripts that may have been historically written with bash or python.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added this note about utility scripts. It's something that we discussed in person and I think really helps the reader understand where Deno could be really useful.


<!-- prettier-ignore-start -->
<!-- see https://github.com/prettier/prettier/issues/3679 -->
### Goals

- Provide useful tooling out of the box:
- dependency inspector (`deno info`)
- code formatter (`deno fmt`),
- bundling (`deno bundle`)
- runtime type info (`deno types`)
- test runner (`deno test`)
- command-line debugger (`--debug`)
[not yet](https://github.com/denoland/deno/issues/1120)
- linter (`deno lint`) [not yet](https://github.com/denoland/deno/issues/1880)
1. Only ship a single executable (`deno`).
2. Provide Secure Defaults
* Unless specifically allowed, scripts can't access files, the environment, or the network.
3. Browser compatible: The subset of Deno programs which are written completely in JavaScript and do not use the global `Deno` namespace (or feature test for it), ought to also be able to be run in a modern web browser without change.
4. Be able to serve HTTP efficiently
5. Provide a great developer experience include built-in tooling.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is clean up a bit.

6. Does not leak browser or V8 concepts into user land.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This goal is new, but I thought it was worth discussing.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

#3158 is related in that sense.


### Comparison to Node.js

* Deno does not use `npm`
* It uses modules referenced as URLs or file paths
* Deno does not use a `package.json`
* This is a non-goal. There are effective patterns [citation needed] for managing dependencies.
* Deno provides different APIs than node.
* Deno requires explicit permissions for file, network, and environment access.
* Node is less secure out of the box.
* Deno always dies on uncaught errors.
* Uses "ES Modules" and does not support `require()`. Like the browser, allows imports from URLs:

<!-- prettier-ignore-end -->
```ts
import * as log from "https://deno.land/std/log/mod.ts";
```
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we dance around this too much. I know we may not want to compare directly to node in some ways, but the reality is that just about everyone who comes to this project will ask about this. Let's address it as clearly and concisely as possible.


### Non-goals
### Other key behaviors

- No `package.json`.
* Remote code is fetched and cached on first execution, and never updated until the code is run with the `--reload` flag. (So, this will still work on an airplane. See `~/.deno/src` for details on the cache.)
* Modules/files loaded from remote URLs are intended to be immutable and cacheable.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure if this is the right home for these points, but I didn't want to delete them.

I also added the note about immutable intention which @kitsonk and I talked about a bit. It's an opinionated proposal, but worth discussing.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also mentioned this in #3158


- No npm.
## Built-in Deno Utilities / Commands

- Not explicitly compatible with Node.
* dependency inspector (`deno info`)
* code formatter (`deno fmt`),
* bundling (`deno bundle`)
* runtime type info (`deno types`)
* test runner (`deno test`)
* command-line debugger (`--debug`) [coming soon](https://github.com/denoland/deno/issues/1120)
* linter (`deno lint`) [coming soon](https://github.com/denoland/deno/issues/1880)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This section was split out from above so the above contents can be more concise.


## Setup

Expand Down