Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gpt-json) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Vite TypeScript NPM Package
Scaffold TypeScript npm packages using this template to bootstrap your next library.
Versions of this template:
- Vite TypeScript library npm package
- Vite JavaScript library npm package
- Rollup JavaScript library npm package
- Rollup TypeScript library npm package
Getting Started
Begin via any of the following:
Press the "Use this template" button
Use degit to execute:
degit github:jasonsturges/vite-typescript-npm-packageUse GitHub CLI to execute:
gh repo create <name> --template="https://github.com/jasonsturges/vite-typescript-npm-package"Simply
git clone, delete the existing .git folder, and then:git init git add -A git commit -m "Initial commit"
Remember to use npm search <term> to avoid naming conflicts in the NPM Registery for your new package name.
Usage
The following tasks are available for npm run:
start: Run Vite in host mode for a local development environment (not included in production build)watch: Run Vite in watch mode to detect changes to files during developmentbuild: Run Vite to build a production release distributable
Development
Vite features a host mode to enables development with real time HMR updates directly from the library via the start script.
To test your library from within an app:
- From your library: run
npm linkoryarn linkcommand to register the package - From your app: run
npm link "mylib"oryarn link "mylib"command to use the library inside your app during development
Development Cleanup
Once development completes, unlink both your library and test app projects.
- From your app: run
npm link "mylib"oryarn link "mylib"command to use the library inside your app during development - From your library: run
npm unlinkoryarn unlinkcommand to register the package
Release Publishing
Update your package.json to next version number, and remember to tag a release.
Once ready to submit your package to the NPM Registry, execute the following tasks via npm (or yarn):
npm run clean— Assure a clean buildnpm run build— Build the packagenpm run build:types— Build API Extractor d.ts declaration
Assure the proper npm login:
npm loginSubmit your package to the registry:
npm publish --access public