https://github.com/gwinnem/vite-vue-package-skeleton
Starter template for building vue component libraries with VUE 3 and Typescript, running on vite.
https://github.com/gwinnem/vite-vue-package-skeleton
npm-package-template starter-template template typescript vite vue vue3
Last synced: 2 months ago
JSON representation
Starter template for building vue component libraries with VUE 3 and Typescript, running on vite.
- Host: GitHub
- URL: https://github.com/gwinnem/vite-vue-package-skeleton
- Owner: gwinnem
- License: isc
- Created: 2022-12-07T11:44:40.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-06T14:06:29.000Z (over 2 years ago)
- Last Synced: 2025-01-25T09:08:57.763Z (4 months ago)
- Topics: npm-package-template, starter-template, template, typescript, vite, vue, vue3
- Language: TypeScript
- Homepage:
- Size: 541 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# vite-vue-package-skeleton
Starter template for building vue component libraries with VUE 3 and Typescript, running on vite.
## Setting up vite-vue-package-skeleton in your project
```
npm install vite-vue-package-skeleton
```
## Steps to set up your custom npm package
1. Configure your package.json file with correct name, description, author, and change 'vite-vue-package-skeleton' with the desired package name.
2. Configure build/rollup.config with the name and package file name that you did set up in package.json.
3. Search for the // TODO comment and make the required changes.
4. Clean up the unused example implementation, abd Start building your own components (similar to ExampleComponent).
## Future Development on your package
You can run the library in a standalone mode for development purposes, following these steps:
#### Installing external dependencies
```
npm install
```
#### Compiles and hot-reloads for development
```
npm run dev
```
#### Uses Vite to build our component library (compiles .vue files to .js) and call build:types script.
```
npm run build
```
#### Generate TypeScript declaration files for our .vue files (this is using vue-tsc).
```
npm run build:types
```
#### Running type checking on .ts files (this is using vue-tsc).
```
npm run typeCheck
```
#### Running Eslint
```
npm run lint
```
#### Running Eslint with --fix option
```
npm run lint:fix
```
#### Running Style linting
```
npm run lint:style
```
#### Auditing the package
```
npm audit --registry=https://registry.npmjs.org/
```
### Testing the npm package before publishing
[Howto](./docs/testing-package.md)
### Publishing the library
[Howto](./docs/build.md)