@formml/ts-plugin v0.1.1

A TypeScript Language Service Plugin that enables real-time type inference and IntelliSense for FormML Models imported in TypeScript files.

Features

• Real-time type inference for FormML Models
• IntelliSense support (autocompletion, hover info)
• Seamless integration with TypeScript projects
• No code generation required

Installation

1. Install the plugin:

npm install @formml/ts-plugin --save-dev

2. Configure TypeScript to use the plugin in your tsconfig.json:

{
  "compilerOptions": {
    "plugins": [{ "name": "@formml/ts-plugin" }]
  }
}

3. (For VSCode users) Configure VSCode to use the workspace version of TypeScript

Usage

Once installed and configured, you can import FormML files directly in your TypeScript code:

import SignUp from './sign-up.fml'

// Full type information available!
const { $form } = useFormML(SignUp)

Documentation

For more detailed information about FormML and @formml/ts-plugin:

• FormML Documentation
• Why not code generation?
• Using tsc to check FormML Model types

License

MIT © Jindong Zhang