Welcome to Trex!

Trex 🐱‍🐉

GitHub issues GitHub forks GitHub stars GitHub license GitHub tag (latest SemVer)

Trex

Package management for deno

What is Trex?

is a “Package management” for deno to implement an import_map.json for your imports is an easiest way to make imports in deno.

// import_map.json

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

For more information about the import maps in deno import maps

Setup visual studio code

install the deno extension first, then add in settings.json the following configuration.

settings.json

activate the enable option Deno unstable features in settings >> extensions >> Deno

unstable

if you get this error after installing a module.

error

run your project to cache all dependencies.

note: We are working so that when a module is installed in import_map.json it will be cached to avoid this error when calling the module. it is currently being tested on windows and linux but it is an instable feature at the moment

Guide:

installation:

Download the repository and open the terminal in the folder of the repository and write:

$  deno install --allow-read --allow-write --allow-net --allow-run --unstable Trex.ts

note: You should have the last version 1.0.0 >= of deno for no errors.

or in your terminal you can write

$  deno install --allow-read --allow-write --allow-net --allow-run --unstable https://deno.land/x/trex/Trex.ts

update Trex using

$  deno install -f --allow-read --allow-write --allow-net --allow-run --unstable https://deno.land/x/trex/Trex.ts

or use:

$ Trex update

for versions 0.2.0 or higher.

check for the installation of the Trex tool writing in the terminal:

$  Trex --version

and the console should presente the Trex version.

for any help of the commands of Trex write:

$  Trex --help

and the console should present:

help:
   * flags:
       --map: for install a library
       --version: logs version
       --custom: for install custom package
       --deps: log modules versions

   * install module using:
        Trex install --map fs http

   * install custom module usig:
        Trex --custom module_name=module_url

   * uninstall module using:
        Trex delete module_name

   * install Tool using:
        Trex getTool tool_name

   * check module stated using:
        Trex --deps

for a better implementation of this tool you can use the tool Commands of deno Commands

How to use

in your command line write:

$ Trex install --map fs http fmt

note: you can use Trex i –map fs http fmt

an import_map.json file will be created with the following.

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

Usage example.

create a test file

// 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 in terminal

$ deno run --allow-net --importmap=import_map.json --unstable server.ts

note: it is important to use –importmap=import_map.json –unstable

using third party modules

example using oak

$ Trex i --map oak

in 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"
  }
}

note: third party modules are added using mod.ts

in server.ts

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

const app = new Application();

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

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

run in terminal

$ deno run --allow-net --importmap=import_map.json --unstable server.ts

add custom module

in your command line write:

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

in 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",
    "React": "https://dev.jspm.io/react/index.js"
  }
}

install tools like velociraptor or Commands

in your command line write:

$ Trex getTool Commands

this will install the tool

note: If you are a linux/MacOs user you’ll have to specificate the PATH manually when the tool gets installed the will appear in your terminal export PATH=”/home/username/.deno/bin:$PATH”

delete module

in your command line write:

$ Trex delete React

in 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"
  }
}

install another version of a module

write the name of the module more @<Version>

example:

$ Trex install --map fs@0.`5`4.0

in import_map.json

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

note: this feature is currently unstable and can be used with third party modules.

check the versions of dependencies using

$ Trex --deps

you should see something like that on the console.

// in import_map.json
{
  "imports": {
    "oak": "https://deno.land/x/oak@v4.0.0/mod.ts",
    "http/": "https://deno.land/std@0.51.0/http/"
  }
}
name module url version latest upToDate
oak oak https://deno.land/x/oak@v4.0.0/mod.ts “v4.0.0” “v5.0.0” false
http/ std https://deno.land/std@0.54.0/http/ “0.54.0” “0.54.0” true

thanks to Fzwael this functionality is based on your tool deno-check-updates

View version

$ Trex --version

View help

$ Trex --help

To Do

  • install std modules and third party modules in deno.land/x.

  • delete modules from import_map.json.

  • support for custom module outside of deno third party modules.

  • sort modules names in import_map.json.

  • support to install tools like Commands.

    • if you want add your tool in database edit this file database.json
  • update using:

    • $ Trex update
  • support to choose install other versions of modules. (!unstable):

    • $ Trex install --map fs@0.50.0
  • safe installation for tools like Commands, velociraptor or dpx.

    • display a warning message with the permissions of the tool
  • check the versions of the libraries.

    • $ Trex --deps
  • System to cache package when install it. (!unstable):

    • it is currently being tested on windows and linux but it is an instable feature at the moment.

      note: by default it caches the modules using the mod.ts file, if it cannot find it, it does not add it to the cache but add to the import_map.json.

    • We are working to you can choose the target file

  • List all the tools you can install.

  • choose the destination file when installing a module.

    • $ Trex i --map fmt@0.45.0=colors.ts [ fmt ] = module, [ @0.45.0 ] = version, [ =colors.ts ] = file target