Ganxing NPM | npm.io

ganxing

Languages

Welcome to ganxing, a comprehensive collection of personal programming utilities and components by Gan-Xing. This project is designed to be a versatile toolkit for various development needs, encompassing testing, linting, formatting, and documentation generation.

Getting Started

1.Clone the repository

git clone <https://github.com/Gan-Xing/ganxing.git>
cd ganxing

2.Install the dependencies

Make sure you have Node.js (v18.0.0 or newer) and npm (v8.0.0 or newer) installed. This project recommends using pnpm for managing dependencies, although npm or yarn would work just fine.

pnpm install

Scripts

Here are some scripts provided to help you manage the project:

Testing: Run tests using Jest.

pnpm run test

Linting: Check your code for stylistic and programming errors with ESLint.

pnpm run lint

Formatting: Format your code with Prettier.

pnpm run format

Check Formatting: Check if your code is well formatted.

pnpm run check-format

Cleaning: Delete the `dist` directory to clean old build outputs.

pnpm run clean

Documentation: Generate documentation for your code with TypeDoc.

pnpm run docs

Building: Build your project with Vite.

pnpm run build

Committing Changes: We use Commitizen for formatted commit messages.

pnpm run commit

This command will prompt you for details about the commit which will then be formatted according to conventional commit standards.

Committing Guidelines

We follow the Conventional Commits guidelines for commit messages. When you're ready to commit your changes, run `pnpm run commit` and follow the prompts to generate a formatted commit message.