syumai / dem Goto Github PK

View Code? Open in Web Editor NEW

61.0 61.0 2.0 125 KB

A module version manager for Deno.

License: MIT License

TypeScript 95.87% Makefile 4.13%

deno typescript

dem's Introduction

dem

A simple module version manager for Deno.
dem creates dem.json and links script files with version.
- linked scripts are stored in vendor directory.
dem provides an easy way to update dependencies.

Example

Using https://deno.land/std/http/server.ts at v0.51.0

dem.json
- generated file like a package.json

{
  "modules": [
    {
      "protocol": "https",
      "path": "deno.land/std",
      "version": "v0.51.0",
      "files": [
        "/http/server.ts"
      ]
    }
  ]
}

vendor/https/deno.land/std/http/server.ts
- generated linked script includes version specified in dem.json

export * from "https://deno.land/[email protected]/http/server.ts";

example.ts
- script to run

// You can import module without the version.
import { serve } from "./vendor/https/deno.land/std/http/server.ts";

Install

deno install --allow-read --allow-write --allow-net -f -n dem https://deno.land/x/[email protected]/cmd.ts

Usage

Getting Started

1. `dem init` to create `dem.json`

$ dem init
successfully initialized the project.

2. `dem add` to add module.

$ dem add https://deno.land/[email protected]
successfully added new module: https://deno.land/std, version: v0.51.0

3. Edit your script and import module from `vendor`.

example.ts

import * as path from './vendor/https/deno.land/std/fs/path.ts';

console.log(path.join(Deno.cwd(), 'example'));

4. `dem ensure` to resolve modules.

$ dem ensure
successfully created link: https://deno.land/[email protected]/fs/path.ts

5. Run your script.

$ deno example.ts

Standard Usage

Updating module

dem update updates versions in dem.json and linked scripts.

$ dem update https://deno.land/[email protected]
successfully updated module: https://deno.land/std, version: v0.52.0

Advanced Usage

Alias

With alias, shortened script paths are available.

example.ts

// Original
import * as dejs from "./vendor/https/deno.land/x/dejs/mod.ts"
// With alias
import * as dejs from "./vendor/dejs.ts"

How to use alias

execute dem alias.

# create alias for module.
$ dem alias https://deno.land/x/dejs/mod.ts dejs.ts # ./vendor/dejs.ts will be created.

import script using alias path

import * as dejs from "./vendor/dejs.ts"

run dem ensure.

# create link for `./vendor/https/deno.land/x/dejs/mod.ts`.
$ dem ensure

Commands

dem init                                          # initialize dem.json
dem add https://deno.land/x/[email protected]            # add module `dejs` and set its version to `0.1.0`
dem link https://deno.land/x/dejs/mod.ts          # create link of `[email protected]/mod.ts` and put it into vendor.
dem update https://deno.land/x/[email protected]         # update module to `0.2.0`
dem unlink https://deno.land/x/dejs/mod.ts        # remove link of `[email protected]/mod.ts`.
dem remove https://deno.land/x/dejs               # remove module `dejs`
dem ensure                                        # resolve file paths of added modules used in project and link them.
dem prune                                         # remove unused modules and linked scripts.
dem alias https://deno.land/x/dejs/mod.ts dejs.ts # create alias for module and put it into vendor.
dem unalias dejs.ts                               # remove alias for module.

Unsupported features

default export
manage .d.ts file

Author

syumai

License

MIT

dem's People

Contributors

Stargazers

Watchers

Forkers

uki00a michael-spengler

dem's Issues

Support default export

fetch target script
check if it has default export
add export { default } from xxx

dem does not work on deno v0.29.0

Hello, thank you for the module!

I run into a problem when run dem on deno v0.29.0 like this:

$ dem update https://deno.land/[email protected]
sub command https://deno.land/[email protected] does not exist.

I think this is because Deno.args now does not include script name. (denoland/deno#3628)

Would you have a plan to support deno v0.29.0 or above?

Thank you.

dem not creates alias in the format of `deno fmt` default

dem should create alias in the format of deno fmt default.
Apply deno fmt to created file.

When i use dem ensure for this project and I started the code. I got Uncaught SyntaxError: The requested module './vendor/https/jspm.dev/typescript/lib/typescript.js' does not provide an export named 'default'

So I looked the code and the hasDefaultExport function return false even if a module a export default. I rewrite the code to get working but that's my first step with typescript and I think my code could be better.

Here is the full function

export function hasDefaultExport(body: string): boolean {
  const sourceFile = ts.createSourceFile("", body, ts.ScriptTarget.ES2020);
  let hasDefault = false;
  sourceFile.forEachChild((node: ts.Node) => {
    if(ts.isExportDeclaration(node)){
      const exportClause: ts.NamedExports = node.exportClause as ts.NamedExports;
      if(exportClause !== undefined){
        hasDefault = hasDefault || (exportClause.elements[0].name.escapedText as string === 'default');
      }
    }
  });
  return hasDefault;
}

Add Release flow document

Add document to describe how to release new version of dem.

Consider using Pagic to build the website?

dem add/ensure doesn't create anything in vendor/

Perhaps I am misunderstanding dem, but it seems dem add should be files in vendor? But I am not seeing this happening. Thus far, only dem alias does anything to vendor/ .

Using dem 0.9.9:

dem init
sucessfully initialized dem.json
jq . dem.json

{
  "modules": [],
  "aliases": {}
}

dem add https://deno.land/x/[email protected]
successfully added new module: https://deno.land/x/dejs, version: 0.9.3
jq .modules dem.json

[
  {
    "protocol": "https",
    "path": "deno.land/x/dejs",
    "version": "0.9.3",
    "files": []
  }
]

But, there is no vendor directory (if I create vendor/ beforehand, nothing is placed inside of it).

Support .d.ts

Parse .d.ts and create alias for them
- https://deno.land/std/manual.md

Patterns

Compiler hint

// @deno-types="./vendor/https/deno.land/std/foo/bar.d.ts"
import * as bar from "./bar.js";

Triple-slash reference in .js

/// <reference types="./vendor/https/deno.land/std/foo/bar.d.ts" />
export const bar = "bar";

Fix build

try non- esm.sh typescript module

Make easier to update TypeScript

This module is using old version of TypeScript to parse import section
- This is used for dem ensure / dem prune
Add ability to patch TypeScript automatically.

Support alias

Not sure if something like this is already supported:

{
  "modules": [
    {
      "protocol": "https",
      "path": "deno.land/std",
      "version": "v0.51.0",
      "files": [
        "/http/server.ts"
      ],
      "alias": "server.ts"
    }
  ]
}

import { serve } from './vendor/server.ts"

dem update Error

PS C:> deno --version
deno 1.16.3 (release, x86_64-pc-windows-msvc)
v8 9.7.106.5
typescript 4.4.2
PS C:> dem version
dem: 0.9.9
PS C:> dem update
error: Uncaught (in promise) TypeError: Invalid URL
const u = new URL(name);
^
at Object.opSync (deno:core/01_core.js:142:12)
at opUrlParse (deno:ext/url/00_url.js:47:27)
at new URL (deno:ext/url/00_url.js:320:20)
at Function.parse (https://deno.land/x/[email protected]/module.ts:20:15)
at App.updateModule (https://deno.land/x/[email protected]/mod.ts:159:31)
at main (https://deno.land/x/[email protected]/cmd.ts:74:11)
PS C:>