6314730DEV3147-66cbc2c723-27
Make duplicate names catcher more powerful. This test pack is disabled now because names duplication is not caught here. It happens because of "duplicate-names.xsl" thinks that abstract objects in the tests are on the different levels. Syntactically they are, but semantically they're not. So we need to make this duplicate catcher more powerful, enable the test by removing "skip: true" line and make sure it works.
src/test/resources/org/eolang/lints/errors/catches-conflict-with-auto-name.yaml@yegor256yegor256@gmail.com341435DEV14-e039e30739-42
Calculate comment line number with abusive character. For now we just reusing object line number (via @line), which is not correct for specifying on which line of the program comment is located. This issue can be solved after <a href="https://github.com/objectionary/eo/issues/3536">this one</a>.
src/main/java/org/eolang/lints/comments/AsciiOnly.java@rultorme@rultor.com411945DEV19-80f5b41d45-47
Create Lint envelope called `JavaLint` that will fetch motive from Markdown file based on the lint's name (Java class name) and lint's dimension (Java package name, e.g. `comments`).
src/main/java/org/eolang/lints/comments/AsciiOnly.java@yegor256yegor256@gmail.com421935DEV19-33379f103-5
Document motives for `not-empty-atoms` lint. Currently, we don't have a test case for this `not-empty-atoms` lint. We should create a new test case, and then document a motive for this lint.
src/main/resources/org/eolang/motives/critical/not-empty-atoms.md@yegor256yegor256@gmail.com431935DEV19-e20aed593-5
Document motives for `same-line-names` lint. Currently, we don't have a test case for this `same-line-names` lint. We should create a new test case, and then document a motive for this lint.
src/main/resources/org/eolang/motives/critical/same-line-names.md@yegor256yegor256@gmail.com441935DEV19-ccc6357f5-8
Document motives and examples for `empty-object` lint. Currently, we don't have a test case for this `empty-object` lint. We should create a new test case, and then document a motive with examples for this lint.
src/main/resources/org/eolang/motives/errors/empty-object.md@yegor256yegor256@gmail.com451930DEV19-c076b49011-13
Document more about `broken-refs` lint. Currently, there is no unit test that finds defects with broken refs. Let's add a few, and only then add more docs in broken-ref's motive.
src/main/resources/org/eolang/motives/refs/broken-refs.md@yegor256yegor256@gmail.com1257260DEV72-f7af213e49-53
Configure maven to download model file during the build and place into the JAR. Currently, we download model file each time when creating the lint, which may be slow in the usage of this lint. Instead, let's configure maven to download model file during the build, and place into JAR, so lint will be able to locate file from resources faster.
src/main/java/org/eolang/lints/misc/UnitTestIsNotVerb.java@rultorme@rultor.com13512960DEV129-28f9134856-60
Library stanford-corenlp-4.5.7-models.jar takes too much in size. Currently, JAR takes ~452mb, which may cause some troubles to the users of the lints library. Let's think what we can do about this. We should check is it possible to get rid of this dependency and download models from the other source.
src/main/java/org/eolang/lints/misc/UnitTestIsNotVerb.java@rultorme@rultor.com14313445DEV134-6f7709d554-58
Measure lint time for smaller/larger classes, similar way to JNA Pointer. Currently, we measure linting of just one big class. Would be good to measure other classes in size too, for instance smaller classes (standard program), large class (JNA pointer), x-large class, and xxl class. Don't forget to adjust lint-summary.txt file to capture all the measurements.
src/test/java/org/eolang/lints/ProgramTest.java@yegor256yegor256@gmail.com47014335DEV143-358342b330-33
Add JMH benchmarks result reporting. Currently, there is no reporting of benchmark results. Let's add <a href="https://github.com/volodya-lombrozo/jmh-benchmark-action">this</a> GitHub Actions plugin and configure it to run on each PR.
src/test/java/benchmarks/ProgramBench.java@rultorme@rultor.com14413490DEV134-6deff79b59-64
Capture all the lint timings in timings.csv. Currently, we just capture total time - amount of milliseconds was required to lint some XMIR. Would be helpful to get extended statistics - timings of each lint. Don't forget to include this information into lint-summary.txt. You can check how it was implemented in HONE: <a href="https://github.com/objectionary/hone-maven-plugin/blob/master/src/main/java/org/eolang/hone/Timings.java">Timings.java</a>.
src/test/java/org/eolang/lints/ProgramTest.java@yegor256yegor256@gmail.com19014435DEV144-43965ba3319-322
Resolve code duplication with Program.java class. Currently, BcProgram.java is duplication of Program.java. Let's make it use the original Program.java, so they will stay synced. Don't forget to remove this puzzle.
src/test/java/org/eolang/lints/ProgramTest.java@yegor256yegor256@gmail.com50914435DEV144-a2c4deb3436-439
Resolve code duplication with Source.java class. Currently, BcSource.java is duplication of Source.java. Let's make it use the original Source.java, so they will stay synced. Don't forget to remove this puzzle.
src/test/java/org/eolang/lints/SourceTest.java@h1alexbelh1alexbelx@gmail.com15714830DEV148-2fd39dd638-43
Test or remove {@link Defect#rule()} method. This method is not used by any class in the project. Moreover, we don't even have a test for it. We should either test it or remove it. Actually, this method is used <a href="https://github.com/objectionary/lints/pull/150/files#r1888310583">somewhere</a>
src/main/java/org/eolang/lints/Defect.java@rultorme@rultor.com15814830DEV148-092aa30a38-40
The {@link XslLints} class should implement {@link Lint} instead. Currently, this class is used as an iterable of lints, but it should be used as a single lint that aggregates other lints.
src/main/java/org/eolang/lints/XslLints.java@rultorme@rultor.com16014830DEV148-e3c5890738-40
The {@link PkByXsl} class should implement {@link Lint} instead. Currently, this class is used as an iterable of lints, but it should be used as a single lint that aggregates other lints.
src/main/java/org/eolang/lints/PkByXsl.java@yegor256yegor256@gmail.com19214935DEV149-6bce14ac165-167
Introduce new class XmirKey.java Let's extract the code that calculates the key for XMIR file into new Java class. Don't forget to create unit tests, and remove this puzzle.
src/main/java/org/eolang/lints/Programs.java@yegor256yegor256@gmail.com21510745DEV107-b3a5bdea23-25
Configure default timeout for tests running on windows to 10s and 3s on other platforms. Currently, it fails with the 3s timeout on windows platform. Let's try to configure test default timeout exclusively for windows, and keep 3s for other platforms.
src/test/resources/junit-platform.properties@yegor256yegor256@gmail.com21619930DEV199-3cb36c43170-176
Use {@link XML#xpath(String)} Method Instead. This method is using a custom implementation to find the name of the program. We should replace it with the {@link XML#xpath(String)} method to make the code cleaner. You can use `program.xpath("/program/@name").stream().findFirst().orElse("unknown")` to find the name. This issue is blocked by <a href="https://github.com/jcabi/jcabi-xml/issues/289">jcabi/jcabi-xml#289</a>.
src/main/java/org/eolang/lints/LtByXsl.java@yegor256yegor256@gmail.com21719930DEV199-c82777d8188-194
Use {@link XML#nodes(String)} Method Instead. This method is using a custom implementation to find defects in the report. We should replace it with the {@link XML#nodes(String)} method to make the code cleaner. You can use `report.nodes("/defects/defect")` to find the defects. This issue is blocked by <a href="https://github.com/jcabi/jcabi-xml/issues/288">jcabi/jcabi-xml#288</a>.
src/main/java/org/eolang/lints/LtByXsl.java@yegor256yegor256@gmail.com27625760DEV257-9496b6b452-56
Configure model download only during the build and place into the JAR. Currently, we download model file each time when creating the lint, which may be slow in the usage of this lint. Instead, let's configure maven to download model file during the build, and place into JAR, so lint will be able to locate file from resources faster.
src/main/java/org/eolang/lints/misc/LtTestNotVerb.java@yegor256yegor256@gmail.com31329735DEV297-589ae9b741-45
Return `LtTestNotVerb` back. For some reason this lint produces errors in EO-to-Java Compiler. Check <a href="https://github.com/objectionary/lints/issues/297#issuecomment-2636540673">this</a> issue for more details. We should return it in the fixed state, once we understand the root cause of the problem.
src/main/java/org/eolang/lints/PkMono.java@yegor256yegor256@gmail.com36525960DEV259-5bf6866f24-28
Optimize performance of inconsistent arguments finding. Instead of re-collecting objects in nested loops, we should merge all objects from all programs into single XMIR under '<objects/>' element. After objects are merged, we can iterate over all the objects there only once, and find inconsistencies.
src/main/java/org/eolang/lints/LtInconsistentArgs.java@yegor256yegor256@gmail.com37236890DEV368-1edf74b716-18
Implement lint caching decorator. We should cache `Lint.defects()` to cache found defects when calling particular lint. Don't forget to add unit tests, and benchmark tests.
src/main/java/org/eolang/lints/Lint.java@yegor256yegor256@gmail.com38536845DEV368-78b44b68112-116
Configure `unlint-non-existing-defect` lint to ignore unlints from other scope (WPA/Single program). On WPA side of this lint ({@link LtUnlintNonExistingDefectWpaTest}) we should ignore single program lints. Also, don't forget to enable {@link LtUnlintNonExistingDefectWpaTest#ignoresSingleProgramUnlint()}.
src/test/java/org/eolang/lints/LtUnlintNonExistingDefectTest.java@yegor256yegor256@gmail.com39238630DEV386-d4b4e10820-24
Replace `XML.xpath()` with `Xnav.path()` usage in defects() method. Currently, we cannot use `Xnav.path()` method due to <a href="https://github.com/volodya-lombrozo/xnav/issues/74">this</a> bug. Once it will be resolved, we should replace `XML.xpath()` with `Xnav.path()` in order to improve the performance of the `LtUnlint.defects()` execution.
src/main/java/org/eolang/lints/LtUnlint.java@yegor256yegor256@gmail.com40539425DEV394-da4e25ec95-97
Replace `LtAlways` in comparison with lint caching decorator. Currently, its not available, once <a href="https://github.com/objectionary/lints/issues/372">this</a> ticket will be solved, we can replace the class.
src/test/java/org/eolang/lints/PkMonoTest.java@yegor256yegor256@gmail.com43642960DEV429-a4557e2426-29
Convert all found {@link Defect}-s into XML and then assert using XPath. For now we are using custom asserts outlined in implementations of {@link Assertion} interface. Conversion to XML document can eliminate the need to custom asserts, since we will be able to utilize XPath expressions similarly as in {@link XtYaml#asserts()}.
src/test/java/org/eolang/lints/WpaStory.javah1alexbelh1alexbelx@gmail.com46516560DEV165-a8f393c823-28
Add {@link LtReservedName} to the LINTS Mono pipeline. Currently, it will cause timeout exceptions in several places in tests, due to the design of {@link LtReservedName}. There, it scans all the home EO objects, pulled from Git by maven in the `generate-sources` phase, and process them. Will be great to process home objects only once - initially during the build, and then reuse it everywhere.
src/main/java/org/eolang/lints/MonoLints.java@rultorme@rultor.com60246545DEV465-7c10eaab31-35
Refactor HomeNames. Currently, the class does two things: 1) Object name parsing, and 2) CSV placing. Let's refactor it to make it aligned with <a href="https://en.wikipedia.org/wiki/Single-responsibility_principle">SRP</a>. Probably one new class will be required (for name parsing), together with proper naming of this one (for placing them into CSV).
src/main/groovy/org/eolang/lints/HomeNames.groovy@h1alexbelh1alexbelx@gmail.com50225960DEV259-23892a1e26-30
Optimize performance of inconsistent arguments finding. Instead of re-collecting objects in nested loops, we should merge all objects from all programs into single XMIR under '<o/>' element. After objects are merged, we can iterate over all the objects there only once, and find inconsistencies.
src/main/java/org/eolang/lints/LtInconsistentArgs.java@rultorme@rultor.com52040215DEV402-462e483a31-34
Replace the creation of new ArrayList<>(0) with the creation of ArrayList<>() without a constructor argument in whole project. Add ignore warning ConditionalRegexpMultilineCheck from Checkstyle (it doesn't seem to be possible at the moment <a href="https://github.com/yegor256/qulice/issues/1328">issue 1328</a>)
src/main/java/org/eolang/lints/LtAsciiOnly.java@rultorme@rultor.com56355535DEV555-aaf5c23c44-46
Enable `duplicate-names-in-diff-context` benchmark. Currently, its slow, especially for `L` and `XL`-sized sources. Let's optimize it, in order to enable this benchmark.
src/test/java/benchmarks/SourceBench.java@h1alexbelh1alexbelx@gmail.com59237660DEV376-92eafa5248-51
Enable redundant object in the single XMIR scope benchmarks. As for now, the lint is too slow, especially on L, XL and XXL-sized XMIRs. This happens mostly because of multiple XPath `//o` selects in the XSL. Once, the lint will be optimized, we can enable the lint in the benchmarks.
src/test/java/benchmarks/SourceBench.java@yegor256yegor256@gmail.com62739330DEV393-4973abd922-26
DEV Introduce LfDfSticky integration tests. LfDfSticky is used in PkMono and PkWpa, which in turn are used in Program and Programs. Run Program::defects and Programs::defects separately and check that caching works correct. Important to note that specific Lint implementation is highly coupled with PkMono class, which in turn is used in Program's most used constructor, so probably Program(s) refactoring is required.
src/main/java/org/eolang/lints/LtDfSticky.java@yegor256yegor256@gmail.com65262460DEV624-70aa78e15-10
Enable `catches-inconsistency-in-nested-anonymous-formations` test story. For now, its disabled because `LtInconsistentArgs` fails to convert parent tree with anonymous objects to searchable XPath for the XMIR. We should change our logic in both `LtInconsistentArgs#voidFqn()` and `VoidXpath`. Don't forget to enable `catches-inconsistency-resolving-anonymous-path.yaml`, `catches-inconsistency-when-parent-object-lacks-name.yaml`, and test stories as well.
src/test/resources/org/eolang/lints/packs/wpa/inconsistent-args/catches-inconsistency-in-nested-anonymous-formations.yamlYegor Bugayenkoyegor256@gmail.com68054060DEV540-1cf7838e10-14
Add a new style package - `write-good` - to both this list and the package list. Then fix all the issues it reports(there will be a lot). It’s better to run Vale locally to find issues, since the GitHub Action outputs the list in a less readable format when there are many errors. format due to the large number of errors.
.vale.ini@Marat-Tim108345628+Marat-Tim@users.noreply.github.com68567635DEV676-fcdc9c7d12-16
Remove `+unlint application-without-as-attributes`. Currently, eo-parser does not generate `@as` attributes for applications, once we will resolve the problem in parser: https://github.com/objectionary/eo/issues/4382, we should enable it in all the places, including: `SourceTest#returnsEmptyListOfDefects` and `SourceTest#returnsOnlyOneDefect`.
src/test/resources/org/eolang/lints/canonical.eoAliaksei Bialiauskih1alexbelx@gmail.com68667145DEV671-0cafd5ba17-21
Adjust `DefectMissing` to handle unlints with line ranges. Currently we don't support such line ranges in this and {@link LtUnlintNonExistingDefectWpa} lint, but we should, since {@link LtUnlint} supports them. If we will add the support of line ranges here, `unlint-non-existing-defect` in both scopes should catch up it. Don't forget to add tests for both scopes.
src/main/java/org/eolang/lints/DefectMissing.java@h1alexbelh1alexbelx@gmail.com71571145DEV711-894ffa0c387-390
Enable `hone` profile on all platforms after. For now, `hone-maven-plugin` fails on `macOS` and `Windows` machines. After the issue will be fixed, we should `<os/>` element from the `<activation/>` and keep `activeByDefault=true`.
pom.xml@h1alexbelh1alexbelx@gmail.com72371635DEV716-7b35e97f17-21
Enable hone.yml and jmh.yml (hone-dependent workflow) after hone will be fixed. At present, the hone is unable to generate the correct optimized byte code for Groovy, see this issue: https://github.com/objectionary/hone-maven-plugin/issues/297. Also, the plugin run is time-consuming, we should enable it only after the plugin will have stable execution time, in order to not disturb the development in this repository.
.github/workflows/hone.yml@h1alexbelh1alexbelx@gmail.com76976760DEV767-c4e8991565-68
Decrease timeouts for source linting. As for now, most lints are too slow, we need to optimize them first, so they run in milliseconds, not seconds/minutes. It should decrease our build time too. After that, we need to decrease our test timeouts. Don't forget to remove this puzzle.
src/test/java/org/eolang/lints/SourceTest.javaAliaksei Bialiauskih1alexbelx@gmail.com