@elliots/typical 0.1.0 → 0.1.2

package/README.md

@@ -23,7 +23,7 @@ Why not.
 - ✅ Configurable include/exclude patterns
 - ✅ Optionally reuse validation logic for identical types to optimize performance (enabled by default)
 - ✅ TSC plugin
-- ✅ ESM loader for runtime transformation with `node --import typical/esm` (or `node --loader typical/esm-loader` for older Node versions)
+- ✅ ESM loader for runtime transformation with `node --import @elliots/typical/esm` (or `node --loader @elliots/typical/esm-loader` for older Node versions)
 - ✅ tsx wrapper (ttsx) for easy use like `npx ttsx script.ts`
 
 ## Installation
@@ -53,10 +53,17 @@ See ./samples/esm and ./samples/tsc and ./samples/ttsx
 Quickest way to try it out is to use ttsx:
 
 ```bash
-npm add github:elliots/typical
+npm add @elliots/typical
 npx ttsx your-script.ts
 ```
 
+or globally:
+
+```bash
+npm add -g @elliots/typical
+ttsx your-script.ts
+```
+
 ## Example
 
 This code will run without errors when compiled normally, but will throw an error when using Typical.

package/bin/ttsx

@@ -1,3 +1,3 @@
 #!/bin/sh
 
-NODE_OPTIONS="--import typical/esm" exec tsx $@
+NODE_OPTIONS="--import @elliots/typical/esm" exec tsx $@

package/bin/typical

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import('../dist/src/cli.js');

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@elliots/typical",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Runtime safe TypeScript transformer using typia",
   "main": "dist/index.js",
   "type": "module",
   "bin": {
-    "typical": "dist/cli.js",
+    "typical": "bin/typical",
     "ttsx": "bin/ttsx",
     "ttsc": "bin/ttsc"
   },

package/src/patch-tsconfig.cjs

@@ -1,4 +1,4 @@
-// monkeypatch fs.readFileSync to automatically add typical/tsc-plugin to tsconfig.json (if not present)
+// monkeypatch fs.readFileSync to automatically add @elliots/typical/tsc-plugin to tsconfig.json (if not present)
 
 const fs = require("fs");
 const stripJsonComments = require('strip-json-comments').default;
@@ -24,7 +24,7 @@ fs.readFileSync = function (path, ...args) {
       }
 
       const hasTypical = config.compilerOptions.plugins.some(
-        (plugin) => plugin.transform === "typical/tsc-plugin"
+        (plugin) => plugin.transform === "@elliots/typical/tsc-plugin"
       );
 
       if (!hasTypical) {
@@ -35,7 +35,7 @@ fs.readFileSync = function (path, ...args) {
           });
         } else {
           config.compilerOptions.plugins.push({
-            transform: "typical/tsc-plugin",
+            transform: "@elliots/typical/tsc-plugin",
           });
         }
       }
@@ -44,7 +44,7 @@ fs.readFileSync = function (path, ...args) {
 
       return JSON.stringify(config, null, 2);
     } catch (e) {
-      console.error("ERROR patching tsconfig.json to add typical/tsc-plugin", e);
+      console.error("ERROR patching tsconfig.json to add @elliots/typical/tsc-plugin", e);
       throw e;
     }
   }