Skip to content

kevinkosterr/field-template

Repository files navigation

Field template

A template repository to start creating fields for vue3-form-generator faster.

Checklist

  • Run pnpm install;
  • Remove pnpm-lock.yaml from .gitignore;
  • Change name in package.json and vite.config.ts;
  • Change main in package.json;
  • Rename field in src/components (best to refactor using an IDE to immediately fix imports);
  • Change release.tagFormat in package.json if desired;
  • Configure release.yml in .github/workflows.

Development

To run your development playground use:

pnpm run dev

To build your field component run:

pnpm run build

To run tests, execute:

pnpm run test

Publishing your component

Publishing your component can be done manually via the command line or through GitHub Actions. This template repository already comes with a basic setup with semantic-release which will publish a new release when you push to the production branch (you'll have to create one yourself).

Semantic release automatically updates the version property in package.json based on your commits. It is highly recommended you do some research on how it works before adding commits to your repository.