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

Suppress messages that indicate missing Platform layout entries in the filesystem #1842

Merged
merged 2 commits into from
Dec 13, 2024

Conversation

novotnyr
Copy link
Contributor

@novotnyr novotnyr commented Dec 13, 2024

Pull Request Details

Logs might contain the following messages:

Layout component 'emoji-picker' has some nonexistent 'classPath' elements: 'plugins/emojipicker.jar'

This is an incorrect Platform layout where the declaration in the product-info.json does not match the real filesystem of the Platform. For example, emoji-picker is declared in the macOS, but available only on Linux.

Such messages are not actionable from the plugin developer side and should be suppressed.

When constructing Platform model, ignore missing layout entries, too.

Note that such message might occur when running the Plugin Verifier via verifyPlugin task. Use the freeArgs() and the -missing-layout-classpath-file CLI switch for the Plugin Verifier.

Description

  • Use a customized way to create an IDE for the plugin model in the IntelliJ helper.

Motivation and Context

Misleading and nonactionable messages confuse plugin developers and make them think this should be fixed on their side

How Has This Been Tested

Ran against sample project based on the IntelliJ Plugin Template.

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have included my change in the CHANGELOG.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@novotnyr novotnyr requested a review from hsz December 13, 2024 10:06
@novotnyr novotnyr force-pushed the ide-silently-skip-missing-layout-entries branch from 1b1affa to 9f0f114 Compare December 13, 2024 10:59
@novotnyr novotnyr marked this pull request as ready for review December 13, 2024 11:17
@hsz
Copy link
Member

hsz commented Dec 13, 2024

Thanks!

@hsz hsz merged commit 6fda36a into main Dec 13, 2024
11 checks passed
@hsz hsz deleted the ide-silently-skip-missing-layout-entries branch December 13, 2024 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants