vite-plugin-sdk

Vite plugin to bundle SDKs.

• 🏭  Bundle for everyone with ESM and CJS;
• 🛠  Extensible thanks to defu;
• ⚡  Quick install and maintainability.

Install

npm install --save-dev vite-plugin-sdk

Documentation

vite-plugin-sdk adapts Vite to bundle SDKs for distribution.

Usage

// vite.config.js
import sdk from "vite-plugin-sdk";

export default {
	plugins: [sdk(/* options */)],
};

Options

{
	/**
	 * `package.json` to create config from.
	 *
	 * @defaultValue First `package.json` found from the current working directory and up.
	 */
	packageJSON: PackageJSON;

	/**
	 * Whether or not to generate type declarations in the build.
	 *
	 * @defaultValue `true`
	 */
	dts: boolean;

	/**
	 * A list of dependencies to ignore from Rollup's `external` option.
	 *
	 * @defaultValue `[]`
	 */
	internalDependencies: string[]

	/**
	 * Directory to consider as the root `src` directory
	 *
	 * @defaultValue `src`
	 */
	srcDir: string
}

To discover what's new on this package check out the changelog.

Packages using vite-plugin-sdk

Find examples of vite-plugin-sdk in the real world.

• @prismicio/client - The official JavaScript + TypeScript client library for Prismic.
• @prismicio/richtext - A parser and serializer for Prismic's Rich Text format.
• @prismicio/react - React components and hooks to fetch and present Prismic content.
• @prismicio/next - Helpers to integrate Prismic into Next.js apps.
• @prismicio/vue - Vue plugin, components, and composables to fetch and present Prismic content.
• eleventy-plugin-prismic - Eleventy plugin and shortcodes to fetch and present Prismic content.
• r19 - Simple remote procedure calls (RPC) in TypeScript.
• nuxt-hue - Enlighten your Nuxt applications.

Contributing

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Prismic developer community!

Asking a question: Open an issue explaining what you want to achieve / your question. Our support team will get back to you shortly.

Reporting a bug: Open an issue explaining your application's setup and the bug you're encountering.

Suggesting an improvement: Open an issue explaining your improvement or feature so we can discuss and learn more.

Submitting code changes: For small fixes, feel free to open a pull request with a description of your changes. For large changes, please first open an issue so we can discuss if and how the changes should be implemented.

For more clarity on this project and its structure you can also check out the detailed CONTRIBUTING.md document.

License

Copyright 2013-2022 Prismic <[email protected]> (https://prismic.io)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.