feat: Introduce hawkeye-maven-plugin

[spencercjh]

RESOLVE #21

[tisonkun]

Thanks for your participantion @spencercjh!

This seems in a good direction. You may depend on the hawkeye-core module and following hawkeye-command and license-maven-plugin to wrap Mojo facades of LicenseChecker, LicenseFormatter and LicenseRemover, separately.

[spencercjh]

@tisonkun I have run ./mvnw spotless:apply but I found that the package import order is still not as same as yours.

[tisonkun]

@spencercjh You're right that I don't add an ImportOrder rule here. Let me fix it today.

[tisonkun]

@spencercjh You can merge #89 and rerun the command above.

[spencercjh]

@spencercjh You can merge #89 and rerun the command above.

done

[tisonkun]

Cool! You may try to add some tests or at least share some evidences tested locally so that we're sure it's a good starting point for Maven plugin support.

[spencercjh]

Cool! You may try to add some tests or at least share some evidences tested locally so that we're sure it's a good starting point for Maven plugin support.

done

[spencercjh]

I will fix wrong tests ASAP.

[tisonkun]

@spencercjh We're not in a hurry so just take your time :D

You can verify the tests locally first.

[spencercjh]

@tisonkun

I found something unexpected on Windows which leads the failure of my tests.

Associated codes are here: https://github.com/korandoru/hawkeye/blob/main/hawkeye-core/src/main/java/io/korandoru/hawkeye/core/header/Header.java#L110-L116

All \r\n in firstLines were replaced by \n as fileHeader.

But there are still \r\n in expectedHeader.

I think it's a bug because of missing integration tests on Windows :D. Maybe we need another bug issue?

I tried to fix it on this commit and make tests pass on my Windows PC. If you mind it I can raise another PR to fix it.

[tisonkun]

Let me think of it..

The expected header should be generated from the content or file you provided instead of the tested files. So I may suggest that you force use \n instead of \r\n in the template (expected header), rather than do some in place ad-hoc fixup.

[spencercjh]

Let me think of it..

The expected header should be generated from the content or file you provided instead of the tested files. So I may suggest that you force use \n instead of \r\n in the template (expected header), rather than do some in place ad-hoc fixup.

Do you mean to force the line separator of file hawkeye-core/src/main/resources/Apache-2.0.txt? Or force the line separator of the header file configured in the config toml file?

[spencercjh]

Now I found that on Windows if I don't update Header.java when I add the plugin to hawkeye-command and run ./mvnw hawkeye:check, it will fail and all of the files will be considered as missing header.

[tisonkun]

Do you mean to force the line separator

After a closer look I noticed that we use endOfLine variable to build the expected header and update. Then I think we can do the same fixup as your previous commit does.

[tisonkun]

Now I found that if I don't update

May you share the console output or screenshot? I'm not sure what's the issue here.

[spencercjh]

It runs on b7cb7fd, the previous commit.

May you share the console output or screenshot? I'm not sure what's the issue here.

I just want to tell you the bug. I think there is no other issues besides of the endOfLine.

[tisonkun]

Thank you!

It's a bit late now so I may not be quite clear.

Pending to merge tomorrow morning.

[tisonkun]

Merging...

I'll prepare a release for delivering this plugin. Maybe you can try to write a few docs for the Maven plugin usage. Either in Usage section under README.md or in the hawkeye-maven-plugin folder should be fine.

[tisonkun]

Released as 3.3.0. We may add a skip option to these Mojos so that users can opt-out the plugin execution.