bevry
make-deno-edition
Automatically makes package.json projects (such as npm packages and node.js modules) compatible with Deno.
Overview
Examples
Here is the growing list of all the packages that make-deno-edition has made compatible with Deno.
The Need
Node.js and TypeScript support unresolved paths, e.g. import thing from './file' and import thing from './'. Deno however, only supports resolved paths, e.g. import thing from './file.ts' and import thing from 'https://unpkg.com/badges@^4.13.0/edition-deno/index.ts'. This means that anything imported into Deno must be directly resolvable and must use ECMAScript Modules (ESM).
Node.js and TypeScript support package.json files to specify dependency versions, which enables code like import dep from 'dep'. Deno however, has no conception of package.json, so all dependencies must be imported via a directly resolvable CDN URL, e.g. import dep from 'https://unpkg.com/dep@^1.0.0/file.ts'.
Deno and Node.js different on their APIs. Node.js builtins can be converted to Deno's std/node builtins, however several things such as __filename, __dirname require a polyfill, and other things have no direct compatibility so require different entries.
In the end, you must hope your dependencies are also compatible with Deno.
The Solution
make-deno-edition is a CLI tool that takes your source edition (whichever directory contains your package's typescript source files) and creates a compatible deno edition in a edition-deno directory.
It provides this compatibility by providing the following transformations:
bultin imports (e.g.
fs) are mapped to their corresponding denonode:*polyfillcertain globals (e.g.
__filenameand__dirname) are mapped to their corresponding deno userland polyfilllinternal imports (any relative path to another file inside your source edition) are mapped to their typescript file, e.g.
import thing from './file'andimport thing from './file.js'becomesimport thing from './file.tsremote imports (e.g. any URL) are assumed to be compatible, as node.js doesn't support them, so it is assumed they are already deno compatible
dependency imports (e.g. any package you install into node_modules) are supported by:
If they have a
denofield in theirpackage.json, which will denote where to look for the deno compatible entry file, then it's direct unpkg URL will be used.The more dependencies that
make-deno-editionis run on, then the more dependencies will automatically have adenoentry field, and thus the more dependencies will be automatically compatible with Deno, enabling more dependents to be automatically compatible with Deno.If they are an installed dependency, their esm.sh URL will be used.
If they are an uninstalled dependency, the
npm:prefix will be used.
make-deno-edition will also intelligently ignore compatibility for files that are not essential, such as your test and utility files, but fail if compatibility for an essential file, such as an entry file and its required modules fail
Finally, make-deno-edition will also update your package.json file with the details for the deno entry file, as well as the deno edition metadata, such that other packages and toolchains can make use of your deno compatibility.
Usage
Preparation
If you are using
boundationto automatically generate deno compatibility for your npm package, then you can skip this step.
If you haven't already done so, add the following editions metadata to your package.json file:
"editions": [
{
"description": "TypeScript source code with Import for modules",
"directory": "source",
"entry": "index.ts",
"tags": [
"typescript",
"import"
],
"engines": false
}
]Make sure that the directory is where the source files are located, in the above example, they are located in a source directory, as it is with this repository.
Make sure that the entry is where the entry file is located within the edition directory, in the above example, the entry is index.ts, as it is with this repository.
Executable
If you are using
boundationto automatically generate deno compatibility for your npm package, then you can skip this step.
Install make-deno-edition to your development dependencies using:
npm install --save-dev make-deno-editionThen add a compile npm script to your package.json containing:
make-deno-edition --attemptAlternatively, you can run it directly on your project via:
npx make-deno-edition --attemptThe --attempt flag will not emit a failure exit code if the deno edition generation was not successful. If you require a deno edition to be published, remove the --attempt flag.
Publishing
If you are using
boundationto automatically generate compatible editions (web browsers, deno, multiple node.js versions) for your npm package, then you can skip this step.
If you are using
projectzto automatically generate yourREADME.mdcontent, then you can skip this step.
If a deno edition was successfully created, it will be located in the edition-deno directory with the metadata added to the editions array in your package.json and a deno entry field also added to your package.json.
Consumers of your package who use make-deno-edition on their own package, will now be able to use your package's deno edition to further their own deno compatibility.
You can also instruct consumers of your package to directly use your deno edition, by informing them of its presence in your README.md file. You can use projectz to automatically insert this information for them, or you can use the following template:
<a href="https://deno.land" title="Deno is a secure runtime for JavaScript and TypeScript, it is an alternative for Node.js"><h3>Deno</h3></a>
``` typescript
import pkg from 'https://unpkg.com/YOURPACKAGENAME@^VERSION/edition-deno/ENTRY.ts'
```Install
npm
Install Globally
- Install:
npm install --global make-deno-edition - Executable:
make-deno-edition
Install Locally
- Install:
npm install --save make-deno-edition - Executable:
npx make-deno-edition - Import:
import * as pkg from ('make-deno-edition') - Require:
const pkg = require('make-deno-edition')
Editions
This package is published with the following editions:
make-deno-edition/source/index.tsis TypeScript source code with Import for modulesmake-deno-editionaliasesmake-deno-edition/edition-es2022/index.jsmake-deno-edition/edition-es2022/index.jsis TypeScript compiled against ES2022 for Node.js 18 || 20 || 21 with Require for modulesmake-deno-edition/edition-es2022-esm/index.jsis TypeScript compiled against ES2022 for Node.js 18 || 20 || 21 with Import for modulesmake-deno-edition/edition-types/index.d.tsis TypeScript compiled Types with Import for modules
History
Discover the release history by heading on over to the HISTORY.md file.
Backers
Code
Discover how to contribute via the CONTRIBUTING.md file.
Authors
- Benjamin Lupton — Accelerating collaborative wisdom.
Maintainers
- Benjamin Lupton — Accelerating collaborative wisdom.
Contributors
Finances
Sponsors
- Andrew Nesbitt — Software engineer and researcher
- Balsa — We're Balsa, and we're building tools for builders.
- Codecov — Empower developers with tools to improve code quality and testing.
- Poonacha Medappa
- Rob Morris
- Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
- Syntax — Syntax Podcast
Donors
- Andrew Nesbitt
- Armen Mkrtchian
- Balsa
- Chad
- Codecov
- dr.dimitru
- Elliott Ditman
- entroniq
- GitHub
- Hunter Beast
- Jean-Luc Geering
- Michael Duane Mooring
- Michael Harry Scepaniak
- Mohammed Shah
- Mr. Henry
- Nermal
- Pleo
- Poonacha Medappa
- Rob Morris
- Robert de Forest
- Sentry
- ServieJS
- Skunk Team
- Syntax
- WriterJohnBuck
License
Unless stated otherwise all works are:
- Copyright © Benjamin Lupton
and licensed under: