Package.json Type Helper: Streamline Your Design System Development

Promote your experience with Package.json Type Helper using our Twitter hashtag, connect on Discord, download from npm, engage in GitHub discussions, follow live updates on Twitch, and stay informed through Twitter and Wakatime stats.

• Share on Twitter:
• Join Discord:
• npm Downloads:
• GitHub Discussions:
• Watch on Twitch:
• Follow on Twitter:
• Wakatime Stats:

Introduction

The Package.json Type Helper is a pivotal utility for developers working with design systems in Storybook and React. It simplifies managing the type property in the package.json file, facilitating seamless development and deployment processes. Ideal for Storybook and React projects, this tool is crucial for npm module releases and streamlines component rendering in Storybook, eliminating common obstacles and enhancing workflow efficiency.

Key Features

• Customizable type Property Management: Effortlessly adjust the type property in package.json for optimized development and deployment.
• Seamless Integration: Compatible with npm scripts or GitHub Actions for straightforward implementation.
• Expo Project Support: Addresses path customization limitations for Expo projects, streamlining bundling and deployment.
• Automated Process: Automates type swapping and main entry file adjustments, minimizing manual intervention.

Getting Started

Installation

Install globally via npm or yarn:

npm install @devlander/package-json-helper
# or
yarn add @devlander/package-json-helper

Usage

The command-line utility allows for flexible package.json type property management. Here's how to use it in your project:

const updatePackageJsonType = require("@devlander/package-json-helper");

const updatePackage = () => {
  // Define your logic here for updating the package type
};

updatePackage();

Incorporate into your package.json scripts for streamlined usage:

"scripts": {
  "storybook": "yarn run removeTypeFromPackage && storybook build && storybook dev"
}

Important Notes

• Root Directory Execution: Ensure execution from your project's root directory for optimal performance.
• License: Open-source under the MIT License. See LICENSE for more details.

Upcoming Features

• Jest tests for utility functions.
• Main entry file swapping.
• CLI tests finalization.