# lib-template

**Repository Path**: mengqing/lib-template

## Basic Information

- **Project Name**: lib-template
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-17
- **Last Updated**: 2024-12-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# lib-template

## Usage

1. copy to new project
2. npx changeset init
3. update [package.json, scripts/const.js, .changeset/config.js]
4. pnpm install
5. .github workflows

**publish :**

```bash
# 1. build
pnpm build <lib-name>

# 2. test
pnpm test <lib-name>

# 3. changelog
pnpm changeset # 创建变更集
pnpm changeset:version # 生成版本号
pnpm changelog <lib-name> --push # 生成变更记录并push

# 4. publish
# github-action auto publish
```

## Scripts

### build

```bash
pnpm build --help

pnpm build [name] --clean
```

### test

```bash
pnpm test [name]
pnpm test [name] -- --coverage
```

### changelog

```bash
pnpm changelog --help

pnpm changelog [name] --push
```

## Module config

```js
// config.js
{
  name: 'Draggable',
  input: 'src/index.ts',
  formats: ['cjs','esm', 'umd'],
  external: ['react','react-dom'],
  globals: {
    react: 'React',
   'react-dom': 'ReactDOM'
  },
  target: 'es2015',
  outDir: 'dist',
  filename: 'index'
}
```

```js
//package.json
{
  "browserslist": "> 0.25%, not dead", // > 0.25%, not dead, IE >= 11
  // 配置入口, 同 config.js
  "buildOptions": {
    "input": "index.ts",
    "name": "LibName"
  }
}
```

## Tests

```bash
npm install --save-dev jest @types/jest @testing-library/jest-dom
```