vite-plugin-simple-tsconfig-alias 0.0.1 → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ray <https://github.com/so1ve>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,45 +1,80 @@
 # vite-plugin-simple-tsconfig-alias
 
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `vite-plugin-simple-tsconfig-alias`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**
+[![NPM version](https://img.shields.io/npm/v/vite-plugin-simple-tsconfig-alias?color=a1b858&label=)](https://www.npmjs.com/package/vite-plugin-simple-tsconfig-alias)
+
+A simple Vite plugin to resolve tsconfig paths as aliases.
+
+## 💎 Features
+
+- Reads `compilerOptions.paths` from one or more tsconfig files.
+- Supports exact mappings (no `*`), e.g. `"@": ["./src"]`.
+- Supports single-star wildcard mappings, e.g. `"@/*": ["./src/*"]`.
+  - The `*` is converted to a RegExp capture group on `find` and `$1` replacements.
+- Merges aliases into `config.resolve.alias` early (`enforce: "pre"`).
+  - Aliases from tsconfig are prepended so they take precedence over existing ones.
+- `baseUrl` behavior:
+  - If `baseUrl` is set in a tsconfig, targets are resolved relative to it.
+  - If not set, targets are resolved relative to that tsconfig's directory.
+
+## 📦 Installation
+
+```bash
+$ npm install vite-plugin-simple-tsconfig-alias
+$ yarn add vite-plugin-simple-tsconfig-alias
+$ pnpm add vite-plugin-simple-tsconfig-alias
+```
+
+## 🚀 Usage
+
+### Vite Plugin
+
+```ts
+// vite.config.ts
+import { defineConfig } from "vite";
+import TsconfigAlias from "vite-plugin-simple-tsconfig-alias";
+
+export default defineConfig({
+  plugins: [
+    TsconfigAlias({
+      // Optional: root directory of the project (default: process.cwd())
+      root: process.cwd(),
+      // Optional: tsconfig file names to read (default: ["tsconfig.json"])
+      configNames: ["tsconfig.json", "tsconfig.paths.json"],
+    }),
+  ],
+});
+```
+
+### Programmatic API
+
+You can also use the underlying functions to parse and merge aliases manually. This makes it possible to be used in other contexts beyond Vite plugins, like other bundlers that doesn't have a `config` hook.
+
+```ts
+import {
+  mergeAliases,
+  parseTsconfigAliases,
+} from "vite-plugin-simple-tsconfig-alias";
+
+// Parse aliases from tsconfig files
+const aliases = parseTsconfigAliases(process.cwd(), ["tsconfig.json"]);
+
+// Merge with existing Vite aliases
+const finalAliases = mergeAliases(
+  [{ find: "@custom", replacement: "./src/custom" }],
+  aliases,
+);
+```
+
+## ⚠️ Limitations
+
+- Only the first target in a `paths` entry is used. If you rely on fallbacks like `"@/*": ["./src/*", "./generated/*"]`, only `./src/*` will be applied.
+- Path mapping transforms are only injected into Vite's resolver.
+  - TypeScript / vue-tsc still use tsconfig directly; keep tsconfig correct.
+- Does not support Vite's `\0` virtual module prefix use cases.
+- Wildcard handling is generic regex-based and may be looser than TypeScript's own matching in edge cases (multiple `*` segments, unusual patterns).
+- If the tsconfig file can't be read/parsed, it is silently skipped.
+- Windows paths: Replacements are absolute filesystem paths produced by Node's `path.resolve`.
+
+## 📝 License
+
+[MIT](./LICENSE). Made with ❤️ by [Ray](https://github.com/so1ve)

package/dist/index.d.mts

@@ -0,0 +1,19 @@
+import { Plugin } from "vite";
+
+//#region src/types.d.ts
+interface Alias {
+  find: string | RegExp;
+  replacement: string;
+}
+type AliasOptions = readonly Alias[] | Record<string, string>;
+//#endregion
+//#region src/index.d.ts
+interface TsconfigAliasPluginOptions {
+  root?: string;
+  configNames?: string[];
+}
+declare function parseTsconfigAliases(projectRoot: string, configNames: string[]): Alias[];
+declare function mergeAliases(existing: AliasOptions | undefined, incoming: Alias[]): Alias[];
+declare function TsconfigAlias(options?: TsconfigAliasPluginOptions): Plugin;
+//#endregion
+export { TsconfigAliasPluginOptions, TsconfigAlias as default, mergeAliases, parseTsconfigAliases };

package/dist/index.mjs

@@ -0,0 +1,86 @@
+import fs from "node:fs";
+import path from "node:path";
+import ts from "typescript";
+
+//#region src/index.ts
+const escapeRegExp = (value) => value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+function buildStarRegex(pattern) {
+	const parts = pattern.split("*");
+	const starCount = parts.length - 1;
+	const source = `^${parts.map(escapeRegExp).join("(.*)")}$`;
+	return {
+		find: new RegExp(source),
+		starCount
+	};
+}
+function buildReplacement(target, starCount) {
+	let replacement = target;
+	for (let i = 1; i <= starCount; i += 1) replacement = replacement.replace("*", `$${i}`);
+	return replacement;
+}
+function readTsconfig(filePath) {
+	if (!fs.existsSync(filePath)) return null;
+	const read = ts.readConfigFile(filePath, ts.sys.readFile);
+	if (read.error) return null;
+	return ts.parseJsonConfigFileContent(read.config, ts.sys, path.dirname(filePath), void 0, filePath);
+}
+function toArray(value) {
+	if (Array.isArray(value)) return value.filter((v) => typeof v === "string");
+	if (typeof value === "string") return [value];
+	return [];
+}
+function parseTsconfigAliases(projectRoot, configNames) {
+	const aliases = [];
+	for (const configName of configNames) {
+		const configPath = path.resolve(projectRoot, configName);
+		const parsed = readTsconfig(configPath);
+		if (!parsed) continue;
+		const baseUrl = parsed.options.baseUrl ?? path.dirname(configPath);
+		const paths = parsed.options.paths ?? {};
+		for (const [from, to] of Object.entries(paths)) {
+			const firstTarget = toArray(to)[0];
+			if (!firstTarget) continue;
+			const absoluteTarget = path.resolve(baseUrl, firstTarget);
+			if (!from.includes("*")) {
+				aliases.push({
+					find: from,
+					replacement: absoluteTarget
+				});
+				continue;
+			}
+			const { find, starCount } = buildStarRegex(from);
+			aliases.push({
+				find,
+				replacement: buildReplacement(absoluteTarget, starCount)
+			});
+		}
+	}
+	aliases.sort((a, b) => {
+		const aLen = typeof a.find === "string" ? a.find.length : a.find.source.length;
+		return (typeof b.find === "string" ? b.find.length : b.find.source.length) - aLen;
+	});
+	return aliases;
+}
+function mergeAliases(existing, incoming) {
+	const normalizedExisting = existing ? Array.isArray(existing) ? [...existing] : Object.entries(existing).map(([find, replacement]) => ({
+		find,
+		replacement
+	})) : [];
+	return [...incoming, ...normalizedExisting];
+}
+function TsconfigAlias(options = {}) {
+	const root = options.root ?? process.cwd();
+	const configNames = options.configNames ?? ["tsconfig.json"];
+	return {
+		name: "vite-plugin-simple-tsconfig-alias",
+		enforce: "pre",
+		config(config) {
+			const aliases = parseTsconfigAliases(root, configNames);
+			config.resolve ??= {};
+			config.resolve.alias = mergeAliases(config.resolve.alias, aliases);
+		}
+	};
+}
+
+//#endregion
+export { TsconfigAlias as default, mergeAliases, parseTsconfigAliases };

package/package.json

@@ -1,10 +1,71 @@
 {
   "name": "vite-plugin-simple-tsconfig-alias",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for vite-plugin-simple-tsconfig-alias",
+  "version": "0.1.0",
+  "author": "Ray <i@mk1.io> (@so1ve)",
+  "type": "module",
+  "description": "A simple Vite plugin to resolve tsconfig paths as aliases.",
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+    "vite",
+    "vite-plugin",
+    "tsconfig",
+    "alias",
+    "path-mapping"
+  ],
+  "homepage": "https://github.com/so1ve/vite-plugin-simple-tsconfig-alias#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/so1ve/vite-plugin-simple-tsconfig-alias.git"
+  },
+  "bugs": {
+    "url": "https://github.com/so1ve/vite-plugin-simple-tsconfig-alias/issues"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@antfu/ni": "^28.0.0",
+    "@so1ve/eslint-config": "^4.1.2",
+    "@so1ve/prettier-config": "^4.1.2",
+    "@types/node": "^25.0.3",
+    "@typescript/native-preview": "7.0.0-dev.20251029.1",
+    "bumpp": "^10.3.2",
+    "eslint": "^9.39.2",
+    "prettier": "^3.7.4",
+    "tsdown": "^0.18.3",
+    "typescript": "^5.9.3",
+    "vite": "^7.3.0",
+    "vitest": "^4.0.16"
+  },
+  "peerDependencies": {
+    "typescript": "^5",
+    "vite": "^4 || ^5 || ^6 || ^7"
+  },
+  "peerDependenciesMeta": {
+    "vite": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "tsdown",
+    "lint": "eslint . && prettier . --check",
+    "lint:fix": "eslint . --fix && prettier . --write",
+    "release": "bumpp --commit --push --tag",
+    "test": "vitest",
+    "typecheck": "nr typecheck:isolated && nr typecheck:non-isolated",
+    "typecheck:isolated": "tsc --noEmit --project tsconfig.isolated.json",
+    "typecheck:non-isolated": "tsgo --noEmit --project tsconfig.non-isolated.json",
+    "watch": "tsdown --watch"
+  }
+}