Welcome to Create Monokle Plugin

Use this library to scaffold your custom Monokle validation plugin in seconds - which can then be used locally or contributed to our Monokle Community Plugins repository.

Read more about custom plugins in the Custom Validator documentation

Usage

Prerequisite: it's recommended to use NodeJs LTS or higher and NPM 7+.

Interactive

Running in interactive mode:

npm create monokle-plugin@latest

will prompt for:

✔ Plugin name: … my-validation-plugin
✔ Select a plugin type: › validation
✔ Select a variant: › validation-ts
✔ Select a template: › basic

Scaffolding plugin in /Users/olensmar/WebstormProjects/monokle-core/packages/create-monokle-plugin/my-validation-plugin...

Done. Now run:

  cd my-validation-plugin
  npm install
  npm run dev

Now you're all set to implement your Custom Plugin

Create a TypeScript validation plugin

npm create monokle-plugin@latest my-validator -- --template validation-ts

Sharing plugins

Head over to the Monokle Community Plugins repo to see existing community plugins and learn how you can create and share your own.

Acknowledgements

This project is a modified version of create-vite and most credits go to them.