# shoulder-plugins

**Repository Path**: ChinaLym/shoulder-plugins

## Basic Information

- **Project Name**: shoulder-plugins
- **Description**: Shoulder-Framework 定制的 Maven 插件。帮助使用者轻松编写符合 优雅编码规约 的代码
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/ChinaLym/shoulder-framework
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2020-07-24
- **Last Updated**: 2025-04-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Java, Maven

## README

<h1 align="center"><img src="doc/img/shoulder_plugin_svg_logo.svg" height="40" width="40" /><a href="https://github.com/ChinaLym/shoulder-plugins" target="_blank">Shoulder Plugins</a></h1>

[![AUR](https://img.shields.io/badge/license-Apache%20License%202.0-yellow.svg)](https://github.com/ChinaLym/shoulder-framework)
[![](https://img.shields.io/badge/Author-lym-yellow.svg)](https://github.com/ChinaLym)
[![](https://img.shields.io/badge/CICD-PASS-green.svg)](https://github.com/ChinaLym/shoulder-framework)

[![](https://img.shields.io/badge/Latest%20Version-1.2.2-blue.svg)](https://github.com/ChinaLym/shoulder-plugins)

# 📖 INTRODUCE [中文_Chinese](README_ZH.md)
a maven plugin which can **generate manuals of error code info and i18n resource files automatically**.

technical under [shoulder-framework](https://github.com/ChinaLym/shoulder-framework) [shoulder-core i18n](https://github.com/ChinaLym/shoulder-framework/blob/master/shoulder-build/shoulder-base/shoulder-core/README.md#%E7%BF%BB%E8%AF%91%E4%B8%8E%E5%A4%9A%E8%AF%AD%E8%A8%80).

---

# 🚀 Quick Start

add dependency to your project
```
    <build>
        <plugins>
        
            <!-- shoulder plugin -->
            <plugin>
                <groupId>cn.itlym.shoulder</groupId>
                <artifactId>shoulder-maven-plugin</artifactId>
                <version>1.2.2</version>
                <executions>
                    <execution>
                        <!-- active plugin when mvn complie -->
                        <phase>compile</phase>
                        <goals>
                        <!-- enable generate error code info-->
                            <goal>generateErrorCodeInfo</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            
        </plugins>
    </build>
```

More user cases see [plugin introduce](plugins/errcode-maven-plugin/README.MD).

### Ability

- generate i18n resource files according to code comments to support multi language.
- generate manuel of error code to error code query system which aimed support clients query reason or suggestion of an error code. 
- ....

### Example

1. See [handmade i18n resource files](https://github.com/ChinaLym/shoulder-framework-demo/blob/main/demo1/src/main/resources/language/zh_CN/messages.properties)  in [shoulder-framework-demo1](https://github.com/ChinaLym/shoulder-framework-demo/tree/main/demo1).
   ![manual.png](doc/img/manual.png)

2. See automatically generated i18n resource files in [shoulder-framework](https://github.com/ChinaLym/shoulder-framework/blob/master/shoulder-build/shoulder-base/shoulder-core/pom.xml).

> `shoulder-core` used this plugin，it will generated i18n resource files and error code files automatically while `mvn compile`.

![shoulder-usecase.png](doc/img/shoulder-usecase.png)

# ❓ FAQ

**Q:** What is [shoulder-framework](https://github.com/ChinaLym/shoulder-framework)?
- **A:** a fantastic framework based on [Spring Boot](https://github.com/spring-projects/spring-boot).

# 💗 Contribute

It's open for contribution，`code format`, `java doc`, `comment`, `bugfix`, `new feature`，See more in [How to contribute](CONTRIBUTING.MD).

# 🤝🏼 Contact us

Thanks for your **[Star](https://gitee.com/ChinaLym/shoulder-framework/star)** 、 **Fork** 、 **PR**.

Contact us with `github issue` or [email to cn_lym@foxmail.com](mailto:cn_lym@foxmail.com), waiting for any suggestions or discussion~