Major Version with Breaking Changes

Demonstrates handling a major version release with breaking changes, including migration guides, before/after code examples, and an actionable upgrade checklist.

Input

What you provide to the skill

Major v2.0: Dropped Node 14 support, changed import syntax from require to named exports, removed validateSync method, added TypeScript definitions, 3x faster validation

Output

What the skill generates for you

Version 2.0.0 - Major Update

Breaking Changes: Review migration guide before updating.

Highlights

TypeScript Support

Full TypeScript definitions now included. Get autocomplete, type checking, and better IDE integration out of the box.

import { validate, Schema } from 'package-name';
const result = await validate(data, schema);

3x Faster Validation

Performance improved by 200% through internal optimizations, making validation significantly faster in production workloads.

Breaking Changes & Migration

Node.js Version

Old: Node 14+
New: Node 16+

Action: Update Node.js to version 16 or higher before upgrading.

Import Syntax

Old:

const validator = require('package-name');

New:

import { validate } from 'package-name';
// or for CommonJS:
const { validate } = require('package-name');

Action: Update all imports from default require() to named imports.

Sync Method Removed

Old: validateSync(data, schema)
New: await validate(data, schema)

Action: Replace all validateSync() calls with await validate(). This method now returns a promise, so update calling code accordingly.

Installation

npm install package-name@2.0.0

Migration Checklist

Update Node.js to v16+
Change require() to named imports
Replace validateSync() with async validate()
Test your application thoroughly

Questions?

Released 2024 | Requires Node.js 16+