Shoulder Plugins

📖 INTRODUCE 中文_Chinese

a maven plugin which can generate manuals of error code info and i18n resource files automatically.

technical under shoulder-framework shoulder-core i18n.

---

🚀 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.1</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.

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 in shoulder-framework-demo1.

2. See automatically generated i18n resource files in shoulder-framework.

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

❓ FAQ

Q: What is shoulder-framework?

• A: a fantastic framework based on Spring BOOT.

💗 Contribute

It's open for contribution，code format, java doc, comment, bugfix, new feature，See more in How to contribute.

🤝🏼 Contact us

Thanks for your Star 、 Fork 、 PR.

Contact us with github issue or email to cn_lym@foxmail.com, waiting for any suggestions or discussion~