Skip to content
master
Go to file
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Trex πŸ¦•

Package management for deno (pronounced "tee rex")

GitHub issues GitHub forks GitHub stars GitHub license

Use Trex

About

Trex is a package management tool for deno similar to npm but keeping close to the deno philosophy. Packages are cached and only one import_map.json file is generated.

// import_map.json

{
  "imports":  {
    "http/":  "https://deno.land/std/http/"
  }
}

For more information about the import maps in deno see import maps.

Additional topics

Installation

Install from the nest.land module registry (explicit version is required):

deno install -A --unstable -n trex https://x.nest.land/Trex@<version>/cli.ts

note: Works with deno >= 1.2.0.

Or from deno.land:

deno install -A --unstable -n trex https://deno.land/x/trex/cli.ts

Trex imports

This is a version that does not use import maps as a central hub, it can be used to handle dependencies for libraries and packages. you can see the documentation here

deno install -A --unstable -n trex https://denopkg.com/crewdevio/Trex@imports/cli.ts

note: if you try to install this version with the name trex it will replace the current version, if you want to have both versions you can use another name in the installation -n [otherName]

we shorten the install command so it's not that long

The permissions that Trex uses are:

  • --allow-net
  • --allow-read
  • --allow-write
  • --allow-run
  • --allow-env

You can give those permissions explicitly.

Updating Trex

Install new version with the -f flag:

deno install -f -A --unstable -n trex https://deno.land/x/trex/cli.ts

Or use the upgrade command:

trex upgrade

Note: available for versions 0.2.0 or higher.

Verify the installation of Trex:

trex --version

and the console should print the Trex version.

For help on the commands that Trex provides, use:

trex --help

For a better implementation of this tool you can use the Commands utility.

Usage

Installing from deno.land

Install the fs, http and fmt modules from std:

trex install --map fs http fmt

note: you can use trex i --map fs http fmt

--map installs packages from the standard library and those hosted at deno.land/x

Installing from nest.land

Install a package hosted on nest.land:

trex install --nest opine@0.13.0

note: if you want to install a package using nest.land you must specify a version explicitly as above

You can install packages from std hosted in nest.land by specifying the package and the version:

trex install --nest fs@0.61.0

Installing from a repository

trex install --pkg [user]/[repo or repo@tag/branch]/[path/to/file] [packageName]

Example:

trex install --pkg oakserver/oak@main/mod.ts oak

note: In the event that the repository uses a branch other than master as the main branch, this must be specified

The above downloads oak directly from its repository.

Example import map

All installation methods produce an import_map.json file:

{
  "imports": {
    "fs/": "https://deno.land/std/fs/",
    "http/": "https://deno.land/std/http/",
    "fmt/": "https://deno.land/std/fmt/"
  }
}

Downloading packages

Download all the packages listed in the import_map.json similar to npm install:

trex install

Adding custom packages

Install a package from a custom URL source:

trex --custom React=https://dev.jspm.io/react/index.js

import_map.json:

{
  "imports": {
    "http/": "https://deno.land/std/http/",
    "fmt/": "https://deno.land/std/fmt/",
    "oak": "https://deno.land/x/oak/mod.ts",
    "React": "https://dev.jspm.io/react/index.js"
  }
}

Deleting packages

trex delete React

Remove a specific version from the cache and the import_map.json file:

trex delete fs@0.52.0

import_map.json:

{
  "imports": {
    "fs/": "https://deno.land/std/fs/",
    "http/": "https://deno.land/std/http/",
    "fmt/": "https://deno.land/std/fmt/",
    "oak": "https://deno.land/x/oak/mod.ts"
  }
}

Removing from cache only works with standard packages and those installed from deno.land/x

Selecting a specific version of a package

Specify a package's version:

trex install --map fs@0.54.0

import_map.json

{
  "imports": {
    "fs/": "https://deno.land/std@0.54.0/fs/"
  }
}

note: can be used with third party packages.

Run Scripts (experimental)

now you can create command aliases similar to npm run, you just have to create a run.json file with the following structure:

// example
{
  "scripts": {
    "welcome": "deno run https://deno.land/std@0.71.0/examples/welcome.ts"
  }
}

note: to run command aliases you must use the command trex run <aliases>

now you can call a command within another or call a deno script like denopack or eggs within a command alias

// example
{
  "scripts": {
    "start": "trex run welcome",
    "welcome": "deno run https://deno.land/std@0.71.0/examples/welcome.ts",
    "bundler": "denopack -i mod.ts -o bundle.mod.js",
    "publish": "eggs publish"
  }
}

note: you can use the --watch flag to monitor the changes and rerun the script, example: deno run --watch --unstable https://deno.land/std@0.71.0/examples/welcome.ts

you can pass arguments in the command alias and these will be resisted by the file to execute

imports run start --port=3000 --env
console.log(Deno.args); // ["--port=3000", "--env"]

Purge a package or URL

if you want delete a package or url package from cache memory in deno, you can use the purge command to remove from cache memory.

example:

trex purge oak

this finds the oak package in the import_map.json file and removes it from the cache.

trex purge https://deno.land/x/oak@v6.3.1/mod.ts

also can be used with urls

Checking a package's dependency tree

trex tree fs

This prints out something like:

local: C:\Users\trex\AppData\Local\deno\deps\https\deno.land\434fe4a7be02d187573484b382f4c1fec5b023d27d1dcf4f768f300799a073e0
type: TypeScript
compiled: C:\Users\trex\AppData\Local\deno\gen\https\deno.land\std\fs\mod.ts.js
map: C:\Users\trex\AppData\Local\deno\gen\https\deno.land\std\fs\mod.ts.js.map
deps:
https://deno.land/std/fs/mod.ts
  β”œβ”€β”¬ https://deno.land/std/fs/empty_dir.ts
  β”‚ └─┬ https://deno.land/std/path/mod.ts
  β”‚   β”œβ”€β”€ https://deno.land/std/path/_constants.ts
  β”‚   β”œβ”€β”¬ https://deno.land/std/path/win32.ts
  β”‚   β”‚ β”œβ”€β”€ https://deno.land/std/path/_constants.ts
  β”‚   β”‚ β”œβ”€β”¬ https://deno.land/std/path/_util.ts
  β”‚   β”‚ β”‚ └── https://deno.land/std/path/_constants.ts
  β”‚   β”‚ └── https://deno.land/std/_util/assert.ts
  β”‚   β”œβ”€β”¬ https://deno.land/std/path/posix.ts
  β”‚   β”‚ β”œβ”€β”€ https://deno.land/std/path/_constants.ts
  β”‚   β”‚ └── https://deno.land/std/path/_util.ts
  β”‚   β”œβ”€β”¬ https://deno.land/std/path/common.ts
  β”‚   β”‚ └─┬ https://deno.land/std/path/separator.ts
  β”‚   β”‚   └── https://deno.land/std/path/_constants.ts
  β”‚   β”œβ”€β”€ https://deno.land/std/path/separator.ts
  β”‚   β”œβ”€β”€ https://deno.land/std/path/_interface.ts
  β”‚   └─┬ https://deno.land/std/path/glob.ts
  β”‚     β”œβ”€β”€ https://deno.land/std/path/separator.ts
  β”‚     β”œβ”€β”¬ https://deno.land/std/path/_globrex.ts
  β”‚     β”‚ └── https://deno.land/std/path/_constants.ts
  β”‚     β”œβ”€β”€ https://deno.land/std/path/mod.ts
  β”‚     └── https://deno.land/std/_util/assert.ts
  β”œβ”€β”¬ https://deno.land/std/fs/ensure_dir.ts
  β”‚ └─┬ https://deno.land/std/fs/_util.ts
  β”‚   └── https://deno.land/std/path/mod.ts
  β”œβ”€β”¬ https://deno.land/std/fs/ensure_file.ts
  β”‚ β”œβ”€β”€ https://deno.land/std/path/mod.ts
  β”‚ β”œβ”€β”€ https://deno.land/std/fs/ensure_dir.ts
  β”‚ └── https://deno.land/std/fs/_util.ts
  β”œβ”€β”¬ https://deno.land/std/fs/ensure_link.ts
  β”‚ β”œβ”€β”€ https://deno.land/std/path/mod.ts
  β”‚ β”œβ”€β”€ https://deno.land/std/fs/ensure_dir.ts
  β”‚ β”œβ”€β”€ https://deno.land/std/fs/exists.ts
  β”‚ └── https://deno.land/std/fs/_util.ts
  β”œβ”€β”¬ https://deno.land/std/fs/ensure_symlink.ts
  β”‚ β”œβ”€β”€ https://deno.land/std/path/mod.ts
  β”‚ β”œβ”€β”€ https://deno.land/std/fs/ensure_dir.ts
  β”‚ β”œβ”€β”€ https://deno.land/std/fs/exists.ts
  β”‚ └── https://deno.land/std/fs/_util.ts
  β”œβ”€β”€ https://deno.land/std/fs/exists.ts
  β”œβ”€β”¬ https://deno.land/std/fs/expand_glob.ts
  β”‚ β”œβ”€β”€ https://deno.land/std/path/mod.ts
  β”‚ β”œβ”€β”¬ https://deno.land/std/fs/walk.ts
  β”‚ β”‚ β”œβ”€β”€ https://deno.land/std/_util/assert.ts
  β”‚ β”‚ └── https://deno.land/std/path/mod.ts
  β”‚ └── https://deno.land/std/_util/assert.ts
  β”œβ”€β”¬ https://deno.land/std/fs/move.ts
  β”‚ β”œβ”€β”€ https://deno.land/std/fs/exists.ts
  β”‚ └── https://deno.land/std/fs/_util.ts
  β”œβ”€β”¬ https://deno.land/std/fs/copy.ts
  β”‚ β”œβ”€β”€ https://deno.land/std/path/mod.ts
  β”‚ β”œβ”€β”€ https://deno.land/std/fs/ensure_dir.ts
  β”‚ β”œβ”€β”€ https://deno.land/std/fs/_util.ts
  β”‚ └── https://deno.land/std/_util/assert.ts
  β”œβ”€β”€ https://deno.land/std/fs/read_file_str.ts
  β”œβ”€β”€ https://deno.land/std/fs/write_file_str.ts
  β”œβ”€β”€ https://deno.land/std/fs/read_json.ts
  β”œβ”€β”€ https://deno.land/std/fs/write_json.ts
  β”œβ”€β”€ https://deno.land/std/fs/walk.ts
  └── https://deno.land/std/fs/eol.ts

Integrity checking & lock files

Let's say your module depends on a remote module. When you compile your module for the first time, it is retrieved, compiled and cached. It will remain this way until you run your module on a new machine (e.g. in production) or reload the cache.

But what happens if the content in the remote url is changed? This could lead to your production module running with different dependency code than your local module. Deno's solution to avoid this is to use integrity checking and lock files.

Create a lockfile:

deno cache --lock=lock.json --lock-write file.ts

The above generates a lock.json file.

If you use import_map.json in input file, you can specify it:

deno cache --lock=lock.json --lock-write --import-map=import_map.json --unstable file.ts

See deno document for more info.

Complete example

A simple std server

Install http and fmt:

trex install --map http fmt

Create a simple server:

// server.ts
import { serve } from "http/server.ts";
import { green } from "fmt/colors.ts";

const server = serve({ port: 8000 });
console.log(green("http://localhost:8000/"));

for await (const req of server) {
  req.respond({ body: "Hello World\n" });
}

Run the server:

deno run --allow-net --import-map=import_map.json --unstable server.ts

note: it is important to use --import-map=import_map.json --unstable

Adding third party packages

Example using oak

Add the master version of oak:

trex i --map oak

This adds oak to the import_map.json file:

{
  "imports": {
    "http/": "https://deno.land/std/http/",
    "fmt/": "https://deno.land/std/fmt/",
    "oak": "https://deno.land/x/oak/mod.ts"
  }
}

note: third party packages are added using mod.ts

Then create an oak application. Note the import statement.

// app.ts
import { Application } from "oak";

const app = new Application();

app.use((ctx) => {
  ctx.response.body = "Hello World!";
});

await app.listen({ port: 8000 });

Run the server:

deno run --allow-net --import-map=import_map.json --unstable app.ts

Contributing

Contributions are welcome, see CONTRIBUTING GUIDELINES.

Licensing

Trex is licensed under the MIT license.


Trex is powered by

You can’t perform that action at this time.