vite-plugin-lib 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Jan Müller
+
+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

@@ -0,0 +1,54 @@
+# vite-plugin-lib
+
+> Vite plugin for build configuration, automatic aliases, and type declarations.
+
+[![npm](https://img.shields.io/npm/v/vite-plugin-lib?color=a1b858&label=)](https://npmjs.com/package/vite-plugin-lib)
+
+## Features
+
+- Automatic aliases based on `tsconfig.json`
+- Automatic build configuration
+- Type declaration generation based on [vite-plugin-dts](https://github.com/qmhc/vite-plugin-dts).
+
+## Installation
+
+```bash
+yarn add -D vite-plugin-lib
+```
+
+## Usage
+
+This highly opinionated all-in one Vite plugin enables automatic alias configuration based on `tsconfig.json` paths, library export configuration, and type declaration generation.
+
+### Aliases
+
+```ts
+import { defineConfig } from 'vite'
+
+import { tsconfigPaths } from 'vite-plugin-lib'
+
+export default defineConfig({
+  plugins: [tsconfigPaths()],
+})
+```
+
+### Library
+
+The `library` plugin includes the `alias` plugin, configures build settings, and generates `.d.ts` files.
+
+```ts
+import { defineConfig } from 'vite'
+
+import { library } from 'vite-plugin-lib'
+
+export default defineConfig({
+  plugins: [
+    library({
+      entry: 'src/index.ts', // file name determines output file names
+      formats: ['es', 'umd'], // optional, default is ['es', 'umd']
+      name: 'YourGlobalUMDName',
+      external: ['some-package'], // optional, default is all node_modules and builtin modules
+    }),
+  ],
+})
+```

package/dist/index.cjs

@@ -0,0 +1,151 @@
+'use strict';
+
+const promises = require('fs/promises');
+const module$1 = require('module');
+const path = require('path');
+const c = require('picocolors');
+const typescript = require('typescript');
+const dts = require('vite-plugin-dts');
+
+function _interopNamespaceDefault(e) {
+  const n = Object.create(null);
+  if (e) {
+    for (const k in e) {
+      n[k] = e[k];
+    }
+  }
+  n.default = e;
+  return n;
+}
+
+const dts__namespace = /*#__PURE__*/_interopNamespaceDefault(dts);
+
+function log(text) {
+  console.log(`${c.cyan("[vite:lib]")} ${text}`);
+}
+const tsconfigPaths = ({ verbose } = {}) => {
+  return {
+    name: "vite-plugin-lib:alias",
+    enforce: "pre",
+    config: async (config) => {
+      const tsconfigPath = path.resolve(config.root ?? ".", "tsconfig.json");
+      const { baseUrl, paths } = await readConfig(tsconfigPath);
+      if (!baseUrl || !paths) {
+        return config;
+      }
+      const aliasOptions = Object.entries(paths).map(
+        ([alias, replacement]) => ({
+          find: alias.replace("/*", ""),
+          replacement: path.resolve(
+            tsconfigPath,
+            baseUrl,
+            replacement[0].replace("/*", "")
+          )
+        })
+      );
+      if (aliasOptions.length > 0) {
+        log(`Injected ${c.green(aliasOptions.length)} aliases.`);
+      }
+      if (verbose) {
+        aliasOptions.forEach(
+          (alias) => log(
+            `Alias ${c.green(alias.find.toString())} -> ${c.green(
+              alias.replacement
+            )} configured`
+          )
+        );
+      }
+      const existingAlias = transformExistingAlias(config.resolve?.alias);
+      return {
+        ...config,
+        resolve: {
+          ...config.resolve,
+          alias: [...existingAlias, ...aliasOptions]
+        }
+      };
+    }
+  };
+};
+const buildConfig = ({
+  entry,
+  formats,
+  name,
+  externalPackages
+}) => {
+  if (!externalPackages) {
+    log("Externalizing all packages.");
+  }
+  return {
+    name: "vite-plugin-lib:build",
+    enforce: "pre",
+    config: async (config) => {
+      return {
+        ...config,
+        build: {
+          ...config.build,
+          lib: {
+            ...config.build?.lib,
+            entry: path.resolve(config.root ?? ".", entry),
+            formats,
+            name,
+            fileName: (format) => formatToFileName(entry, format)
+          },
+          rollupOptions: {
+            external: externalPackages ?? [/node_modules/, ...module$1.builtinModules]
+          }
+        }
+      };
+    }
+  };
+};
+function formatToFileName(entry, format) {
+  const entryFileName = entry.substring(
+    entry.lastIndexOf("/") + 1,
+    entry.lastIndexOf(".")
+  );
+  if (format === "es") {
+    return `${entryFileName}.mjs`;
+  }
+  if (format === "cjs") {
+    return `${entryFileName}.cjs`;
+  }
+  return `${entryFileName}.${format}.js`;
+}
+function library(options) {
+  return [
+    tsconfigPaths(options),
+    buildConfig(options),
+    dts({
+      cleanVueFileName: true,
+      include: `${path.resolve(options.entry, "..")}**`,
+      outputDir: "dist/types",
+      staticImport: true
+    })
+  ];
+}
+function transformExistingAlias(alias) {
+  if (!alias) {
+    return [];
+  }
+  if (Array.isArray(alias)) {
+    return alias;
+  }
+  return Object.entries(alias).map(([find, replacement]) => ({
+    find,
+    replacement
+  }));
+}
+async function readConfig(configPath) {
+  const configFileText = await promises.readFile(configPath, { encoding: "utf-8" });
+  const { config } = typescript.parseConfigFileTextToJson(configPath, configFileText);
+  const { options } = typescript.parseJsonConfigFileContent(
+    config,
+    typescript.sys,
+    path.dirname(configPath)
+  );
+  return options;
+}
+
+exports.dts = dts__namespace;
+exports.library = library;
+exports.tsconfigPaths = tsconfigPaths;

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import { LibraryFormats, Plugin } from 'vite';
+import * as vitePluginDts from 'vite-plugin-dts';
+export { vitePluginDts as dts };
+
+interface Options {
+    name: string;
+    entry: string;
+    formats?: LibraryFormats[];
+    externalPackages?: (string | RegExp)[];
+    verbose?: boolean;
+}
+declare const tsconfigPaths: ({ verbose }?: Partial<Options>) => Plugin;
+declare function library(options: Options): Plugin[];
+
+export { Options, library, tsconfigPaths };

package/dist/index.mjs

@@ -0,0 +1,136 @@
+import { readFile } from 'fs/promises';
+import { builtinModules } from 'module';
+import path from 'path';
+import c from 'picocolors';
+import { parseConfigFileTextToJson, parseJsonConfigFileContent, sys } from 'typescript';
+import dts__default from 'vite-plugin-dts';
+import * as dts from 'vite-plugin-dts';
+export { dts };
+
+function log(text) {
+  console.log(`${c.cyan("[vite:lib]")} ${text}`);
+}
+const tsconfigPaths = ({ verbose } = {}) => {
+  return {
+    name: "vite-plugin-lib:alias",
+    enforce: "pre",
+    config: async (config) => {
+      const tsconfigPath = path.resolve(config.root ?? ".", "tsconfig.json");
+      const { baseUrl, paths } = await readConfig(tsconfigPath);
+      if (!baseUrl || !paths) {
+        return config;
+      }
+      const aliasOptions = Object.entries(paths).map(
+        ([alias, replacement]) => ({
+          find: alias.replace("/*", ""),
+          replacement: path.resolve(
+            tsconfigPath,
+            baseUrl,
+            replacement[0].replace("/*", "")
+          )
+        })
+      );
+      if (aliasOptions.length > 0) {
+        log(`Injected ${c.green(aliasOptions.length)} aliases.`);
+      }
+      if (verbose) {
+        aliasOptions.forEach(
+          (alias) => log(
+            `Alias ${c.green(alias.find.toString())} -> ${c.green(
+              alias.replacement
+            )} configured`
+          )
+        );
+      }
+      const existingAlias = transformExistingAlias(config.resolve?.alias);
+      return {
+        ...config,
+        resolve: {
+          ...config.resolve,
+          alias: [...existingAlias, ...aliasOptions]
+        }
+      };
+    }
+  };
+};
+const buildConfig = ({
+  entry,
+  formats,
+  name,
+  externalPackages
+}) => {
+  if (!externalPackages) {
+    log("Externalizing all packages.");
+  }
+  return {
+    name: "vite-plugin-lib:build",
+    enforce: "pre",
+    config: async (config) => {
+      return {
+        ...config,
+        build: {
+          ...config.build,
+          lib: {
+            ...config.build?.lib,
+            entry: path.resolve(config.root ?? ".", entry),
+            formats,
+            name,
+            fileName: (format) => formatToFileName(entry, format)
+          },
+          rollupOptions: {
+            external: externalPackages ?? [/node_modules/, ...builtinModules]
+          }
+        }
+      };
+    }
+  };
+};
+function formatToFileName(entry, format) {
+  const entryFileName = entry.substring(
+    entry.lastIndexOf("/") + 1,
+    entry.lastIndexOf(".")
+  );
+  if (format === "es") {
+    return `${entryFileName}.mjs`;
+  }
+  if (format === "cjs") {
+    return `${entryFileName}.cjs`;
+  }
+  return `${entryFileName}.${format}.js`;
+}
+function library(options) {
+  return [
+    tsconfigPaths(options),
+    buildConfig(options),
+    dts__default({
+      cleanVueFileName: true,
+      include: `${path.resolve(options.entry, "..")}**`,
+      outputDir: "dist/types",
+      staticImport: true
+    })
+  ];
+}
+function transformExistingAlias(alias) {
+  if (!alias) {
+    return [];
+  }
+  if (Array.isArray(alias)) {
+    return alias;
+  }
+  return Object.entries(alias).map(([find, replacement]) => ({
+    find,
+    replacement
+  }));
+}
+async function readConfig(configPath) {
+  const configFileText = await readFile(configPath, { encoding: "utf-8" });
+  const { config } = parseConfigFileTextToJson(configPath, configFileText);
+  const { options } = parseJsonConfigFileContent(
+    config,
+    sys,
+    path.dirname(configPath)
+  );
+  return options;
+}
+
+export { library, tsconfigPaths };

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "vite-plugin-lib",
+  "version": "1.0.0",
+  "description": "Vite plugin for build configuration, automatic aliases, and type declarations.",
+  "author": "Jan Müller <janmueller3698@gmail.com>",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/DerYeger",
+  "homepage": "https://github.com/DerYeger/yeger/tree/main/packages/vite-plugin-lib",
+  "repository": "github:DerYeger/yeger",
+  "bugs": {
+    "url": "https://github.com/DerYeger/yeger/issues"
+  },
+  "keywords": [
+    "vite-plugin",
+    "declarations",
+    "library",
+    "aliases"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "peerDependencies": {
+    "typescript": "*",
+    "vite": "^2.0.0 || ^3.0.0 || ^4.0.0"
+  },
+  "dependencies": {
+    "picocolors": "1.0.0",
+    "vite-plugin-dts": "1.7.1"
+  },
+  "devDependencies": {
+    "@types/node": "18.11.13",
+    "@vitest/ui": "0.26.2",
+    "typescript": "4.9.4",
+    "unbuild": "1.0.2",
+    "vite": "4.0.0",
+    "@yeger/tsconfig": "1.1.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "lint": "yeger-lint",
+    "check:tsc": "tsc --noEmit"
+  }
+}