[Devcontainers frontend plugin] Make the component hidden if no annotation is present

Open
#145 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Stale
Tech stack
typescript
Domain
frontend

Research direction

Start in packages/app/src/components/catalog/EntityPage.tsx and inspect the DevcontainersProvider EntitySwitch case, along with the existing DEVCONTAINERS_ANNOTATION and isDevContainersAvailable references. Done means the component is hidden when the annotation is absent and remains visible when the correct annotation is present.

Written by the indexing model from the issue text.

Description

enhancement

If the annotation is not present, make the DevcontainersProvider component hidden.

This should be working in packages/app/src/components/catalog/EntityPage.tsx:

    <EntitySwitch>
    <EntitySwitch.Case if={isDevContainersAvailable}>
    <Grid item md={6} xs={12}>
      <DevcontainersProvider config={devcontainersConfig}>
        <ExampleDevcontainersComponent/>
      </DevcontainersProvider>
    </Grid>
    </EntitySwitch.Case>
    </EntitySwitch>

The isDevContainersAvailavble function should check if the correct annotations are in place like (pseudocode):

export const isDevContainersAvailable = (entity: Entity) =>
  Boolean(entity.metadata.annotations?.[DEVCONTAINERS_ANNOTATION]);

This way the item can be hidden and the page can be cleaner.

Dominant language
TypeScript
Stars
67
Forks
9
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from coder/backstage-plugins

All issues in coder/backstage-plugins

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.