1.0.1 • Published 1 year ago

@letanure/npm-package-demo v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

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 files
  • ci: Run build, linting, and tests
  • lint:all: Run all linting scripts
  • lint:exports: Check exports using @arethetypeswrong/cli
  • lint:format:fix: Format code using Biome
  • lint:format: Check code formatting using Biome
  • lint:ts: Type-check TypeScript files
  • prepublishOnly: Run CI checks before publishing
  • release:local: Version and publish changes locally
  • test:all: Run all tests
  • test:unit:run: Run tests using Vitest
  • test:unit:watch: Run tests in watch mode

Development

  1. Clone the repository:
    git clone https://github.com/letanure/npm-package-demo.git
  2. Install dependencies:
    pnpm install
  3. Make your changes
  4. Run tests:
    pnpm test:all
  5. 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

1.0.1

1 year ago