Skip to content

Latest commit

 

History

History
88 lines (69 loc) · 2.83 KB

README.md

File metadata and controls

88 lines (69 loc) · 2.83 KB
Raw

Fiesta

Maven Central License

A simple java annotations library with compile stage processing.

Required

JDK 1.8 or higher.

Getting Started

To add dependencies on Fiesta using Maven, use the following:

<dependencies>
    <!-- Annotation Module -->
    <dependency>
        <groupId>space.lingu.fiesta</groupId>
        <artifactId>fiesta-annotations</artifactId>
        <version>0.2.1</version>
    </dependency>
    
    <!-- Compile-time Annotation Check Module -->
    <dependency>
        <groupId>space.lingu.fiesta</groupId>
        <artifactId>fiesta-checker</artifactId>
        <version>0.2.1</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

If you don't see warning output when compiling your project via maven, set <showWarnings>true<showWarnings> in the maven-compiler-plugin configuration.

Or using Gradle:

dependencies {
    // Annotation Module
    implementation("space.lingu.fiesta:fiesta-annotations:0.2.1")
    
    // Compile-time Annotation Check Module
    compileOnly("space.lingu.fiesta:fiesta-checker:0.2.1")
}

The compile-time annotation checker module is used to process annotations and output information during compilation.

If you don't need the feature, it's safe not to use the dependency.

After adding dependencies on Fiesta, you can use the @Fiesta annotation to test if it works.

Like this:

@Fiesta
public class Main {
    // other code
}

If you have set all options and dependencies correctly then you can see the message below when compiling:

Hello from the Fiesta!

You can use more annotations, such as @Todo to remind you to continue work on unfinished things, or @Experimental to remind users of the API that this is an experimental API.

Sincerely hope that you can improve your efficiency by using this library!

To report bugs or request a new feature, please open a new issue.

Licence

   Copyright (C) 2022 Lingu

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.