Skip to content
This repository was archived by the owner on Jan 19, 2025. It is now read-only.

feat: improved filters in GUI #504

Merged
merged 49 commits into from
May 27, 2022

Conversation

lars-reimann
Copy link
Member

@lars-reimann lars-reimann commented May 20, 2022

Closes #487.

Summary of Changes

  • Replace setting "Show private declarations" with visibility filter
  • Replace class:xy etc. filter with separate filters is:class and name:xy
  • New filter: annotation:any
  • New filter: annotation:@xy
  • Negated filters
  • Display truly matching elements in bold (other elements in their hierarchy are still shown)
  • Update help text (popover to the right of the filter text box)
  • Bug: First parameter cannot be annotated during filtering even though it's not actually the first parameter
  • Unit tests for filters
  • Code documentation for filters

Screenshots (if necessary)

image

Testing Instructions

  1. Open a terminal in the root of the repository folder
  2. Run this command
cd api-editor/gui
npm run dev
  1. Open localhost:3000 in the browser (if the port is taken it might be different, check the output of the previous command in your terminal)
  2. Open the help dialog next to the filter box (top right corner)
  3. Try different combinations of the filters listed there and observe the changes to the tree view.

@lars-reimann
Copy link
Member Author

@Masara @DavidTen1 Please use this as the basis going forward. It seems to roughly work as expected now but should be verified by unit tests before the PR is merged.

@github-actions
Copy link

github-actions bot commented May 20, 2022

MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ CREDENTIALS secretlint yes no 3.85s
✅ GIT git_diff yes no 0.01s
✅ TYPESCRIPT prettier 29 0 0 2.85s

See errors details in artifact MegaLinter reports on CI Job page
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

@lars-reimann lars-reimann changed the title feat: api editor aditional filter commands feat: improved filters in GUI May 23, 2022
@lars-reimann lars-reimann force-pushed the 487-api_editor_aditional_filter_commands branch from fd2ecc5 to c322fdd Compare May 23, 2022 13:26
@lars-reimann lars-reimann force-pushed the 487-api_editor_aditional_filter_commands branch from 45b614a to 59f5b97 Compare May 23, 2022 14:46
@lars-reimann lars-reimann marked this pull request as ready for review May 25, 2022 15:12
Copy link
Contributor

@jofaul jofaul left a comment

Choose a reason for hiding this comment

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

LGTM - lots of code with no tests, but since this is the webapp where bugs are either obvious or impossible to find it should be fine.

@lars-reimann lars-reimann merged commit 4f8118d into main May 27, 2022
@lars-reimann lars-reimann deleted the 487-api_editor_aditional_filter_commands branch May 27, 2022 11:55
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API Editor: Additional Filter commands
3 participants