neon-vue-test-pkg-6

vue-typescript-package-starter

Fork this repository and start your development here with all the main things you need to develop a custom vue and typescript package.

Main files

docs/
├── app.vue
├── index.html
└── index.ts
src/
├── index.ts        (exporting components)
├── MyComponent     (Our vue component that we want to develop)
├── Readme.md       (Readme file for the documentation we prepared for our component)
└── shims.d.ts      (helps your IDE to understand what a file ending)

Publish the package

#prepare package information
- Open the package.json folder to edit the package information
- Edit the following information
    - "name":  npm package name,
    - "version": npm package version,
    - "description": npm package description,
    - "main": The main field is a module ID . This field must be start with `dist/` and must be end `.js`,
    - "module": An ECMAScript module ID. This field must be start with `dist/` and must be end `.esm.js`,

#build package
npm run build

#npm login (if you are logged skip this step)
npm login

#publish package
npm publish

License

MIT