say-yo

A simple npm package that says "Yo!!" whenever you want it to.

Installation

npm install say-yo

Usage

import { Speaker } from 'say-yo';

const speaker = new Speaker();
speaker.sayYo(); // console logs "Yo!!"

API

Speaker

The main class exported by the package.

Methods

• sayYo(): void - Logs "Yo!!" to the console.

Development

Prerequisites

• Node.js >= 18
• npm >= 9

Setup

# Install dependencies
npm install

# Build the package
npm run build

# Run tests
npm test

# Lint code
npm run lint

# Format code
npm run format

Project Structure

say-yo/
├── src/
│   ├── Speaker.ts          # Main Speaker class
│   ├── index.ts            # Package entry point
│   └── __tests__/
│       └── Speaker.test.ts # Unit tests
├── dist/                   # Compiled output (generated)
├── .gitlab-ci.yml          # CI/CD pipeline configuration
├── .releaserc.json         # Semantic release configuration
├── package.json
├── tsconfig.json
└── README.md

CI/CD Pipeline

This package uses semantic-release for automated versioning and publishing.

Branch Strategy

• main - Production releases with latest tag
• staging - Pre-releases with staging tag

Release Process

Staging Releases

When code is merged to the staging branch:

1. Tests and linting are run
2. Package is built
3. A pre-release version is published with the staging tag (e.g., 1.0.0-staging.1)

npm install say-yo@staging

Production Releases

When code is merged to the main branch:

1. Tests and linting are run
2. Package is built
3. A production version is published with the latest tag (e.g., 1.0.0)
4. The staging branch is automatically synced with main

npm install say-yo
# or
npm install say-yo@latest

Commit Message Convention

This package follows the Conventional Commits specification:

• feat: - A new feature (triggers minor version bump)
• fix: - A bug fix (triggers patch version bump)
• docs: - Documentation changes
• chore: - Maintenance tasks
• test: - Adding or updating tests
• refactor: - Code refactoring
• BREAKING CHANGE: - Breaking changes (triggers major version bump)

Examples:

feat: add new greeting method
fix: correct console output formatting
docs: update usage examples
BREAKING CHANGE: rename Speaker class to Greeter

License

MIT

Author

Created as a sample npm package demonstrating CI/CD with changeset.