testsmells / tsdetect Goto Github PK

• Smell Detection
• Quick Fix (if applicable)
• Internationalization
• Description
• Display Name
• Short Name
• Unit Tests

Description:
Create a test for each "Smell" that causes the existing code to detect the smell within that test function. Task is only complete once every single "smell" has a corresponding test file with the smell in it.

FOR ALL TESTS: add a javadock and link the website's test to the test file.

• Assertion Roulette d4601d5
• Conditional Test Logic: #12
• Constructor Initialization #13
• Default Test: #12
• Dependent Test:
• Duplicate Assert #7
• Eager Test #7
• Empty Test d4601d5
• Exception Catching Throwing:
• General Fixture #14
• Ignored Test #9
• Lazy Test #14
• Magic Number Test #9
• Mystery Guest #10
• Print Statement #8
• Redundant Assertion #8
• Resource Optimize #11
• Sensitive Equality: @nxb9626
• Sleepy Test #10
• Unknown Test: #13
• Verbose Test:

Users: Everyone
Points: 8

• Smell Detection
• Quick Fix (if applicable)
• Internationalization
• Description
• Display Name
• Short Name
• Unit Tests

Users: Everyone
Points: 3

Chart by smell than file

Fix the logging for QDoana

Chart with file than smell

• Smell Detection
• Quick Fix (if applicable)
• Internationalization
• Description
• Display Name
• Short Name
• Unit Tests

• Smell Detection
• Quick Fix (if applicable)
• Internationalization
• Description
• Display Name
• Short Name
• Unit Tests

Refactor Shannon's stuff to see what we can use

• Smell Detection
• Quick Fix (if applicable)
• Internationalization
• Description
• Display Name
• Short Name
• Unit Tests

Determine the milestones for the project.
The milestones will be associated with each issue

• Smell Detection
• Quick Fix (if applicable)
• Internalization
• Description
• Display Name
• Short Name
• Unit Tests

• Smell Detection
• Quick Fix (if applicable)
• Internationalization
• Description
• Display Name
• Short Name
• Unit Tests

• Detected Smells
• Smelly Files
• Smell Type Distribution
• File Distribution
• Unit Tests

Guidelines for using intellij components in the ui:
https://jetbrains.github.io/ui/
Intellij platform ui kit:

• potentially useful for modeling how the ui will look
  https://blog.jetbrains.com/idea/2021/05/intellij-platform-ui-kit/
  https://www.figma.com/community/file/938505862996154830

A list of open source tools to do with java swing, potentially useful but most seem only tangentially related
https://github.com/parubok/awesome-swing

This seems to be the best for charts for displaying our results, however it has different versions for different os's, which could be problematic, however the main sites download page just takes straight to a github build:
https://www.jfree.org/jfreechart/
https://www.javatpoint.com/jfreechart-tutorial

How do you do this
Can you do this and utilize IntelliJ SDK?

• Smell Detection
• Quick Fix (if applicable)
• Internationalization
• Description
• Display Name
• Short Name
• Unit Tests

• Create vm fresh for everything and use that to verify steps
• Save references to install

• Smell Detection
• Quick Fix (if applicable)
• Internationalization
• Description
• Display Name
• Short Name
• Unit Tests

• Smell Detection
• Quick Fix (if applicable)
• Internationalization
• Description
• Display Name
• Short Name
• Unit Tests

Pie Chart

-Multiple language files - you do not have to have actual translations; dummy text is fine. We need to know how to create and organize the property files.

-What will happen if we don't have a property file corresponding to the user's locale? E.g., No en_US file.

-What is the naming convention we need to use for the names of the keys?

Determine the labels we need for the issue tracker

https://guides.github.com/features/issues/#filtering

• Smell Detection
• Quick Fix (if applicable)
• Internalization
• Description
• Display Name
• Short Name
• Unit Tests

• Smell Detection
• Quick Fix (if applicable)
• Internalization
• Description
• Display Name
• Short Name
• Unit Tests

• Ensure tests are working properly
• Create Repo

• Smell Detection
• Quick Fix (if applicable) Comment this method
• Internalization
• Description
• Display Name
• Short Name
• Unit Tests

Displaying the results of the scan by unit test in its own tab

Ideally this will be result in a tentative layout for the design of the side panel, so that when implementation begins few modifications will be needed. Any other general look decisions would also be welcome.
Figma UI toolkit provided by Intellij may be helpful:
https://www.figma.com/community/file/938505862996154830

• Smell Detection
• Quick Fix (if applicable)
• Internationalization
• Description
• Display Name
• Short Name
• Unit Tests

Points: 1

Description:
Research the libraries we plan to use for the intelliJ plugin, as well as the existing libraries that are used to create plugins with IntelliJ

Users: Everyone
Points: 5

• Smell Detection
• Quick Fix (if applicable)
• Internationalization
• Description
• Display Name
• Short Name
• Unit Tests

• Smell Detection
• Quick Fix (if applicable)
• Internationalization
• Description
• Display Name
• Short Name
• Unit Tests

• Smell Detection
• Quick Fix (if applicable)
• Internationalization
• Description
• Display Name
• Short Name
• Unit Tests

Lowest priority

• Smell Detection
• Quick Fix (if applicable)
• Internationalization
• Description
• Display Name
• Short Name
• Unit Tests

Table with plain numbers

• UI Unit Testing
• Name Tabs and Buttons Properly

-There are a couple of approaches. Which is the best for us?
-Define every inspection in the plugin xml
-Load the inspections at runtime

-What is the "createOptionsPanel" method? Do we need to override it?

-How do we explicitly call the inspection? I.e., instead of opening a file, we click a button to scan all (or specific) files in the project

-How can we get the output? Show all the violations in a custom UI.

• Tabs
• Display tabular/chart
• Export csv/png
• Analyze
• Help
• Unit Tests

When the 'Run Analysis' button is pressed, a loading icon/animation/gif would inform the user that something is happening.

• Smell Detection
• Quick Fix (if applicable)
• Internationalization
• Description
• Display Name
• Short Name
• Unit Tests

• Smell Detection
• Quick Fix (if applicable)
• Internalization
• Description
• Display Name
• Short Name
• Unit Tests

• Write Settings
• Read Settings
• Unit Tests

@shehan Could we get some further explanation on what this is referring to?