1.0.2 • Published 2 years ago

@erniamor/packager v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

Packager

Packager is a minimalist JavaScript library that provide an example for NPM package.

  • 💪 Immutable
  • 📦 No dependancies
  • 👫 All browsers supported
  • ✅ Fully tested
  • 😎 100% covered

Getting Started

Installation

npm install @erniamor/packager

Usage

  1. Import function from package
import { sayHello } from '@erniamor/packager';
  1. Call function with expected arguments
sayHello('Martin'); // return "Hello Martin !"

API

It's easy to use Packager APIs.

sayHello

Say Hello to the name passed in argument

Arguments

name (string) : The name to say hello

Return

(string) : The hello to the name

Example

sayHello('Martin'); // return "Hello Martin !"

Tests

  • Run tests with npm test command
npm run test
  • Run covered tests with npm test-coverage command
npm run test-coverage
  • Open coverage html report
npx http-server ./coverage

And open your browser at http://127.0.0.1:8080


How to deploy to NPM

Print Package files

To see the contents that will be included in the published version of the package.

npx npm-packlist

Print Package details

To see what would be done when actually running the command.

npm publish --dry-run

Publish package

To actually publish the package to npm.

npm publish --access=public

License

Packager is licensed under a MIT License.