@letanure/npm-package-demo
v1.0.1
Published
A demo package
Downloads
61
Readme
npm-package-demo
A demo package built with TypeScript.
Installation
npm install npm-package-demo
or
yarn add npm-package-demo
Scripts
build
: Compile TypeScript filesci
: Run build, linting, and testslint:all
: Run all linting scriptslint:exports
: Check exports using @arethetypeswrong/clilint:format:fix
: Format code using Biomelint:format
: Check code formatting using Biomelint:ts
: Type-check TypeScript filesprepublishOnly
: Run CI checks before publishingrelease:local
: Version and publish changes locallytest:all
: Run all teststest:unit:run
: Run tests using Vitesttest:unit:watch
: Run tests in watch mode
Development
- Clone the repository:
git clone https://github.com/letanure/npm-package-demo.git
- Install dependencies:
pnpm install
- Make your changes
- Run tests:
pnpm test:all
- Build the package:
pnpm build
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the MIT License.
Acknowledgements
Thanks to Matt Pocock (@mattpocockuk) for his article on How to Create an NPM Package