This is a template for TypeScript esm-only library projects. It includes a set of guidelines and configurations to help you get started quickly and maintain a consistent codebase.
Churn out your own TypeScript libraries with this template - like hotcakes!
This project is structured to support TypeScript library development with a focus on modularity, tree-shaking, and maintainability. Key directories include:
lib/: Contains the library source codeexample/: Contains example applications demonstrating how to use the librarydocs/: Contains documentation files
In addition, the project uses npm workspaces to manage dependencies across multiple packages, allowing for efficient development and testing.
There is also a simple GitHub action setup to run tests and build the library on every push to the main branch. This ensures that the code remains stable and functional. Additionally, it includes lables configuation and a basic issue template to help users report issues effectively.
To get started with this template, use GitHub's "Use this template" button to create a new repository based on this template. Then, clone your new repository and install the dependencies.
git clone your-new-repo
cd your-new-repo
npm installThe code contains fill-me placeholders that you should replace with your own library name and description. This will help you quickly set up your project with the correct branding and information.
This project is licensed under the MIT License. You can freely use, modify, and distribute this template as per the terms of the license.