@ttsc/paths 0.8.1 → 0.10.0

package/README.md

@@ -9,30 +9,15 @@
 [![Guide Documents](https://img.shields.io/badge/Guide-Documents-forestgreen)](https://github.com/samchon/ttsc/tree/master/docs)
 [![Discord Badge](https://img.shields.io/badge/discord-samchon-d91965?style=flat&labelColor=5866f2&logo=discord&logoColor=white&link=https://discord.gg/E94XhzrUCZ)](https://discord.gg/E94XhzrUCZ)
 
-`@ttsc/paths` rewrites source module specifiers that match `compilerOptions.paths` into relative JavaScript paths. TypeScript-Go carries those source AST changes into declaration emit.
+`@ttsc/paths` rewrites module specifiers that match `compilerOptions.paths` into relative JavaScript and declaration imports.
 
 ## Setup
 
-Install `ttsc`, TypeScript-Go, and the paths plugin:
+Install `ttsc` and TypeScript-Go, then the paths plugin:
 
 ```bash
-npm install -D ttsc @typescript/native-preview @ttsc/paths
-```
-
-Open your project's `tsconfig.json`, then configure `paths`, `rootDir`, `outDir`, and this plugin under `compilerOptions`. If the file already has `compilerOptions`, merge these fields into the existing object:
-
-```jsonc
-{
-  "compilerOptions": {
-    "paths": {
-      "@/*": ["./src/*"],
-      "@lib/*": ["./src/modules/*"],
-    },
-    "rootDir": "src",
-    "outDir": "dist",
-    "plugins": [{ "transform": "@ttsc/paths" }],
-  },
-}
+npm install -D ttsc @typescript/native-preview
+npm install -D @ttsc/paths
 ```
 
 Run your normal `ttsc` command:
@@ -41,33 +26,27 @@ Run your normal `ttsc` command:
 npx ttsc
 ```
 
-An import such as `import { value } from "@lib/value"` becomes a relative JavaScript import such as `import { value } from "./modules/value.js"`. Declaration output follows the same source rewrite.
+## Configuration
 
-## Notes
+`@ttsc/paths` has no separate plugin options. It reads the same `compilerOptions.paths`, `rootDir`, and `outDir` values that `ttsc` uses for the project.
 
-No separate plugin options are required. `@ttsc/paths` reads the same `compilerOptions.paths`, `rootDir`, and `outDir` values that `ttsc` uses for the project.
+Configure those fields under `compilerOptions`:
 
 ```jsonc
 {
   "compilerOptions": {
     "paths": {
+      "@/*": ["./src/*"],
       "@lib/*": ["./src/modules/*"],
     },
     "rootDir": "src",
     "outDir": "dist",
-    "plugins": [
-      // Keep lint first.
-      { "transform": "@ttsc/lint", "config": { "no-var": "error" } },
-
-      // First-party utilities use their documented transform order.
-      { "transform": "@ttsc/banner", "banner": "License MIT" },
-      { "transform": "@ttsc/paths" },
-      { "transform": "@ttsc/strip", "calls": ["console.log"] },
-    ],
   },
 }
 ```
 
+An import such as `import { value } from "@lib/value"` becomes a relative JavaScript import such as `import { value } from "./modules/value.js"`. Declaration output follows the same source rewrite.
+
 ## References
 
 Inspired by [`typescript-transform-paths`](https://github.com/LeDDGroup/typescript-transform-paths).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttsc/paths",
-  "version": "0.8.1",
+  "version": "0.10.0",
   "description": "First-party ttsc plugin that rewrites emitted module specifiers from tsconfig paths.",
   "main": "src/index.cjs",
   "exports": {
@@ -13,11 +13,17 @@
     "typescript",
     "tsgo"
   ],
+  "ttsc": {
+    "plugin": {
+      "transform": "@ttsc/paths"
+    }
+  },
   "files": [
     "README.md",
     "src/index.cjs",
     "go.mod",
-    "plugin"
+    "plugin/main.go",
+    "plugin/paths.go"
   ],
   "repository": {
     "type": "git",

package/plugin/main.go

@@ -28,7 +28,7 @@ func run(args []string) int {
   case "transform":
     return utility.RunTransform(args[1:])
   case "check":
-    return 0
+    return utility.RunCheck(args[1:])
   default:
     fmt.Fprintf(os.Stderr, "@ttsc/paths: unknown command %q\n", args[0])
     return 2