Creating NPM Package with React TypeScript

Introduction

1. Welcome to NPM Package!
2. How This Book Can Help You
3. The Roadmap
4. Dependencies
5. Prerequisite
6. Questions and Comments
7. Let’s Get It Started!

Project Configuration

1. 1. Set Up Your System
2. 2. Create a Project Directory
3. 3. Create a package.json File
4. 4. Initialize a Git Repository
5. 5. Specify the Files Git Should Ignore
6. 6. Stage and Commit Your Project’s Changes to Git
7. 7. Configure a GitHub Remote Repository
8. 8. Push Your Local Git Directory to the Remote Repo
9. 9. Install React and TypeScript
10. 10. Configure the TypeScript Compiler

Testing React Component

1. 1. Install the Testing Tools
2. 2. Specify Jest as Your Project’s Test Runner Tool
3. 3. Configure Jest to Test TypeScript Code
4. 4. Configure Jest to Compile TypeScript Files
5. 5. Configure Jest’s Testing Environment
6. 6. Create Your Code Files
7. 7. Write Your Test Case
8. 8. Develop Your React Component
9. 9. Run the Test

Commit Message Configuration

1. Conventional Commits Message Syntax
2. Enforcing the Conventional Commits Format
3. Setting Up Husky
4. Creating a Hook to Auto-Lint Commit Messages

Setting Up Commitlint GitHub Action

1. 1. Create a Commitlint GitHub Action Workflow File
2. 2. Define the Commitlint GitHub Action Workflow
3. 3. Test the Commitlint GitHub Action Workflow

Styling React Components

1. 1. Create the Stylesheet
2. 2. Apply CSS Styles to Your Component
3. 3. Load CSS Files into Jest’s JSDOM
4. 4. Run the Test

Compiling React to JavaScript

1. How to Compile Both ECMAScript and CommonJS Modules

Distinguishing Source and Distribution Code

Specify Items to Compile

Defining Package’s Entry Point

Specifying Package’s Declaration File

Local Testing of Unpublished Package

1. 1. Link-Install Your Package Globally in Your System
2. 2. Create a NextJS Demo Website for Testing Your Package
3. 3. Install Your Package from Your System’s Global Folder to the Test-App
4. 4. Configure Turbopack to Resolve Symlinks
5. 5. Use the Link-Installed Package in Your Test-App
6. 6. Unlink Your Package from the Test-App
7. 7. Unlink Your Package from the Global Folder

Creating README

Creating LICENSE

Publishing Package to NPM

1. 1. Search Engine Optimization (SEO)
2. 2. Specify the Files You Want to Publish to NPM
3. 3. Confirm the Files NPM Will Publish
4. 4. Confirm That Your Package Have Passing Tests
5. 5. Compile Any Pending Code
6. 6. Stage and Commit Any Recent Changes
7. 7. Push Your Local Git Directory to the Remote Repo
8. 8. Sign In or Sign Up on the NPM Website
9. 9. Log In to NPM via the Terminal
10. 10. Confirm If Your Package’s Name Is Available
11. 11. Publish Your Package!

Local Testing of the Published Package

1. 1. Install the Package
2. 2. Import the Package
3. 3. Run Your Local Server

Production Testing of the Published Package

1. 1. Stage and Commit Your Changes
2. 2. Set up a GitHub Remote Repository for Your Next.js Test App
3. 3. Push Your Local Git Directory to the Remote Repo
4. 4. Sign In or Create an Account on the Vercel Website
5. 5. Deploy Your Project to Vercel
6. 6. Test the Package on Your Live Demo Website

Updating Package’s Versions

1. Example 1: Updating to a Patch Version
2. Example 2: Updating to a Minor Version
3. Example 3: Updating to a Major Version

Automating Version Management

1. 1. Create a Release GitHub Action Workflow File
2. 2. Define the Release GitHub Action Workflow
3. 3. How to Overwrite semantic-release’s Default Configurations
4. 4. Remove the dist Folder Before Building in the Development Environment
5. 5. Notify Developers That the Package Uses Automated Version Management

NPM Trusted Publishing Configuration

1. Add a New Feature
2. Update an Existing Feature

Automating GitHub Releases

1. Add the Preset Library to Your Release Workflow
2. Configure semantic-release to Automatically Publish the Package’s Release Notes

Epilogue

1. What’s Next?
2. One Last Favor