Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Static Analysis Tool: Plato #41

Merged
merged 18 commits into from
Oct 31, 2024
Merged

Added Static Analysis Tool: Plato #41

merged 18 commits into from
Oct 31, 2024

Conversation

alicekang1
Copy link

@alicekang1 alicekang1 commented Oct 24, 2024

I will preface and say this was not on the 313 Starter List of Static and Dynamic tools, but it was listed on the Other Resources link. I checked with Prof Milton and he said this was okay for having "at least one tool that is not from our starter list".

NOTE: The only test our implementation fails to pass are the lint tests. The TAs mentioned that if we were implementing a different static analysis tool, this is what should be happening (the TAs said it would be okay without the green check mark in this scenario).

Plato is a static analysis tool used to visualize code complexity.

Concrete evidence that you had successfully installed the tool:

  • Added plato-report/ to repository
  • plato-report/... includes many new files, one being index.html. This file will let you view on a browser the complexity of your code in a readable and interactive UI format.

Concrete evidence that you had successfully installed the tool:

  • Provided are screenshots of the index.html file that monitor NodeBB:
Screenshot 2024-10-24 at 11 16 11 AM Screenshot 2024-10-24 at 11 16 31 AM Screenshot 2024-10-24 at 11 17 00 AM

JasmineRocket

This comment was marked as resolved.

Copy link

@JasmineRocket JasmineRocket left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Solid evidence of tool installation by concrete amount of files added to the codebase, tests are working well and tools are functioning properly. Looks good to me!

@alicekang1 alicekang1 self-assigned this Oct 25, 2024
@alicekang1 alicekang1 added this to the Sprint 3 milestone Oct 25, 2024
@alicekang1 alicekang1 added the enhancement New feature or request label Oct 25, 2024
@coveralls
Copy link

coveralls commented Oct 28, 2024

Pull Request Test Coverage Report for Build 11563041425

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.006%) to 82.722%

Totals Coverage Status
Change from base Build 11441420770: 0.006%
Covered Lines: 22359
Relevant Lines: 25613

💛 - Coveralls

Copy link

@jullia02 jullia02 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully added tool reports and added tool to workflow for commits to the main branch, looks good to me!

@jullia02 jullia02 merged commit ba1b64b into f24 Oct 31, 2024
1 check failed
@jullia02
Copy link

Lint Test Failure Status Explanation

The default ESLint workflow check is failing because Plato's configuration does not align with the default ESLint rules. This is expected behavior as Plato has its own linting standards which we want to preserve for consistency. Moreover, changing Plato's code to match the ESLint rules could make future updates and maintenance more difficult. Our dedicated Plato integration workflow (.github/workflows/plato.yml) has passed successfully, confirming that our tool integration is working as intended.
Screenshot 2024-10-31 at 4 38 58 PM
Link: https://github.com/CMU-313/nodebb-f24-sweethearts/actions/runs/11616104264

mhli1260 added a commit that referenced this pull request Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants