FinalForm SDK

FinalForm SDK is an npm package that provides a set of tools and utilities for working with forms in JavaScript and TypeScript applications.

Installation

To install the FinalForm SDK, use the following command:

pnpm add @expopulus/finalform-sdk

Usage

Import the FinalForm SDK in your project:

import { FinalForm } from "@expopulus/finalform-sdk";

// Example usage
const form = new FinalForm();

Scripts

The following scripts are available in the package.json:

• build:clean: Cleans the dist folder.

  • Command: pnpm run build:clean
  • Purpose: Cleans the dist folder and then runs your esbuild script (build.mjs) to generate the output files.

• build: Cleans the dist directory and builds the project.

• test: Runs the test suite using Mocha.

  • Command: mocha
  • Purpose: Ensures that everything is working before publishing.

• prepare: Runs the build script.

  • Command: pnpm run build
  • Purpose: Automatically run before npm install locally or before publishing to build the package.

• prepublishOnly: Runs tests and builds the project before publishing.

  • Command: pnpm run test && pnpm run build
  • Purpose: Ensures the package is built and tested before it is published.

• postpublish: Displays a message after publishing.

  • Command: echo 'Package published successfully!'
  • Purpose: Optional script to trigger notifications or logs after publishing.

• release: Publishes the package to npm with public access.

  • Command: pnpm publish --access public
  • Purpose: Publishes the package as public on npm.

Running Tests

To run the tests, use the following command:

pnpm run test

Building the Project

To build the project, use the following command:

pnpm run build

Publishing the Package

Check that Everything is Correct

Ensure that the package builds and tests pass by running:

pnpm run test
pnpm run build

Deploy to NPM

To deploy the npm package, follow these steps:

Publish the package to npm:

pnpm run release

Verify the Package

After publishing, you can verify the package on NPM by running:

npm info @expopulus/finalform-sdk

This will show the details of your published package, ensuring everything is correct.

License

This project is licensed under the MIT License. See the LICENSE file for more details.