https://github.com/edwardsharp/versionz

prototype exploring versioned exports a la deno!
https://github.com/edwardsharp/versionz

Last synced: 13 days ago
JSON representation

prototype exploring versioned exports a la deno!

• Host: GitHub
• URL: https://github.com/edwardsharp/versionz
• Owner: edwardsharp
• Created: 2023-08-23T02:27:45.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-23T13:47:36.000Z (over 1 year ago)
• Last Synced: 2024-04-13T09:09:12.916Z (9 months ago)
• Language: JavaScript
• Size: 13.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# versionz

a lil' prototype exploring versioned exports!

note: you probably shouldn't do this. just use [deno](https://deno.land)!

## pretense

nodejs is a ways away from [http imports](https://nodejs.org/api/esm.html#https-and-http-imports) 😬

with deno you can import stuff from different versions of the same package; and that's pretty cool.

for example:

```ts

// ramda-example.ts

import { add } from "https://x.nest.land/[email protected]/source/index.js";

import { multiply } from "https://x.nest.land/[email protected]/mod.ts";

// note: these two fns are coming from two different versions (0.27.0 and 0.27.2) of the same package (ramda)

console.log("[email protected]", add(6, 6, 6));

console.log("[email protected]", multiply(6, 6, 6));

// run like:

// deno run ramda-example.ts

```

## proto

...so then this lil' experiment can enable something like:

```js

import { main as main1 } from "versionz/0.0.1";

import { main as main2 } from "versionz/0.0.2";

import { main as main3, newFn as newFn3 } from "versionz/0.0.3"; // newFn was introduced in v0.0.3!

import { main as main4, newFn as newFn4 } from "versionz/0.0.4";

import { main, newFn } from "versionz/latest";

main1();

main2();

main3();

newFn3();

main4();

newFn4();

main();

newFn();

```

`node example/index.js` then will output:

```

$ node example/index.js

hi from version 0.0.1! 👋

hi from version 0.0.2! 👋

hi from version 0.0.3! 👋

ohai! this is newFn in version 0.0.3!!

hi from version 0.0.4! 👋

ohai! this is newFn in version 0.0.4!!

hi from version 0.0.4! 👋

ohai! this is newFn in version 0.0.4!!

```

this is mostly achieved by the `exports` field in package.json having version identifies, like:

```json

"exports": {

    "./0.0.1": "./dist/0.0.1/index.js",

    "./0.0.2": "./dist/0.0.2/index.js",

    "./0.0.3": "./dist/0.0.3/index.js",

    "./0.0.4": "./dist/0.0.4/index.js"

  },

```

there's some package.json scripts that will:

1. bump package.json's `version` using `npm version patch --no-git-tag-version`

2. re-write (if needed) package.json's `exports` with the new version. see: [utilz/writePackageExports.js](utilz/writePackageExports.js)

3. tsc build to `dist/latest/`

4. and finally tsc build into a version folder in `dist/` (uses `process.env.npm_package_version` which is available to npm scripts!)

check out the entire [package.json](package.json)

see also: [example/index.js](example/index.js)

## dev

`npm run bump-n-build` bump package a patch version, write package.json's `exports` with new version, `tsc` files to `dist/${new-package-version}`

profit! 💰