@@ -8433,7 +8433,7 @@ Contributions of any kind welcome! github and create a PR: Edit on GitHub diff --git a/license.html b/license.html index 51e3b14b59..5402b6c689 100644 --- a/license.html +++ b/license.html @@ -1560,7 +1560,7 @@ -
Git branches/tags policy
-
-
- Main development happens on the main branch (currently called
master).
+ - Main development happens on the main branch (currently called
main). - PR and enhancements are done on the main branch. -
- Release are usually done directly from the main branch, we don’t create release branches. +
- Releases are usually done directly from the main branch, we don’t create release branches.
- Each release has its own tag named
pmd_releases/MAJOR.MINOR.PATCH. - In case of a patch release, we either do it from the main branch (if there was no development ongoing) or create a separate branch off the last release tag. @@ -1973,7 +1973,7 @@ or create a separate branch off the last release tag. github and create a PR: Edit on GitHub diff --git a/pmd_about_support_lifecycle.html b/pmd_about_support_lifecycle.html index 8272982a90..59d2f59026 100644 --- a/pmd_about_support_lifecycle.html +++ b/pmd_about_support_lifecycle.html @@ -1560,7 +1560,7 @@ -
- Contributing +
- Contributing @@ -1876,7 +1876,7 @@ » Support lifecycle Edit on GitHubSupport lifecycle
First off, thanks for taking the time to contribute!
-Please have a look at CONTRIBUTING.md and -BUILDING.md.
+Please have a look at CONTRIBUTING.md and +BUILDING.md.
- Edit on GitHub
diff --git a/pmd_devdocs_major_adding_new_cpd_language.html b/pmd_devdocs_major_adding_new_cpd_language.html
index c94a2e7add..1a6326acb9 100644
--- a/pmd_devdocs_major_adding_new_cpd_language.html
+++ b/pmd_devdocs_major_adding_new_cpd_language.html
@@ -1560,7 +1560,7 @@
- Contributing
+ Contributing
@@ -1876,7 +1876,7 @@
» How to add a new CPD language
Edit on GitHubHow to add a new CPD language
Use the following guide to set up a new language module that supports CPD.
-
-
- Create a new Maven module for your language. You can take the Golang module as an example. +
- Create a new Maven module for your language. You can take the Golang module as an example.
- Make sure to add your new module to the parent pom as
<module>entry, so that it is built alongside the other languages.
@@ -1928,7 +1928,7 @@ is automatically available in the binary distribution (pmd-dist).
- Make sure to add your new module to the parent pom as
-
For Antlr grammars you can take the grammar from antlr/grammars-v4 and place it in
src/main/antlr4followed by the package name of the language. You then need to call the appropriate ant wrapper to generate - the lexer from the grammar. To do so, editpom.xml(eg like the Golang module). + the lexer from the grammar. To do so, editpom.xml(eg like the Golang module). Once that is done,mvn generate-sourcesshould generate the lexer sources for you.You can now implement a CpdLexer, for instance by extending
AntlrCpdLexer. The following reproduces the Go implementation: @@ -1951,7 +1951,7 @@ Once that is done,mvn genera change each token e.g. into uppercase, so that CPD sees the same strings and can find duplicates even when the casing differs. SeeTSqlCpdLexerfor an example. You will also need a “CaseChangingCharStream”, so that antlr itself is case-insensitive.
- - For JavaCC grammars, place your grammar in
etc/grammarand edit thepom.xmllike the Python implementation does. + - For JavaCC grammars, place your grammar in
etc/grammarand edit thepom.xmllike the Python implementation does. You can then subclassJavaccCpdLexerinstead of AntlrCpdLexer. - If your JavaCC based language is case-insensitive (option
IGNORE_CASE=true), then you need to implementJavaccTokenDocument.TokenDocumentBehavior, which can change each token @@ -1986,7 +1986,7 @@ If your language only supports CPD, then you can subclassCPDand usable by CPD like any other language. -
-
Update the test that asserts the list of supported languages by updating the
+SUPPORTED_LANGUAGESconstant in BinaryDistributionIT.Update the test that asserts the list of supported languages by updating the
SUPPORTED_LANGUAGESconstant in BinaryDistributionIT. -
Add some tests for your CpdLexer by following the section below.
@@ -2025,7 +2025,7 @@ ofBaseTokenFilteras a base class, or another base class innet.sourceforge.pmd.cpd.impl. -Take a look at the Kotlin token filter implementation, or the Java one. +Take a look at the Kotlin token filter implementation, or the Java one.Testing your implementation
@@ -2107,7 +2107,7 @@ call the methoddoTestgithub and create a PR: Edit on GitHub diff --git a/pmd_devdocs_major_adding_new_language_antlr.html b/pmd_devdocs_major_adding_new_language_antlr.html index bbef224cdb..54fbe9c07f 100644 --- a/pmd_devdocs_major_adding_new_language_antlr.html +++ b/pmd_devdocs_major_adding_new_language_antlr.html @@ -1560,7 +1560,7 @@ - - Contributing +
- Contributing @@ -1876,7 +1876,7 @@ » Adding PMD support for a new ANTLR grammar based language Edit on GitHubAdding PMD support for a new ANTLR grammar based language
- ANTLR will generate the parser for you based on the grammar file. The grammar file needs to be placed in the
folder
src/main/antlr4in the appropriate sub packageastof the language. E.g. for swift, the grammar -file is Swift.g4 +file is Swift.g4 and is placed in the packagenet.sourceforge.pmd.lang.swift.ast. - Configure the options “superClass” and “contextSuperClass”. These are the base classes for the generated classes. @@ -1970,29 +1970,29 @@ classes.
- The individual AST nodes are generated, but you need to define the common interface for them.
- You need to define the supertype interface for all nodes of the language. For that, we provide
-
AntlrNode.
- - See
SwiftNode+AntlrNode.
+ - See
SwiftNodeas an example. - Additionally, you need several base classes:
- a language specific inner node - these nodes represent the production rules from the grammar.
In Antlr, they are called “ParserRuleContext”. We call them “InnerNode”. Use the
base class from pmd-core
-
BaseAntlrInnerNode-. And example isSwiftInnerNode. +BaseAntlrInnerNode+. And example isSwiftInnerNode. Note that this language specific inner node is package-private, as it is only the base class for the concrete nodes generated by ANLTR. - a language specific root node - this provides the root of the AST and our parser will return
subtypes of this node. The root node itself is a “InnerNode”.
-See
SwiftRootNode. +SeeSwiftRootNode. Note that this language specific root node is package-private, as it is only the base class for the concrete node generated by ANLTR. - a language specific terminal node.
-See
SwiftTerminalNode.
+See
SwiftTerminalNode. - a language specific inner node - these nodes represent the production rules from the grammar.
In Antlr, they are called “ParserRuleContext”. We call them “InnerNode”. Use the
base class from pmd-core
-
- a language specific error node.
-See
SwiftErrorNode.
+See - a language name dictionary. This is used to convert ANTLR node names to useful XPath node names. -See `SwiftNameDictionary’. +See `SwiftNameDictionary’.
- Once these base classes exist, you need to change the ANTLR grammar to add additional members via
@parser::members@@ -2000,15 +2000,15 @@ See DICO which creates a new instance of your language name dictionary using the vocabulary from the generated parser (VOCABULARY). - Define two additional methods to help converting the ANTLR context objects into PMD AST nodes.
-The methods are abstract in
AntlrGeneratedParserBase+The methods are abstract inAntlrGeneratedParserBaseand need to be implemented here for the concrete language:createPmdTerminal()andcreatePmdError().
SwiftErrorNode.
antlr4-wrapper.xml
+the generated code. The ant script is antlr4-wrapper.xml
and does not need to be adjusted - it has plenty of parameters that can be configured.
The ant script is added in the language module’s pom.xml where the parameters are set (e.g. name of root name
-class). Have a look at Swift’s example: pmd-swift/pom.xml.pmd-swift/pom.xml.
SwiftInnerNode) that are available on all nodes.
But on most cases you won’t need to do anything.generate-sources
have the parser generated.
The generated code will be placed under target/generated-sources/antlr4 and will not be committed to
source control.
- You should review pmd-swift/pom.xml.
+ You should review pmd-swift/pom.xml.
5. Create a TokenManager
- This is needed to support CPD (copy paste detection)
- - We provide a default implementation using
AntlrTokenManager.
+ - We provide a default implementation using
AntlrTokenManager.
- You must create your own “AntlrCpdLexer” such as we do with
-
SwiftCpdLexer.
+SwiftCpdLexer.
-
If you wish to filter specific tokens (e.g. comments to support CPD suppression via “CPD-OFF” and “CPD-ON”)
you can create your own implementation of
-AntlrTokenFilter.
+AntlrTokenFilter.
You’ll need to override then the protected method getTokenFilter(AntlrTokenManager)
and return your custom filter. See the CpdLexer for C# as an exmaple:
-CsCpdLexer.
+CsCpdLexer.
If you don’t need a custom token filter, you don’t need to override the method. It returns the default
AntlrTokenFilter which doesn’t filter anything.
@@ -2046,14 +2046,14 @@ and return your custom filter. See the CpdLexer for C# as an exmaple:
6. Create a PMD parser “adapter”
- Create your own parser, that adapts the ANLTR interface to PMD’s parser interface.
- - We provide a
AntlrBaseParser
+ - We provide a
AntlrBaseParser
implementation that you need to extend to create your own adapter as we do with
-PmdSwiftParser.
+PmdSwiftParser.
7. Create a language version handler
- - Now you need to create your version handler, as we did with
SwiftHandler.
+ - Now you need to create your version handler, as we did with
SwiftHandler.
- This class is sort of a gateway between PMD and all parsing logic specific to your language.
- For a minimal implementation, it just needs to return a parser (see step #6).
- It can be used to provide other features for your language like
@@ -2073,17 +2073,17 @@ provide the method name or class name, where the violation occurred.
- A parser visitor adapter is not needed anymore with PMD 7. The visitor interface now provides a default
implementation.
- The visitor for ANTLR based AST is generated along the parser from the ANTLR grammar file. The
-base interface for a visitor is
AstVisitor.
+base interface for a visitor is AstVisitor.
- The generated visitor class for Swift is called
SwiftVisitor.
- In order to help use this visitor later on, a base visitor class should be created.
-See
SwiftVisitorBase
+See SwiftVisitorBase
as an example.
9. Make PMD recognize your language
- Create your own subclass of
net.sourceforge.pmd.lang.impl.SimpleLanguageModuleBase, see Swift as an example:
- SwiftLanguageModule.
+ SwiftLanguageModule.
- Add for each version of your language a call to
addVersion in your language module’s constructor.
Use addDefaultVersion for defining the default version.
- You’ll need to refer the language version handler created in step #7.
@@ -2095,9 +2095,9 @@ Add your fully qualified class name as a single line into it.
- You need to create your own abstract rule class in order to interface your language with PMD’s generic rule
execution.
- - See
AbstractSwiftRule as an example.
+ - See
AbstractSwiftRule as an example.
- The rule basically just extends
-
AbstractVisitorRule
+AbstractVisitorRule
and only redefines the abstract buildVisitor() method to return our own type of visitor.
In this case our SwiftVisitor is used.
While there is no real functionality added, every language should have its own base class for rules.
@@ -2118,7 +2118,7 @@ may have different AST nodes.
- To add a visitor rule:
- You need to extend the abstract rule you created on the previous step, you can use the swift
-rule UnavailableFunctionRule
+rule UnavailableFunctionRule
as an example. Note, that all rule classes should be suffixed with
Rule and should be placed
in a package the corresponds to their category.
@@ -2144,17 +2144,17 @@ resource filtering configuration in the language module’s PmdRuleTst
(see
-UnavailableFunctionTest
+UnavailableFunctionTest
for example)
- Create a category rule set for your language (see
-
pmd-swift/src/main/resources/bestpractices.xml
+pmd-swift/src/main/resources/bestpractices.xml
for example)
- Place the test XML file with the test cases in the correct location
- When executing the test class
- this triggers the unit test to read the corresponding XML file with the rule test data
(see
-
UnavailableFunction.xml
+UnavailableFunction.xml
for example)
- This test XML file contains sample pieces of code which should trigger a specified number of
violations of this rule. The unit test will execute the rule on this piece of code, and verify
@@ -2228,7 +2228,7 @@ syntax tree) is not suitable to add methods such as
Edit on GitHub
diff --git a/pmd_devdocs_major_adding_new_language_javacc.html b/pmd_devdocs_major_adding_new_language_javacc.html
index 738b0b3e3b..130c697a8f 100644
--- a/pmd_devdocs_major_adding_new_language_javacc.html
+++ b/pmd_devdocs_major_adding_new_language_javacc.html
@@ -1560,7 +1560,7 @@
- - Contributing
+ - Contributing
@@ -1876,7 +1876,7 @@
» Adding PMD support for a new JavaCC grammar based language
Edit on GitHubAdding PMD support for a new JavaCC grammar based language
Verifying your local changes and generate a diff-report locally
-pmdtester -r YOUR_LOCAL_PMD_GIT_REPO_ROOT_DIR -b master -p YOUR_DEVELOPMENT_BRANCH
pmdtester -r YOUR_LOCAL_PMD_GIT_REPO_ROOT_DIR -b main -p YOUR_DEVELOPMENT_BRANCH
The regression difference report is placed in the YOUR_WORKING_DIR/target/reports/diff directory.
For more documentation on pmdtester, see README.rdoc
+For more documentation on pmdtester, see README.rdoc
-The categories for a language %lang% are located in
pmd-%lang%/src/main/resources/category/%lang% . So for Java the categories
-can be found under pmd-java/src/main/resources/category/java.
+can be found under pmd-java/src/main/resources/category/java.
The XML category files in this directory are transformed during build into markdown pages
describing the rules they contain. These pages are placed under docs/ like the handwritten
documentation, and are then rendered with Jekyll like the rest of them. The rule documentation
@@ -2022,7 +2022,7 @@ all formatting inside the delimiters, and allow to write code samples without
For the javadoc tags, the standard PMD maven modules are already defined as namespaces, e.g. core, java, apex, ….
For the implementation of these tags, see the _plugins folder.
+For the implementation of these tags, see the _plugins folder.
Building
@@ -2181,7 +2181,7 @@ by specifying-Dpmd.doc.check
github and create a PR:
Edit on GitHub
diff --git a/pmd_languages_apex.html b/pmd_languages_apex.html
index 792dac976a..395df556be 100644
--- a/pmd_languages_apex.html
+++ b/pmd_languages_apex.html
@@ -1560,7 +1560,7 @@
- Contributing
+ Contributing
@@ -1876,7 +1876,7 @@
» Apex support
Edit on GitHubApex support
Edit on GitHub
diff --git a/pmd_languages_index.html b/pmd_languages_index.html
index 76264e2c00..d35af5764c 100644
--- a/pmd_languages_index.html
+++ b/pmd_languages_index.html
@@ -1560,7 +1560,7 @@
- Contributing
+ Contributing
@@ -1876,7 +1876,7 @@
» Overview
Edit on GitHubOverview
There is no API yet for dataflow analysis. However, some rules such as UnusedAssignment
or ImmutableField are using an internal implementation of an additional
AST pass that adds dataflow information. The implementation can be found in
-net.sourceforge.pmd.lang.java.rule.internal.DataflowPass.
V
github and create a PR:
Edit on GitHub
diff --git a/pmd_languages_visualforce.html b/pmd_languages_visualforce.html
index 2ef40beece..ed1bc3bceb 100644
--- a/pmd_languages_visualforce.html
+++ b/pmd_languages_visualforce.html
@@ -1560,7 +1560,7 @@
- Contributing
+ Contributing
@@ -1876,7 +1876,7 @@
» Visualforce Support
Edit on GitHubVisualforce Support
Edit on GitHub
diff --git a/pmd_projectdocs_committers_infrastructure.html b/pmd_projectdocs_committers_infrastructure.html
index 978067bdad..0fdba05ae5 100644
--- a/pmd_projectdocs_committers_infrastructure.html
+++ b/pmd_projectdocs_committers_infrastructure.html
@@ -1560,7 +1560,7 @@
- Contributing
+ Contributing
@@ -1876,7 +1876,7 @@
» Infrastructure
Edit on GitHubInfrastructure
- Main page - aka “Landing page”: https://pmd.github.io
-
-
- Layout: _layouts/default.html. -It includes all the sub section, which can be found in the includes directory _includes/ +
- Layout: _layouts/default.html. +It includes all the sub section, which can be found in the includes directory _includes/
- The latest PMD version is configured in
_config.ymland the variablessite.pmd.latestVersionare used -e.g. in _includes/home.html.
+e.g. in _includes/home.html.
-
-
- This is a section on main page. It shows the 5 latest news. See _includes/news.html. +
- This is a section on main page. It shows the 5 latest news. See _includes/news.html.
- There is also a sub page “news” which lists all news.
-
-
- Layout: _layouts/news.html -
- Page (which is pretty empty): news.html +
- Layout: _layouts/news.html +
- Page (which is pretty empty): news.html
Example 1: Merging PR #123 into master
+Example 1: Merging PR #123 into main
- @@ -1921,15 +1921,15 @@ If the PR fixes a bug, make sure, that the bug issue is added to the same milest
-
The actual merge commands:
-We assume, that the PR has been created from the master branch. If this is not the case, +
We assume, that the PR has been created from the main branch. If this is not the case, then we’ll either need to rebase or ask for rebasing before merging.
-the filegit checkout master && git pull origin master # make sure, you have the latest code +git checkout main && git pull origin main # make sure, you have the latest code git fetch origin pull/123/head:pr-123 && git checkout pr-123 # creates a new temporary branch "pr-123"- -
Update the release notes:
+Update the release notes:
- Are there any API changes, that need to be documented? (Section “API Changes”) @@ -1967,12 +1967,12 @@ This will automatically close the github issue.
.all-contributorsrcanddocs/pages/pmd/projectdocs/credits.md.- -
Now merge the pull request into the master branch:
+Now merge the pull request into the main branch:
-git checkout master -git merge --no-ff pr-123 -m "Merge pull request #123 from xyz:branch +git checkout main +git merge --no-ff pr-123 -m "Full-title-of-the-pr (#123) -Full-title-of-the-pr #123" --log +Merge pull request #123 from xyz:branch" --logNote: If there are merge conflicts, you’ll need to deal with them here.@@ -1981,7 +1981,7 @@ Full-title-of-the-pr #123" --logRun the complete build:
./mvnw clean verify -Pgenerate-rule-docsNote: This will execute all the unit tests and the checkstyle tests. It ensures, -that the complete project can be build and is functioning on top of the current master.+that the complete project can be build and is functioning on top of the current main.Note: The profile@@ -1989,7 +1989,7 @@ otherwise only run on github actions and fail the build, if e.g. a jdoc or rulegenerate-rule-docswill run the doc checks, that would otherwise only run on github actions and fail the build, if e.g. a jdoc or rule reference is wrong.If the build was successful, you are ready to push:
--git push origin master +git push origin mainSince the temporary branch is now not needed anymore, you can delete it: @@ -1999,7 +1999,7 @@ otherwise only run on github actions and fail the build, if e.g. a jdoc or rule
Example 2: Merging PR #124 into a maintenance branch
-We ask, to create every pull request against master, to make it easier to contribute. +
We ask, to create every pull request against main, to make it easier to contribute. But if a pull request is intended to fix a bug in an older version of PMD, then we need to backport this pull request.
Creating a maintenance branch
@@ -2036,7 +2036,7 @@ git commit -m "Prepare next version 5.8.1-SNAPSHOT"Fetch the PR and rebase it onto the maintenance branch:
@@ -2071,7 +2071,7 @@ rebased onto the maintenance branch. -git fetch origin pull/124/head:pr-124 && git checkout pr-124 # creates a new temporary branch -git rebase master --onto pmd/5.8.x +git rebase main --onto pmd/5.8.x ./mvnw clean verify # make sure, everything works after the rebaseMerging into master
+Merging into main
Now the PR has been merged into the maintenance branch, but it is missing in any later version of PMD. Therefore, we merge first into the next minor version maintenance branch (if existing):
@@ -2080,18 +2080,18 @@ Therefore, we merge first into the next minor version maintenance branch (if exi git merge pmd/5.8.xAfter that, we merge the changes into the master branch:
+After that, we merge the changes into the main branch:
-Cherry-picking would duplicate the commit and you can’t see in the log, on which branches the fix has been integrated (e.g. gitk and github show the branches, from which the specific commit is reachable). -git checkout master +git checkout main git merge pmd/5.9.xNote: This ensures, that every change on the maintenance branch eventually ends -up in the master branch and therefore in any future version of PMD.
+up in the main branch and therefore in any future version of PMD.
The downside is however, that there are inevitable merge conflicts for the mavenpom.xmlfiles, since every branch changed the version number differently.
We could avoid this by merging only the temporary branch “pr-124” into each maintenance branch and -eventually into master, with the risk of missing single commits in a maintenance branch, that have been +eventually into main, with the risk of missing single commits in a maintenance branch, that have been done outside the temporary branch.Merging vs. Cherry-Picking
@@ -2100,7 +2100,7 @@ done outside the temporary branch.The downside is a more complex history - the maintenance branches and master branch are “connected” and not separate.
+The downside is a more complex history - the maintenance branches and main branch are “connected” and not separate.
-+@@ -2042,7 +2042,7 @@ above code snippet (e.g. NEW_VERSION, MILESTONE, DEPENDENCIES_COUNT):Note: both shell snippets are also integrated into
-do-release.sh.Check in all (version) changes to branch master or any other branch, from which the release takes place:
+Check in all (version) changes to branch main or any other branch, from which the release takes place:
-$ git commit -a -m "Prepare pmd release <version>" $ git push @@ -2080,7 +2080,7 @@ bundle install cat > "../pmd.github.io/${RELEASE_NOTES_POST}" <<EOFCheck in all (version, blog post) changes to branch master:
+Check in all (version, blog post) changes to branch main:
-$ git commit -a -m "Prepare pmd release <version>" $ git push @@ -2160,7 +2160,7 @@ under https://pmd.sourceforgeThe release on GitHub Actions currently takes about 30-45 minutes. Once this is done, you -can proceed with releasing pmd designer, see https://github.com/pmd/pmd-designer/blob/master/releasing.md. +can proceed with releasing pmd designer, see https://github.com/pmd/pmd-designer/blob/main/releasing.md. Make sure to release the version, you have used earlier for the property
pmd-designer.version.Once the pmd-designer release is done, you can proceed with part 2. This is simply triggering manually @@ -2366,7 +2366,7 @@ This is a {{ site.pmd.release_type }} release.
Finally, commit and push the changes:
$ git commit -m "Prepare next development version" -$ git push origin master +$ git push origin mainBranches
@@ -2374,7 +2374,7 @@ $ git push origin masterMerging
If the release was done on a maintenance branch, such as
+merged into the next “higher” branches, such aspmd/5.4.x, then this branch should be -merged into the next “higher” branches, such aspmd/5.5.xandmaster.pmd/5.5.xandmain.This ensures, that all fixes done on the maintenance branch, finally end up in the other branches. In theory, the fixes should already be there, but you never now.
@@ -2383,7 +2383,7 @@ In theory, the fixes should already be there, but you never now.If releases from multiple branches are being done, the order matters. You should start from the “oldest” branch, e.g.
pmd/5.4.x, release from there. Then merge (see above) into the next branch, e.g.pmd/5.5.xand release -from there. Then merge into themasterbranch and release from there. This way, the last release done, becomes +from there. Then merge into themainbranch and release from there. This way, the last release done, becomes automatically the latest release on https://docs.pmd-code.org/latest/ and on sourceforge.(Optional) Create a new maintenance branch
@@ -2414,7 +2414,7 @@ the tag. Here are the steps: github and create a PR: Edit on GitHub diff --git a/pmd_projectdocs_credits.html b/pmd_projectdocs_credits.html index 0d4f47e699..a2320ded5d 100644 --- a/pmd_projectdocs_credits.html +++ b/pmd_projectdocs_credits.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Credits Edit on GitHubCredits+-@@ -3562,7 +3562,7 @@ PMD scoreboard formulas, pmd-dcpd optimizations github and create a PR: Edit on GitHub diff --git a/pmd_projectdocs_decisions.html b/pmd_projectdocs_decisions.html index 0fdf620e2d..797dd600a0 100644 --- a/pmd_projectdocs_decisions.html +++ b/pmd_projectdocs_decisions.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Architecture Decisions Edit on GitHubArchitecture Decisions+-@@ -2276,7 +2276,7 @@ github and create a PR: Edit on GitHub diff --git a/pmd_projectdocs_decisions_adr_1.html b/pmd_projectdocs_decisions_adr_1.html index 45e588e97f..c525f5ae36 100644 --- a/pmd_projectdocs_decisions_adr_1.html +++ b/pmd_projectdocs_decisions_adr_1.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » ADR 1 - Use architecture decision records Edit on GitHubADR 1 - Use architecture decision records+-@@ -1978,7 +1978,7 @@ as the decisions need to be formulated and written down. Everybody is on the sam github and create a PR: Edit on GitHub diff --git a/pmd_projectdocs_decisions_adr_2.html b/pmd_projectdocs_decisions_adr_2.html index b69291e9a7..81fed91a4f 100644 --- a/pmd_projectdocs_decisions_adr_2.html +++ b/pmd_projectdocs_decisions_adr_2.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » ADR 2 - Policy on the use of Kotlin for development Edit on GitHubADR 2 - Policy on the use of Kotlin for development+-@@ -1981,7 +1981,7 @@ when Kotlin is used. Eclipse can’t be used practically anymore. github and create a PR: Edit on GitHub diff --git a/pmd_projectdocs_decisions_adr_3.html b/pmd_projectdocs_decisions_adr_3.html index ff98042793..79a0214ebb 100644 --- a/pmd_projectdocs_decisions_adr_3.html +++ b/pmd_projectdocs_decisions_adr_3.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » ADR 3 - API evolution principles Edit on GitHubADR 3 - API evolution principles+-@@ -2132,7 +2132,7 @@ Java Module System. github and create a PR: Edit on GitHub diff --git a/pmd_projectdocs_decisions_adr_NNN.html b/pmd_projectdocs_decisions_adr_NNN.html index 74602b2b88..acc6b6a588 100644 --- a/pmd_projectdocs_decisions_adr_NNN.html +++ b/pmd_projectdocs_decisions_adr_NNN.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » ADR NNN - Template Edit on GitHubADR NNN - Template+-@@ -1942,7 +1942,7 @@ github and create a PR: Edit on GitHub diff --git a/pmd_projectdocs_faq.html b/pmd_projectdocs_faq.html index 048a3f96da..7224453667 100644 --- a/pmd_projectdocs_faq.html +++ b/pmd_projectdocs_faq.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » FAQ Edit on GitHubFAQ+-@@ -1969,7 +1969,7 @@ You must take this into account for certain rules. github and create a PR: Edit on GitHub diff --git a/pmd_projectdocs_logo.html b/pmd_projectdocs_logo.html index c255ace516..a5031765ef 100644 --- a/pmd_projectdocs_logo.html +++ b/pmd_projectdocs_logo.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Logo Edit on GitHubLogo+-@@ -1958,7 +1958,7 @@ These old logos are provided here only as reference for historical reasons and s github and create a PR: Edit on GitHub diff --git a/pmd_projectdocs_trivia_meaning.html b/pmd_projectdocs_trivia_meaning.html index dbe6c61bda..660e1828db 100644 --- a/pmd_projectdocs_trivia_meaning.html +++ b/pmd_projectdocs_trivia_meaning.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » What does 'PMD' mean? Edit on GitHubWhat does 'PMD' mean?+-@@ -1938,7 +1938,7 @@ really know. We just think the letters sound good together. github and create a PR: Edit on GitHub diff --git a/pmd_projectdocs_trivia_news.html b/pmd_projectdocs_trivia_news.html index 42f48c4247..3ed99a5fc7 100644 --- a/pmd_projectdocs_trivia_news.html +++ b/pmd_projectdocs_trivia_news.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » PMD in the press Edit on GitHubPMD in the press+-@@ -2078,7 +2078,7 @@ interview with Ole-Martin and Tom github and create a PR: Edit on GitHub diff --git a/pmd_projectdocs_trivia_products.html b/pmd_projectdocs_trivia_products.html index ef99226937..81d94c666e 100644 --- a/pmd_projectdocs_trivia_products.html +++ b/pmd_projectdocs_trivia_products.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Products/books related to PMD Edit on GitHubProducts/books related to PMD+-@@ -1986,7 +1986,7 @@ to catch web app security problems. Thanks to Joseph Hemler for the props! github and create a PR: Edit on GitHub diff --git a/pmd_projectdocs_trivia_similarprojects.html b/pmd_projectdocs_trivia_similarprojects.html index 4589c835df..0e21eca8e0 100644 --- a/pmd_projectdocs_trivia_similarprojects.html +++ b/pmd_projectdocs_trivia_similarprojects.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Similar projects Edit on GitHubSimilar projects+-@@ -1993,7 +1993,7 @@ only for maven project. github and create a PR: Edit on GitHub diff --git a/pmd_release_notes.html b/pmd_release_notes.html index 5d82b7b22d..2abdbe4b0e 100644 --- a/pmd_release_notes.html +++ b/pmd_release_notes.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » PMD Release Notes Edit on GitHubPMD Release Notes+-@@ -1909,6 +1909,44 @@🚀 New and noteworthy
+New Git default branch - “main”
+ +We are joining the Git community and updating “master” to “main”. Using the term “master” for the main +development branch can be offensive to some people. Existing versions of Git have been always capable of +working with any branch name and since 2.28.0 (July 2020) the default initial branch is configurable +(
+ +init.defaultBranch). Since October 2020, the default branch for new repositories on GitHub +is “main”. Finally, PMD will also use this new name for the main branch in all our own repositories.Why “main”? PMD uses a very simple branching model - pull requests with feature branches and one main development +branch, from which releases are created. That’s why “main” is currently the best fitting name.
+ +More information:
+-
+
- https://sfconservancy.org/news/2020/jun/23/gitbranchname/ +
- https://github.blog/changelog/2020-10-01-the-default-branch-for-newly-created-repositories-is-now-main/ +
What changes?
+-
+
- We change the default branch on GitHub, so that pull requests are automatically created against
mainfrom +now on.
+ - If you have already a local clone of PMD’s repository, you’ll need to rename the old master branch locally:
+ + +
git branch --move master main +git fetch origin +git branch --set-upstream-to=origin/main main +git remote set-head origin --auto +More info: +https://git-scm.com/book/en/v2/Git-Branching-Branch-Management#_changing_master and +https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch#updating-a-local-clone-after-a-branch-name-changes
+
+ - If you created a fork on GitHub, you’ll need to change the default branch in your fork to
mainas +well (Settings > Default Branch).
+ - Some time after this release, we’ll delete the old master branch on GitHub. Then only
maincan be used.
+ - This change is expanded to the other PMD repositories as well, e.g. pmd-designer and pmd-regression-tester. +
🐛 Fixed Issues
- apex @@ -1972,7 +2010,7 @@ github and create a PR: Edit on GitHub diff --git a/pmd_release_notes_old.html b/pmd_release_notes_old.html index 8221898749..f47d54eaae 100644 --- a/pmd_release_notes_old.html +++ b/pmd_release_notes_old.html @@ -1560,7 +1560,7 @@ -
- Contributing +
- Contributing @@ -1876,7 +1876,7 @@ » Old Release Notes Edit on GitHubOld Release Notes
+-@@ -12110,7 +12110,7 @@ conduct.Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
-You can find the code of conduct in the file code_of_conduct.md +
You can find the code of conduct in the file code_of_conduct.md in our repository.
Performance improvements for XPath 2.0 rules
@@ -22635,7 +22635,7 @@ Added new HTML report format github and create a PR: Edit on GitHub diff --git a/pmd_release_notes_pmd7.html b/pmd_release_notes_pmd7.html index 86159d85d5..d72e2d9a62 100644 --- a/pmd_release_notes_pmd7.html +++ b/pmd_release_notes_pmd7.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Detailed Release Notes for PMD 7 Edit on GitHubDetailed Release Notes for PMD 7+-These are the detailed release notes for PMD 7.@@ -6445,7 +6445,7 @@ Please use Edit on GitHub diff --git a/pmd_rules_apex.html b/pmd_rules_apex.html index 375391823f..30c3b010ea 100644 --- a/pmd_rules_apex.html +++ b/pmd_rules_apex.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
diff --git a/pmd_rules_apex_bestpractices.html b/pmd_rules_apex_bestpractices.html index 1a51c22c1a..e00c5aa3a2 100644 --- a/pmd_rules_apex_bestpractices.html +++ b/pmd_rules_apex_bestpractices.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Best Practices Edit on GitHubBest Practices+-Rules which enforce generally accepted best practices.@@ -1914,7 +1914,7 @@ Having a second/third parameter provides more information and makes it easier to debug the test failure and improves the readability of test output. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.bestpractices.ApexAssertionsShouldIncludeMessageRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.bestpractices.ApexAssertionsShouldIncludeMessageRule
Example(s):
@@ -1944,7 +1944,7 @@ improves the readability of test output. with messages provide the developer a clearer idea of what the test does. Custom assert method invocation patterns can be specified using the ‘additionalAssertMethodPattern’ property if required. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.bestpractices.ApexUnitTestClassShouldHaveAssertsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.bestpractices.ApexUnitTestClassShouldHaveAssertsRule
Example(s):
@@ -1999,7 +1999,7 @@ patterns can be specified using the ‘additionalAssertMethodPattern’ propertyApex unit tests should include at least one runAs method. This makes the tests more robust, and independent from the user running it.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.bestpractices.ApexUnitTestClassShouldHaveRunAsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.bestpractices.ApexUnitTestClassShouldHaveRunAsRule
Example(s):
@@ -2077,7 +2077,7 @@ annotation for test classes and methods.Apex unit tests should not use @isTest(seeAllData=true) because it opens up the existing database data for unexpected modification by tests.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.bestpractices.ApexUnitTestShouldNotUseSeeAllDataTrueRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.bestpractices.ApexUnitTestShouldNotUseSeeAllDataTrueRule
Example(s):
@@ -2105,7 +2105,7 @@ annotation for test classes and methods.Global classes should be avoided (especially in managed packages) as they can never be deleted or changed in signature. Always check twice if something needs to be global. Many interfaces (e.g. Batch) required global modifiers in the past but don’t require this anymore. Don’t lock yourself in.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.bestpractices.AvoidGlobalModifierRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.bestpractices.AvoidGlobalModifierRule
Example(s):
@@ -2131,7 +2131,7 @@ Therefore delegate the triggers work to a regular class (often called Trigger haSee more here: https://developer.salesforce.com/page/Trigger_Frameworks_and_Apex_Trigger_Best_Practices
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.bestpractices.AvoidLogicInTriggerRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.bestpractices.AvoidLogicInTriggerRule
Example(s):
@@ -2221,7 +2221,7 @@ Therefore delegate the triggers work to a regular class (often called Trigger haDetects when a local variable is declared and/or assigned but not used.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.bestpractices.UnusedLocalVariableRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.bestpractices.UnusedLocalVariableRule
Example(s):
@@ -2255,7 +2255,7 @@ Therefore delegate the triggers work to a regular class (often called Trigger ha github and create a PR: Edit on GitHub diff --git a/pmd_rules_apex_codestyle.html b/pmd_rules_apex_codestyle.html index dc2778d24d..4eddd22fe6 100644 --- a/pmd_rules_apex_codestyle.html +++ b/pmd_rules_apex_codestyle.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Code Style Edit on GitHubCode Style+--Rules which enforce a specific coding style.@@ -1917,7 +1917,7 @@ properties.By default this rule uses the standard Apex naming convention (Pascal case).
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.codestyle.ClassNamingConventionsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.codestyle.ClassNamingConventionsRule
Example(s):
@@ -2001,7 +2001,7 @@ properties.Field declarations should appear before method declarations within a class.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.codestyle.FieldDeclarationsShouldBeAtStartRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.codestyle.FieldDeclarationsShouldBeAtStartRule
Example(s):
@@ -2031,7 +2031,7 @@ static field, final field. Each regex can be configured through properties.By default this rule uses the standard Apex naming convention (Camel case).
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.codestyle.FieldNamingConventionsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.codestyle.FieldNamingConventionsRule
Example(s):
@@ -2140,7 +2140,7 @@ configured through properties.By default this rule uses the standard Apex naming convention (Camel case).
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.codestyle.FormalParameterNamingConventionsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.codestyle.FormalParameterNamingConventionsRule
Example(s):
@@ -2261,7 +2261,7 @@ properties.By default this rule uses the standard Apex naming convention (Camel case).
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.codestyle.LocalVariableNamingConventionsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.codestyle.LocalVariableNamingConventionsRule
Example(s):
@@ -2324,7 +2324,7 @@ configured through properties.By default this rule uses the standard Apex naming convention (Camel case).
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.codestyle.MethodNamingConventionsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.codestyle.MethodNamingConventionsRule
Example(s):
@@ -2457,7 +2457,7 @@ configured through properties.By default this rule uses the standard Apex naming convention (Camel case).
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.codestyle.PropertyNamingConventionsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.codestyle.PropertyNamingConventionsRule
Example(s):
@@ -2551,7 +2551,7 @@ controlled from the rest. github and create a PR: Edit on GitHub diff --git a/pmd_rules_apex_design.html b/pmd_rules_apex_design.html index 4222251ff7..3fd0034050 100644 --- a/pmd_rules_apex_design.html +++ b/pmd_rules_apex_design.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Design Edit on GitHubDesign+-Rules that help you discover design issues.@@ -1912,7 +1912,7 @@Avoid creating deeply nested if-then statements since they are harder to read and error-prone to maintain.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.AvoidDeeplyNestedIfStmtsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.AvoidDeeplyNestedIfStmtsRule
Example(s):
@@ -1980,7 +1980,7 @@ control flow leading to an increase in cognitive complexity.By default, this rule reports methods with a complexity of 15 or more. Reported methods should be broken down into less complex components.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.CognitiveComplexityRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.CognitiveComplexityRule
Example(s):
@@ -2079,7 +2079,7 @@ methods’ complexities reaches 40, even if none of the methods was directly repReported methods should be broken down into several smaller methods. Reported classes should probably be broken down into subcomponents.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.CyclomaticComplexityRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.CyclomaticComplexityRule
Example(s):
@@ -2155,7 +2155,7 @@ into subcomponents. responsibilities that could be provided by external classes or functions. In breaking these methods apart the code becomes more managable and ripe for reuse. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.ExcessiveClassLengthRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.ExcessiveClassLengthRule
Example(s):
@@ -2215,7 +2215,7 @@ apart the code becomes more managable and ripe for reuse.Methods with numerous parameters are a challenge to maintain, especially if most of them share the same datatype. These situations usually denote the need for new objects to wrap the numerous parameters.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.ExcessiveParameterListRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.ExcessiveParameterListRule
Example(s):
@@ -2271,7 +2271,7 @@ since combinatorial side effects grow rapidly and increase risk. Refactoring the smaller ones not only increases testability and reliability but also allows new variations to be developed easily. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.ExcessivePublicCountRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.ExcessivePublicCountRule
Example(s):
@@ -2332,7 +2332,7 @@ developed easily. of code for a given constructor. NCSS ignores comments, and counts actual statements. Using this algorithm, lines of code that are split are counted as one. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.NcssConstructorCountRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.NcssConstructorCountRule
Example(s):
@@ -2390,7 +2390,7 @@ lines of code that are split are counted as one. of code for a given method. NCSS ignores comments, and counts actual statements. Using this algorithm, lines of code that are split are counted as one. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.NcssMethodCountRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.NcssMethodCountRule
Example(s):
@@ -2447,7 +2447,7 @@ lines of code that are split are counted as one. of code for a given type. NCSS ignores comments, and counts actual statements. Using this algorithm, lines of code that are split are counted as one. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.NcssTypeCountRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.NcssTypeCountRule
Example(s):
@@ -2507,7 +2507,7 @@ plus one for the method entry. The decision points include ‘if’, ‘while Generally, numbers ranging from 1-4 denote low complexity, 5-7 denote moderate complexity, 8-10 denote high complexity, and 11+ is very high complexity. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.StdCyclomaticComplexityRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.StdCyclomaticComplexityRule
Example(s):
@@ -2602,7 +2602,7 @@ high complexity, and 11+ is very high complexity. possibly through grouping related fields in new objects. For example, a class with individual city/state/zip fields could park them within a single Address field. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.TooManyFieldsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.TooManyFieldsRule
Example(s):
@@ -2696,7 +2696,7 @@ well-formedsfdx-project.json }This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.UnusedMethodRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.design.UnusedMethodRule
Example(s):
@@ -2740,7 +2740,7 @@ well-formedsfdx-project.json github and create a PR: Edit on GitHub diff --git a/pmd_rules_apex_documentation.html b/pmd_rules_apex_documentation.html index 7c08989573..6910f68d74 100644 --- a/pmd_rules_apex_documentation.html +++ b/pmd_rules_apex_documentation.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Documentation Edit on GitHubDocumentation+-Rules that are related to code documentation.@@ -1928,7 +1928,7 @@ By settingreportPropertyMethod overrides and tests are both exempted from having ApexDoc. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.documentation.ApexDocRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.documentation.ApexDocRule
Example(s):
@@ -2011,7 +2011,7 @@ By settingreportProperty Edit on GitHub diff --git a/pmd_rules_apex_errorprone.html b/pmd_rules_apex_errorprone.html index f73b96c288..90534e9e75 100644 --- a/pmd_rules_apex_errorprone.html +++ b/pmd_rules_apex_errorprone.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Error Prone Edit on GitHubError Prone+-Rules to detect constructs that are either broken, extremely confusing or prone to runtime errors.@@ -1921,7 +1921,7 @@ Just querying the database is permitted.Note: This rule has been moved from category "Security" to "Error Prone" with PMD 6.21.0, since using DML in constructors is not a security problem, but crashes the application.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.errorprone.ApexCSRFRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.errorprone.ApexCSRFRule
Example(s):
@@ -1984,7 +1984,7 @@ using DML in constructors is not a security problem, but crashes the application it is essential to avoid hardcoding IDs in the Apex code. By doing so, if the record IDs change between environments, the logic can dynamically identify the proper data to operate against and not fail. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.errorprone.AvoidHardcodingIdRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.errorprone.AvoidHardcodingIdRule
Example(s):
@@ -2015,7 +2015,7 @@ In the future, use of such non-existent annotations could result in broken apex This will prevent users of garbage annotations from being able to use legitimate annotations added to Apex in the future. A full list of supported annotations can be found at https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_annotation.htm -This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.errorprone.AvoidNonExistentAnnotationsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.errorprone.AvoidNonExistentAnnotationsRule
Example(s):
@@ -2271,7 +2271,7 @@ a while loop that does a lot in the exit expression, rewrite it to make it clear Lightning component markup. The update prevents access to private or protected Apex getters from Aura and Lightning Web Components. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.errorprone.InaccessibleAuraEnabledGetterRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.errorprone.InaccessibleAuraEnabledGetterRule
Example(s):
@@ -2329,7 +2329,7 @@ and Lightning Web Components.Non-constructor methods should not have the same name as the enclosing class.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.errorprone.MethodWithSameNameAsEnclosingClassRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.errorprone.MethodWithSameNameAsEnclosingClassRule
Example(s):
@@ -2357,7 +2357,7 @@ delegating to your superclass.This is especially important when Using Custom Types in Map Keys and Sets.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.errorprone.OverrideBothEqualsAndHashcodeRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.errorprone.OverrideBothEqualsAndHashcodeRule
Example(s):
@@ -2462,7 +2462,7 @@ dealing with legacy code. github and create a PR: Edit on GitHub diff --git a/pmd_rules_apex_performance.html b/pmd_rules_apex_performance.html index 2f2f6a40ee..126194e8cd 100644 --- a/pmd_rules_apex_performance.html +++ b/pmd_rules_apex_performance.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Performance Edit on GitHubPerformance+-Rules that flag suboptimal code.@@ -1953,7 +1953,7 @@ governor limit exceptions. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.performance.AvoidNonRestrictiveQueriesRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.performance.AvoidNonRestrictiveQueriesRule
Example(s):
@@ -2077,7 +2077,7 @@ and net.sourceforge.pmd.lang.apex.rule.performance.OperationWithHighCostInLoopRule +This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.performance.OperationWithHighCostInLoopRule
Example(s):
@@ -2143,7 +2143,7 @@ a potential performance issue.Database class methods, DML operations, SOQL queries, SOSL queries, Approval class methods, Email sending, async scheduling or queueing within loops can cause governor limit exceptions. Instead, try to batch up the data into a list and invoke the operation once on that list of data outside the loop.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.performance.OperationWithLimitsInLoopRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.performance.OperationWithLimitsInLoopRule
Example(s):
@@ -2224,7 +2224,7 @@ a potential performance issue. github and create a PR: Edit on GitHub diff --git a/pmd_rules_apex_security.html b/pmd_rules_apex_security.html index 80060158ac..20e9edf583 100644 --- a/pmd_rules_apex_security.html +++ b/pmd_rules_apex_security.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Security Edit on GitHubSecurity+-Rules that flag potential security flaws.@@ -1913,7 +1913,7 @@The rule makes sure you are using randomly generated IVs and keys for
-Cryptocalls. Hard-wiring these values greatly compromises the security of encrypted data.This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexBadCryptoRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexBadCryptoRule
Example(s):
@@ -1993,7 +1993,7 @@ check happens automatically and is not needed explicitly. However, the rule can whether a getter is a VF getter or not and reports a violation in any case. In such cases, the violation should be suppressed. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexCRUDViolationRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexCRUDViolationRule
Example(s):
@@ -2129,7 +2129,7 @@ opens the door to several attacks and requires manual validation, which is unrel of private data. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexDangerousMethodsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexDangerousMethodsRule
Example(s):
@@ -2153,7 +2153,7 @@ of private data.Checks against accessing endpoints under plain http. You should always use https for security.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexInsecureEndpointRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexInsecureEndpointRule
Example(s):
@@ -2178,7 +2178,7 @@ of private data.Checks against redirects to user-controlled locations. This prevents attackers from redirecting users to phishing sites.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexOpenRedirectRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexOpenRedirectRule
Example(s):
@@ -2203,7 +2203,7 @@ redirecting users to phishing sites.Detect classes declared without explicit sharing mode if DML methods are used. This forces the developer to take access restrictions into account before modifying objects.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexSharingViolationsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexSharingViolationsRule
Example(s):
@@ -2224,7 +2224,7 @@ forces the developer to take access restrictions into account before modifying oDetects the usage of untrusted / unescaped variables in DML queries.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexSOQLInjectionRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexSOQLInjectionRule
Example(s):
@@ -2261,7 +2261,7 @@ forces the developer to take access restrictions into account before modifying oFor more information, you can check this
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexSuggestUsingNamedCredRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexSuggestUsingNamedCredRule
Example(s):
@@ -2288,7 +2288,7 @@ forces the developer to take access restrictions into account before modifying o will be displayed directly to the user in the UI, making it prime ground for XSS attacks if unescaped. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexXSSFromEscapeFalseRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexXSSFromEscapeFalseRule
Example(s):
@@ -2310,7 +2310,7 @@ attacks if unescaped.Makes sure that all values obtained from URL parameters are properly escaped / sanitized to avoid XSS attacks.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexXSSFromURLParamRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.security.ApexXSSFromURLParamRule
Example(s):
@@ -2342,7 +2342,7 @@ to avoid XSS attacks. github and create a PR: Edit on GitHub diff --git a/pmd_rules_ecmascript.html b/pmd_rules_ecmascript.html index 3c61123c3c..03dff02f21 100644 --- a/pmd_rules_ecmascript.html +++ b/pmd_rules_ecmascript.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
diff --git a/pmd_rules_ecmascript_bestpractices.html b/pmd_rules_ecmascript_bestpractices.html index 7b6aed8fef..259506388c 100644 --- a/pmd_rules_ecmascript_bestpractices.html +++ b/pmd_rules_ecmascript_bestpractices.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Best Practices Edit on GitHubBest Practices+-Rules which enforce generally accepted best practices.@@ -1937,7 +1937,7 @@ However, when a function does use returns they should all have a value, or all with no value. Mixed return usage is likely a bug, or at best poor style. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.ecmascript.rule.bestpractices.ConsistentReturnRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.ecmascript.rule.bestpractices.ConsistentReturnRule
Example(s):
@@ -2090,7 +2090,7 @@ It also improves readability, if the base is given. github and create a PR: Edit on GitHub diff --git a/pmd_rules_ecmascript_codestyle.html b/pmd_rules_ecmascript_codestyle.html index 67194dde45..69ff659c0e 100644 --- a/pmd_rules_ecmascript_codestyle.html +++ b/pmd_rules_ecmascript_codestyle.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Code Style Edit on GitHubCode Style+-Rules which enforce a specific coding style.@@ -2266,7 +2266,7 @@ will never execute. This is a bug, or extremely poor style. github and create a PR: Edit on GitHub diff --git a/pmd_rules_ecmascript_errorprone.html b/pmd_rules_ecmascript_errorprone.html index 2f6f677645..c8cb80e097 100644 --- a/pmd_rules_ecmascript_errorprone.html +++ b/pmd_rules_ecmascript_errorprone.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Error Prone Edit on GitHubError Prone+-Rules to detect constructs that are either broken, extremely confusing or prone to runtime errors.@@ -2103,7 +2103,7 @@ and Edit on GitHub diff --git a/pmd_rules_ecmascript_performance.html b/pmd_rules_ecmascript_performance.html index 92854b1ac6..d785a8fec1 100644 --- a/pmd_rules_ecmascript_performance.html +++ b/pmd_rules_ecmascript_performance.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Performance Edit on GitHubPerformance+-Rules that flag suboptimal code.@@ -1957,7 +1957,7 @@ In addition, logging could expose sensitive data. github and create a PR: Edit on GitHub diff --git a/pmd_rules_html.html b/pmd_rules_html.html index 5ff2d16be7..c95d3bc98b 100644 --- a/pmd_rules_html.html +++ b/pmd_rules_html.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
diff --git a/pmd_rules_html_bestpractices.html b/pmd_rules_html_bestpractices.html index 99f0ab0c31..80d08476ad 100644 --- a/pmd_rules_html_bestpractices.html +++ b/pmd_rules_html_bestpractices.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Best Practices Edit on GitHubBest Practices+-Rules which enforce generally accepted best practices.@@ -1935,7 +1935,7 @@ This helps to reuse common styles.In HTML5 the explicit type attribute for link and script elements is not needed. Modern browsers expect stylesheets to be in CSS and scripts to use JavaScript.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.html.rule.bestpractices.UnnecessaryTypeAttributeRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.html.rule.bestpractices.UnnecessaryTypeAttributeRule
Example(s):
@@ -1961,7 +1961,7 @@ stylesheets to be in CSS and scripts to use JavaScript.Always use an "alt" attribute for images. This provides an alternative text and is extensively used by screen readers.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.html.rule.bestpractices.UseAltAttributeForImagesRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.html.rule.bestpractices.UseAltAttributeForImagesRule
Example(s):
@@ -1994,7 +1994,7 @@ by screen readers. github and create a PR: Edit on GitHub diff --git a/pmd_rules_java.html b/pmd_rules_java.html index 8d120164ee..6440b1a317 100644 --- a/pmd_rules_java.html +++ b/pmd_rules_java.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
diff --git a/pmd_rules_java_bestpractices.html b/pmd_rules_java_bestpractices.html index fbee26acb6..758bd36350 100644 --- a/pmd_rules_java_bestpractices.html +++ b/pmd_rules_java_bestpractices.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Best Practices Edit on GitHubBest Practices+--Rules which enforce generally accepted best practices.@@ -1915,7 +1915,7 @@ an incomplete implementation, which is to be completed by subclasses implementin abstract methods. If the class is intended to be used as a base class only (not to be instantiated directly) a protected constructor can be provided to prevent direct instantiation. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.AbstractClassWithoutAbstractMethodRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.AbstractClassWithoutAbstractMethodRule
Example(s):
@@ -1949,7 +1949,7 @@ This turns a private constructor effectively into one with package scope, and is Since Java 11, JEP 181: Nest-Based Access Control has been implemented. This means that in Java 11 and above accessor classes are not generated anymore. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.AccessorClassGenerationRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.AccessorClassGenerationRule
Example(s):
@@ -1983,7 +1983,7 @@ be avoided by changing the visibility of the field / method from private to pack Since Java 11, JEP 181: Nest-Based Access Control has been implemented. This means that in Java 11 and above accessor classes are not generated anymore. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.AccessorMethodGenerationRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.AccessorMethodGenerationRule
Example(s):
@@ -2016,7 +2016,7 @@ means that in Java 11 and above accessor classes are not generated anymore.Constructors and methods receiving arrays should clone objects and store the copy. This prevents future changes from the user from affecting the original array.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.ArrayIsStoredDirectlyRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.ArrayIsStoredDirectlyRule
Example(s):
@@ -2147,7 +2147,7 @@ Creating a new instance is easier than synchronizing access to a shared instance2) Following the principle of least surprise we want to make sure that a variable caught in a catch statement is always the one thrown in a try block.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.AvoidReassigningCatchVariablesRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.AvoidReassigningCatchVariablesRule
Example(s):
@@ -2196,7 +2196,7 @@ is always the one thrown in a try block. This prevents accidental reassignments or unconditional increments of the control variable. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.AvoidReassigningLoopVariablesRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.AvoidReassigningLoopVariablesRule
Example(s):
@@ -2278,7 +2278,7 @@ understandable.Note that this rule considers both methods and constructors. If there are multiple assignments for a formal parameter, then only the first assignment is reported.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.AvoidReassigningParametersRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.AvoidReassigningParametersRule
Example(s):
@@ -2331,7 +2331,7 @@ if held within objects with long lifetimes.Application with hard-coded IP addresses can become impossible to deploy in some cases. Externalizing IP adresses is preferable.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.AvoidUsingHardCodedIPRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.AvoidUsingHardCodedIPRule
Example(s):
@@ -2380,7 +2380,7 @@ Externalizing IP adresses is preferable.Always check the return values of navigation methods (next, previous, first, last) of a ResultSet. If the value return is ‘false’, it should be handled properly.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.CheckResultSetRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.CheckResultSetRule
Example(s):
@@ -2554,7 +2554,7 @@ lists, arrays and iterators. A loop is safe to replace if it only uses the index access an element of the list or array, only has one update statement, and loops through every element of the list or array left to right. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.ForLoopCanBeForeachRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.ForLoopCanBeForeachRule
Example(s):
@@ -2638,7 +2638,7 @@ otherwise skip the associate String creation and manipulation, as well as any meAn alternative to checking the log level are substituting parameters, formatters or lazy logging with lambdas. The available alternatives depend on the actual logging framework.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.GuardLogStatementRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.GuardLogStatementRule
Example(s):
@@ -2956,7 +2956,7 @@ is a good practice to limit their visibility.JUnit assertions should include an informative message - i.e., use the three-argument version of assertEquals(), not the two-argument version.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.JUnitAssertionsShouldIncludeMessageRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.JUnitAssertionsShouldIncludeMessageRule
Example(s):
@@ -2986,7 +2986,7 @@ Customize the maximum number of assertions used by this Rule to suit your needs.This rule checks for JUnit4, JUnit5 and TestNG Tests, as well as methods starting with "test".
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.JUnitTestContainsTooManyAssertsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.JUnitTestContainsTooManyAssertsRule
Example(s):
@@ -3052,7 +3052,7 @@ Customize the maximum number of assertions used by this Rule to suit your needs.JUnit tests should include at least one assertion. This makes the tests more robust, and using assert with messages provide the developer a clearer idea of what the test does.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.JUnitTestsShouldIncludeAssertRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.JUnitTestsShouldIncludeAssertRule
Example(s):
@@ -3105,7 +3105,7 @@ with messages provide the developer a clearer idea of what the test does.In JUnit4, use the @Test(expected) annotation to denote tests that should throw exceptions.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.JUnitUseExpectedRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.JUnitUseExpectedRule
Example(s):
@@ -3140,7 +3140,7 @@ with messages provide the developer a clearer idea of what the test does. can be avoided, they will just return false. Note that switching literal positions for compareTo and compareToIgnoreCase may change the result, see examples. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.LiteralsFirstInComparisonsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.LiteralsFirstInComparisonsRule
Example(s):
@@ -3180,7 +3180,7 @@ and parameters using a more general type (e.g,allowedTypes. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.LooseCouplingRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.LooseCouplingRule
Example(s):
@@ -3244,7 +3244,7 @@ the same as interfaces can be configured with the propertynet.sourceforge.pmd.lang.java.rule.bestpractices.MethodReturnsInternalArrayRule +This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.MethodReturnsInternalArrayRule
Example(s):
@@ -3272,7 +3272,7 @@ removed or replaced outside of the object that owns it. It is safer to return aAnnotating overridden methods with @Override ensures at compile time that the method really overrides one, which helps refactoring and clarifies intent.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.MissingOverrideRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.MissingOverrideRule
Example(s):
@@ -3372,7 +3372,7 @@ replaced by their cause exception. The discarded part of the stack trace is in t cases only JDK-internal code, which is not very useful. The rule also ignores exceptions whose name starts withignored. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.PreserveStackTraceRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.PreserveStackTraceRule
Example(s):
@@ -3420,7 +3420,7 @@ a new instance each time.Note that for
-Boolean, the named constantsBoolean.TRUEandBoolean.FALSEare preferred instead ofBoolean.valueOf.This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.PrimitiveWrapperInstantiationRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.PrimitiveWrapperInstantiationRule
Example(s):
@@ -3525,7 +3525,7 @@ are preferred instead ofBool assertion method. This enables better error messages, and makes the assertions more readable. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.SimplifiableTestAssertionRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.SimplifiableTestAssertionRule
Example(s):
@@ -3632,7 +3632,7 @@ For instance:-Arrays.asList("foo", "bar");This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.UnnecessaryVarargsArrayCreationRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.UnnecessaryVarargsArrayCreationRule
Example(s):
@@ -3688,7 +3688,7 @@ things likeassertstaBoth of those limitations may be partly relaxed in PMD 7.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.UnusedAssignmentRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.UnusedAssignmentRule
Example(s):
@@ -3822,7 +3822,7 @@ Parameters whose name starts withcheckAllproperty totrue. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.UnusedFormalParameterRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.UnusedFormalParameterRule
Example(s):
@@ -3873,7 +3873,7 @@ Hence, by default, this rule only considers private methods. To include non-privDetects when a local variable is declared and/or assigned, but not used. Variables whose name starts with
-ignoredorunusedare filtered out.This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.UnusedLocalVariableRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.UnusedLocalVariableRule
Example(s):
@@ -3902,7 +3902,7 @@ or e.g. Lombok) which use the fields by reflection or other means. This usage ca Previously these frameworks where explicitly allowed by listing their annotations in the property "ignoredAnnotations", but that turned out to be prone of false positive for any not explicitly considered framework. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.UnusedPrivateFieldRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.UnusedPrivateFieldRule
Example(s):
@@ -3961,7 +3961,7 @@ Previously these frameworks where explicitly allowed by listing their annotationUnused Private Method detects when a private method is declared but is unused.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.UnusedPrivateMethodRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.UnusedPrivateMethodRule
Example(s):
@@ -4010,7 +4010,7 @@ Previously these frameworks where explicitly allowed by listing their annotationThe isEmpty() method on java.util.Collection is provided to determine if a collection has any elements. Comparing the value of size() to 0 does not convey intent as well as the isEmpty() method.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.UseCollectionIsEmptyRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.UseCollectionIsEmptyRule
Example(s):
@@ -4046,7 +4046,7 @@ are of an enum type. The specialized enum collections are more space- and time-e This rule reports constructor expressions for hash sets or maps whose key type is an enum type. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.UseEnumCollectionsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.UseEnumCollectionsRule
Example(s):
@@ -4126,7 +4126,7 @@ are better handled: If an exception occurred both in thetry-with-resources statement, the exception thrown from the try-block is preserved. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.UseTryWithResourcesRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.bestpractices.UseTryWithResourcesRule
Example(s):
@@ -4312,7 +4312,7 @@ a block{}is sufficie github and create a PR: Edit on GitHub diff --git a/pmd_rules_java_codestyle.html b/pmd_rules_java_codestyle.html index 50592606b0..62c40c2764 100644 --- a/pmd_rules_java_codestyle.html +++ b/pmd_rules_java_codestyle.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Code Style Edit on GitHubCode Style+Rules which enforce a specific coding style.@@ -1913,7 +1913,7 @@Each non-static class should declare at least one constructor. Classes with solely static members are ignored, refer to UseUtilityClassRule to detect those.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.AtLeastOneConstructorRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.AtLeastOneConstructorRule
Example(s):
@@ -2189,7 +2189,7 @@ or methods. either inherit from JUnit 3 TestCase or have at least one method annotated with the Test annotations from JUnit4/5 or TestNG. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.ClassNamingConventionsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.ClassNamingConventionsRule
Example(s):
@@ -2287,7 +2287,7 @@ By default, the comment must be@VisibleForTestingannotation or any JUnit5/TestNG annotation. Use the property "ignoredAnnotations" to customize the recognized annotations. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.CommentDefaultAccessModifierRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.CommentDefaultAccessModifierRule
Example(s):
@@ -2369,7 +2369,7 @@ property "ignoredAnnotations" to customize the recognized annotations. rule makes the code easier to read. Also, this resolves trivial ordering problems, such as "does the error case go first?" or "does the common case go first?". -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.ConfusingTernaryRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.ConfusingTernaryRule
Example(s):
@@ -2552,7 +2552,7 @@ EmptySwitchStatements, EmptySynchronizedBlock, EmptyTryBlock, and EmptyWhileStmtEmptyStatementNotInLoop is replaced by
-UnnecessarySemicolon.This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.EmptyControlStatementRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.EmptyControlStatementRule
Example(s):
@@ -2665,7 +2665,7 @@ usage by developers who should be implementing their own versions in the concretFields should be declared at the top of the class, before any method declarations, constructors, initializers or inner classes.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.FieldDeclarationsShouldBeAtStartOfClassRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.FieldDeclarationsShouldBeAtStartOfClassRule
Example(s):
@@ -2739,7 +2739,7 @@ enum constant, final field. Each regex can be configured through properties.By default this rule uses the standard Java naming convention (Camel case), and uses the ALL_UPPER convention for constants and enum constants.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.FieldNamingConventionsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.FieldNamingConventionsRule
Example(s):
@@ -2891,7 +2891,7 @@ configured through properties.By default this rule uses the standard Java naming convention (Camel case).
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.FormalParameterNamingConventionsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.FormalParameterNamingConventionsRule
Example(s):
@@ -3016,7 +3016,7 @@ configured through properties. adding functionality. It’s better style to collapse identical branches into a single multi-catch branch. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.IdenticalCatchBranchesRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.IdenticalCatchBranchesRule
Example(s):
@@ -3063,7 +3063,7 @@ branch.- The rule cannot know if the qualifier of a method call performs side effects. This means
-(x) -> sideEffectingMethod().foo(x)will be reported. Suppress the warning in this case.This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.LambdaCanBeMethodReferenceRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.LambdaCanBeMethodReferenceRule
Example(s):
@@ -3134,7 +3134,7 @@ false positives.For more information, see Linguistic Antipatterns - What They Are and How Developers Perceive Them.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.LinguisticNamingRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.LinguisticNamingRule
Example(s):
@@ -3330,7 +3330,7 @@ Developers Perceive Them.A local variable assigned only once can be declared final.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.LocalVariableCouldBeFinalRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.LocalVariableCouldBeFinalRule
Example(s):
@@ -3386,7 +3386,7 @@ properties.By default this rule uses the standard Java naming convention (Camel case).
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.LocalVariableNamingConventionsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.LocalVariableNamingConventionsRule
Example(s):
@@ -3545,7 +3545,7 @@ properties.This rule ignores unused parameters so as not to overlap with the rule
-UnusedFormalParameter. It will also ignore the parameters of abstract methods.This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.MethodArgumentCouldBeFinalRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.MethodArgumentCouldBeFinalRule
Example(s):
@@ -3582,7 +3582,7 @@ configured through properties.By default this rule uses the standard Java naming convention (Camel case).
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.MethodNamingConventionsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.MethodNamingConventionsRule
Example(s):
@@ -3684,7 +3684,7 @@ configured through properties.A method should have only one exit point, and that should be the last statement in the method.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.OnlyOneReturnRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.OnlyOneReturnRule
Example(s):
@@ -3744,7 +3744,7 @@ most method and constructor invocations to be impure. See the second example. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.PrematureDeclarationRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.PrematureDeclarationRule
Example(s):
@@ -4154,7 +4154,7 @@ or because they’re semantically a noop (eg unboxing a value to rebox it immedi calls tovalueOfor one of theintValue,byteValue, etc. methods. Casts that command a conversion are reported byUnnecessaryCastinstead. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.UnnecessaryBoxingRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.UnnecessaryBoxingRule
Example(s):
@@ -4197,7 +4197,7 @@ for the context type. For instance, in the following:The literal would be autoboxed to
-Integeranyway.This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.UnnecessaryCastRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.UnnecessaryCastRule
Example(s):
@@ -4258,7 +4258,7 @@ for the context type. For instance, in the following: constructor is identical to the default constructor. The default constructor should has same access modifier as the declaring class. In an enum type, the default constructor is implicitly private. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.UnnecessaryConstructorRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.UnnecessaryConstructorRule
Example(s):
@@ -4307,7 +4307,7 @@ modifier as the declaring class. In an enum type, the default constructor is impImport statements allow the use of non-fully qualified names. The use of a fully qualified name which is covered by an import statement is redundant. Consider using the non-fully qualified name.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.UnnecessaryFullyQualifiedNameRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.UnnecessaryFullyQualifiedNameRule
Example(s):
@@ -4370,7 +4370,7 @@ because they’re in java.lang, or the current package. an incomplete auxiliary classpath, some imports may be conservatively marked as used even if they’re not to avoid false positives. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.UnnecessaryImportRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.UnnecessaryImportRule
Example(s):
@@ -4400,7 +4400,7 @@ as used even if they’re not to avoid false positives.Avoid the creation of unnecessary local variables
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.UnnecessaryLocalBeforeReturnRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.UnnecessaryLocalBeforeReturnRule
Example(s):
@@ -4455,7 +4455,7 @@ Classes, interfaces or annotations nested in an interface or annotation are auto Nested enums are automaticallystatic. For historical reasons, modifiers which are implied by the context are accepted by the compiler, but are superfluous. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.UnnecessaryModifierRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.UnnecessaryModifierRule
Example(s):
@@ -4498,7 +4498,7 @@ For historical reasons, modifiers which are implied by the context are acceptedAvoid the use of unnecessary return statements. A return is unnecessary when no instructions follow anyway.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.UnnecessaryReturnRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.UnnecessaryReturnRule
Example(s):
@@ -4568,7 +4568,7 @@ The diamond syntax was first introduced in Java 1.7. In Java 8, improvements in type inference made more type arguments redundant. In Java 9, type arguments inference was made possible for anonymous class constructors. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.UseDiamondOperatorRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.UseDiamondOperatorRule
Example(s):
@@ -4689,7 +4689,7 @@ just more visually pleasing. Unset the propertynet.sourceforge.pmd.lang.java.rule.codestyle.UselessParenthesesRule +This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.codestyle.UselessParenthesesRule
Example(s):
@@ -4903,7 +4903,7 @@ that are misplaced (not making groups of 3 digits) are reported. github and create a PR: Edit on GitHub diff --git a/pmd_rules_java_design.html b/pmd_rules_java_design.html index 1d6bb374c6..729384f57d 100644 --- a/pmd_rules_java_design.html +++ b/pmd_rules_java_design.html @@ -1560,7 +1560,7 @@ -- Contributing
+- Contributing
@@ -1876,7 +1876,7 @@ » Design Edit on GitHubDesign+-Rules that help you discover design issues.@@ -1984,7 +1984,7 @@ protected constructor in order to prevent instantiation than make the class mislAvoid creating deeply nested if-then statements since they are harder to read and error-prone to maintain.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.design.AvoidDeeplyNestedIfStmtsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.design.AvoidDeeplyNestedIfStmtsRule
Example(s):
@@ -2129,7 +2129,7 @@ validation in methods and constructors with multiple parameters. }This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.design.AvoidThrowingNullPointerExceptionRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.design.AvoidThrowingNullPointerExceptionRule
Example(s):
@@ -2214,7 +2214,7 @@ exceptional cases with a@thr their compilation unit anyway. This is because all their constructors are private, so a subclass could not call the super constructor. -This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.design.ClassWithOnlyPrivateConstructorsShouldBeFinalRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.design.ClassWithOnlyPrivateConstructorsShouldBeFinalRule
Example(s):
@@ -2247,7 +2247,7 @@ control flow leading to an increase in cognitive complexity.By default, this rule reports methods with a complexity of 15 or more. Reported methods should be broken down into less complex components.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.design.CognitiveComplexityRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.design.CognitiveComplexityRule
Example(s):
@@ -2365,7 +2365,7 @@ conditions with a boolean&amThis rule counts the number of unique attributes, local variables, and return types within an object. A number higher than the specified threshold can indicate a high degree of coupling.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.design.CouplingBetweenObjectsRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.design.CouplingBetweenObjectsRule
Example(s):
@@ -2440,7 +2440,7 @@ methods’ complexities reaches 80, even if none of the methods was directly repReported methods should be broken down into several smaller methods. Reported classes should probably be broken down into subcomponents.
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.design.CyclomaticComplexityRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.design.CyclomaticComplexityRule
Example(s):
@@ -2548,7 +2548,7 @@ gives information about the values of these metrics:- Low WMC
-This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.design.DataClassRule
+This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.design.DataClassRule
Example(s):
@@ -2604,7 +2604,7 @@ This use of exceptions as a form of - -