# `@deppon/deppon-norm`

前端规范工具包

## 安装

```bash
npm install @deppon/deppon-norm
```

## 基础使用

### JavaScript/TypeScript 项目

```javascript
import { commit, note, start, stylelint } from '@deppon/deppon-norm';

// 使用 commit
commit('commit message');

// 使用 note
note('note message');

// 使用 start
start('start message');

// 使用 stylelint
stylelint('stylelint message');
```

## Vue 3 使用

### 1. 安装插件

在 Vue 应用中安装插件：

```javascript
import { createApp } from 'vue';
import { VuePlugin } from '@deppon/deppon-norm';

const app = createApp(App);

// 安装插件
app.use(VuePlugin);

app.mount('#app');
```

### 2. 在 Composition API 中使用

```vue
<script setup>
import { useNorm } from '@deppon/deppon-norm';

const norm = useNorm();

const handleCommit = () => {
    norm.commit('commit message');
};

const handleNote = () => {
    norm.note('note message');
};

const handleStart = () => {
    norm.start('start message');
};

const handleStylelint = () => {
    norm.stylelint('stylelint message');
};
</script>

<template>
    <button @click="handleCommit">Commit</button>
    <button @click="handleNote">Note</button>
    <button @click="handleStart">Start</button>
    <button @click="handleStylelint">Stylelint</button>
</template>
```

### 3. 在 Options API 中使用

```vue
<script>
export default {
    methods: {
        handleCommit() {
            // 通过 this.$norm 访问
            this.$norm.commit('commit message');
        },
        handleNote() {
            this.$norm.note('note message');
        },
        handleStart() {
            this.$norm.start('start message');
        },
        handleStylelint() {
            this.$norm.stylelint('stylelint message');
        },
    },
};
</script>
```

## API

### Composition API

-   `useNorm()` - 获取 norm 实例

### 方法

-   `commit(param1)` - Commit 方法
-   `note(param1)` - Note 方法
-   `start(param1)` - Start 方法
-   `stylelint(param1)` - Stylelint 方法

更多 API 请参考源码。