Introduction

1. Welcome to Creating NPM Package with TypeScript!
2. Why This Book Will Help You
3. What You’ll Build
4. Use the Right Tools
5. What You Should Know First
6. Got Questions?
7. Let’s Begin!

Project Configuration

1. 1. Setting Up Your System
2. 2. Creating a Project Directory
3. 3. Creating a package.json File
4. 4. Initializing a Git Repository
5. 5. Specifying the Files Git Should Ignore
6. 6. Staging and Committing Your Project’s Changes to Git
7. 7. Configuring a GitHub Remote Repository
8. 8. Uploading Your Local Git Directory to the Remote Repo
9. 9. Installing TypeScript
10. 10. Configuring the TypeScript Compiler

Testing Package’s Code

1. 1. Installing the Testing Tool
2. 2. Specifying Jest as Your Project’s Test Runner Tool
3. 3. Configuring Jest to Test TypeScript Code
4. 4. Configuring Jest to Compile TypeScript Files
5. 5. Setting Up Jest’s Testing Environment
6. 6. Creating Your Code Files
7. 7. Writing Your Test Case
8. 8. Developing the Package’s Code
9. 9. Running 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

Compiling TypeScript to JavaScript

1. How to Compile Both ECMAScript and CommonJS Modules

Distinguishing Between Source Code and Distribution Code

Specifying Items to Compile

Defining Package’s Entry Point

Specifying Package’s Declaration File

Local Testing of Unpublished Package

1. Link-Install Your Package Globally in Your System
2. Creating a Directory for the Demo Website
3. Creating a package.json File
4. Initializing a Git Repository
5. Specifying the Files Git Should Ignore
6. Installing TypeScript
7. Configuring TypeScript
8. Installing Your Package from Your System’s Global Folder to the Test App
9. Using the Link-Installed Package in the Test App
10. Creating the Demo Website’s Homepage
11. Styling the Demo Website’s Elements
12. Installing the Parcel Build Tool
13. Specifying Parcel as Your Website’s Development Server
14. Unlinking Your Package from the Test App
15. Unlinking 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 Demo Test App
3. 3. Upload 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 the 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. 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

Modularizing TypeScript Codebase

1. 1. Identify Independent Elements
2. 2. Split the Elements You Want to Extract into Their Separate Modules
3. 3. Import the Extracted Elements into the tweetButton.ts File
4. 4. Configure Jest to Strip the Extension from Import Statements
5. 5. Release the Latest Version of the Project

Epilogue

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