@wix/vibe-forms-plugin-files 0.32.1 → 0.32.2

package/README.md

@@ -1,47 +1,22 @@
-## Implement components
 
-1. first implement your headless compoenents
-2. implement your componeents / ui components / pages, add them under `src/componenets/forms` and `src/componenets/ui/forms`. use your headless compoenents to implement your components
-3. headless / ui (shadcn) guidelines: https://github.com/wix-incubator/headless-components/blob/main/docs/api/API.md
+# Wix Vibe Forms Plugin Files
 
-Notes:
-Make sure your headless sdk packages (i.e. @wix/stores) are part of picasso main template package.json here: https://github.com/wix-private/picasso/blob/master/packages/picasso-template-image/main/package.json, otherwise PR or ask the picasso team to add them. Make sure it is a version that includes your headless components.
+Produces a `.zip` file with ready to use Forms components.
 
+## Development
 
-# Test build of zip files to be used by plugin module:
-- build of this package should use something like `node scripts/build-zip.js` - it should only compress `compoentns/<forms>` and `components/ui/<forms>` folders.
-  - Do not zip folders which do not include your vertical name.
-- Verify that a zip file is created successfully in dist/statics/
-- Verify that the zip is exported properly in index.js as `zipPath`
-- Note that the files and plugin packages are published to the public npm registry so bump the files' package version manually as the bump strategy is manual.
-- merge to master and make sure a new package is published (public npm registry)
-- use this package in `forms-plugin` and use the zip file from there to be used during the "install" step and copy the files over to the picasso template in runtime
-  - In Falcon the dependency is resolved from the workspace but do this in order to verify it would work in Picasso too
+```bash
+# Install dependencies
+yarn install
 
-## Testing over Wix Vibe main template:
+# Build the plugin
+yarn build
 
-1. `npm run reset-template` (re-run this to reset it)
+# Fix linting issues
+yarn lint:fix
+```
 
-brings and resets the main Wix Wibe template for you to test your components over
+## Publishing new version
 
-1. `npm run bootstrap`
+Publish new version by bumping the package version in `package.json` manually. The version should be bumped for *all* forms plugins.
 
-This will initialize your dev site for your module:
-- Create a site
-- Create a headless component
-- Create a dev center component and install on the site
-- Create a wix.config.json (which you can commit and push, preferably add other team member as collaboratoes so they can access it too)
-- Create a .env.local file connected to your new site and app (this should not be pushed to Git)
-  - In CI CD flow use [fire console](https://wix-bo.com/fire-console?artifact=com.wixpress.devcenter.apikeys.api-keys&service=com.wixpress.devcenter.apikeys.ApiKeys&method=CreateApiKey&body=%7B%22scopes%22%3A%5B%22SCOPE.WIX_CLI.ALL%22%5D%2C%22type%22%3A%22API_KEY%22%2C%22name%22%3A%22VerticalTestingApiKey%22%7D) in order to generate an API key you can use in order to perform login with `npx wix login --api-key <API KEY YOU GOT>` command
-- The site will serve as the site you use in order to view the business information you see when running locally
-
-
-1. `npm run template-dev`
-
-Start the dev server allowing you to start coding, the repo is equipped with a set of cursor rules allowing you to develop the headless component easier, you can adjust them to your liking
-
-1. `npm run template-check && npm run template-build` - to make sure there all your components play nicely over the Wix Vibe template
-
-# Testing your instructions with LLM (WIP):
-1. open as an individual cursor project
-1. ask agent: integrate all page components in src/components/forms to the main router. implement homepage.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/vibe-forms-plugin-files",
-  "version": "0.32.1",
+  "version": "0.32.2",
   "main": "index.js",
   "unpkg": true,
   "files": [
@@ -176,5 +176,5 @@
     "vite-tsconfig-paths": "^5.1.4",
     "vitest": "3.1.4"
   },
-  "falconPackageHash": "def371c7bab173db82334fbd19f94db69a254dc4d3efbc972ee31f50"
+  "falconPackageHash": "9a19a973ef4bf39ad4c9276941ebadb11e90763bc916e8ed1ccb81bd"
 }