pkg-typescript-plugin-mantine

Mantine plugin for pkg-typescript

A pkg-typescript plugin that automatically adds Mantine UI library dependencies to your TypeScript projects.

Overview

This plugin simplifies the setup of Mantine UI components in your TypeScript projects by automatically managing the core Mantine dependencies. When applied, it adds the essential Mantine packages with version constraints to ensure compatibility.

What it does

The plugin automatically adds the following Mantine dependencies to your project:

• @mantine/core - Core components and utilities
• @mantine/dates - Date picker and calendar components
• @mantine/form - Form management utilities
• @mantine/hooks - Collection of useful React hooks
• @mantine/modals - Modal management system
• @mantine/notifications - Notification system

All dependencies are pinned to version ^8.1.3 to ensure compatibility.

Installation

This plugin is designed to work with the pkg-typescript ecosystem. Install it as a dev dependency:

npx pkg-ts add-plugin mantine

Usage

Configure the plugin in your pkg-typescript configuration:

export default {
  plugins: ['mantine'],
}

The plugin accepts an empty configuration object {} and will automatically configure the Mantine dependencies for your project.

Plugin Implementation

import { PluginFunction } from 'pkg-typescript'
import { PluginConfig, PluginExtra } from './PluginConfig'

const pluginFunction: PluginFunction<PluginConfig, PluginExtra> = ({}) => ({
  dependencies: {
    '@mantine/core': [8, 1, 3],
    '@mantine/dates': [8, 1, 3],
    '@mantine/form': [8, 1, 3],
    '@mantine/hooks': [8, 1, 3],
    '@mantine/modals': [8, 1, 3],
    '@mantine/notifications': [8, 1, 3],
  },
})

export default pluginFunction
export type { PluginConfig }

Development

To build the plugin:

npm run pkg:build

To publish a new version:

npm version patch  # or minor/major

The postversion script will automatically publish, commit, and push the changes.

License

ISC