duraspace / codestyle Goto Github PK
View Code? Open in Web Editor NEWProject resources
License: Apache License 2.0
Project resources
License: Apache License 2.0
While not all projects can immediately achieve this, we should enable JavadocMethod
for all public methods, as this is ideally something that all our projects should strive for:
https://github.com/duraspace/resources/blob/master/checkstyle/duraspace-checkstyle.xml#L97-L100
Projects that currently cannot achieve this can simply add JavadocMethod
to their suppressions file. (Optionally, we could add this config to our default suppressions, either uncommented or commented out)
The "FinalLocalVariable" and "FinalParameters" modules should be added to the TreeWalker module.
See: https://github.com/fcrepo4/fcrepo-build-tools/blob/master/src/main/resources/fcrepo-checkstyle/checkstyle.xml#L86-L87
Note, for ease of testing this change, #4 should be completed first.
Ideally, this repo should be released/version via Maven (e.g. as duraspace-codestyle
), so that it can be pulled in as an official dependency of projects that use it.
See, for example, how Fedora currently pulls in their Checkstyle rules via a separate fcrepo-build-tools
Maven dependency. See their maven-checkstyle-plugin
configuration here: https://github.com/fcrepo4/fcrepo4/blob/4.7.3-maintenance/fcrepo-parent/pom.xml#L224
Currently, our recommendation is to configure maven-checkstyle-plugin
to point at an external checkstyle.xml
stored in GitHub (see <configLocation>
setting). https://github.com/duraspace/codestyle#checkstyle
While this "works", it's less ideal as it means that external checkstyle.xml file needs to be downloaded each time you run the maven-checkstyle-plugin
(i.e. there's no local caching mechanism). It also means that if that GitHub URL structure were to change (or GitHub was temporarily unavailable or you were working offline), the checkstyle process would immediately fail.
This comment should be replaced with a link to the Checkstyle README:
https://github.com/duraspace/resources/blob/master/checkstyle/duraspace-checkstyle.xml#L5-L19
In the suppressions file, we are suppressing some modules that we are not even using:
https://github.com/duraspace/resources/blob/master/checkstyle/duraspace-checkstyle-suppressions.xml#L7-L11
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.