MVP

Certainly! Here's a draft for the release notes for your package, Package.json Type Helper:

---

Release Notes: Package.json Type Helper

Introduction

Package.json Type Helper is a dedicated utility designed to enhance the development of design systems in Storybook and React environments. This tool is specifically tailored to address issues caused by the type property in package.json, which can disrupt the development and deployment workflow.

Features

• Manage type Property: Provides a command-line utility to efficiently handle the type property in your package.json.
• Flexible Options:
  • Remove the type property entirely.
  • Remove the type property conditionally based on the specified branch.
  • Set a custom type value as needed.
  • Default to commonjs if the type is missing.

Installation

• NPM: npm install @devlander/package-json-helper
• Yarn: yarn add @devlander/package-json-helper

Usage

• Script Integration: Include the utility in your package.json scripts for ease of use.
• Command-Line Options: Supports various flags (--type, --removeType, --removeTypeOnBranch, --branch) for customized usage.
• Example Script Configurations:
  • Update Package Type: node ./package-type-helper.cjs
  • Set Type to CommonJS: yarn run update-package-type -- --type commonjs
  • Remove Type: yarn run update-package-type -- --removeType
  • Storybook Integration: yarn run removeTypeFromPackage && storybook build && storybook dev

Notes

• Project Root Requirement: Run this utility from the root directory of your project where the package.json file is located.
• Compatibility: Designed to work seamlessly with Storybook and npm.