community-plugins icon indicating copy to clipboard operation
community-plugins copied to clipboard

🔧 Repository: Remove Usages of `@spotify/prettier-config`

Open awanlin opened this issue 10 months ago • 10 comments

📜 Description

In the 1.34.0 release of Backstage the CLI now ships with a replacement for @spotify/prettier-config. Given this change we should remove all usages of @spotify/prettier-config.

👍 Expected behavior

We should not be using @spotify/prettier-config and it should be removed. The prettier config in the root package.json file for various workspaces should be updated to use @backstage/cli/config/prettier

👎 Current Behavior

Currently @spotify/prettier-config is still being used in the following workspaces:

  • ~~3scale~~
  • ~~acr~~
  • ~~feedback~~
  • graphiql
  • ~~jaeger~~
  • ~~jfrog-artifactor~~
  • ~~keycloak~~
  • ~~kiali~~
  • ~~matomo~~
  • ~~mend~~
  • mta
  • ~~nexus-repository-manager~~
  • ~~npm~~
  • ~~ocm~~
  • ~~pingidentity~~
  • ~~quay~~
  • ~~rbac~~
  • ~~redhat-argocd~~
  • ~~redhat-resource-optimization~~
  • ~~repo-tools~~
  • ~~report-portal~~
  • ~~scaffolder-relation-processor~~
  • ~~tekton~~
  • ~~topology~~

This list was pulled from this Renovate PR: https://github.com/backstage/community-plugins/pull/2437 and also looking at the code base as some had already gone to 15.

⚙️ Potential Solution

To fix this each workspace would need to do the following:

  1. Version bump to 1.34.x or greater
  2. Remove @spotify/prettier-config from the workspace's root package.json file
  3. Update prettier property in the workspace's root package.json file to be "prettier": "@backstage/cli/config/prettier",

👀 Have you spent some time to check if this bug has been raised before?

  • [X] I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

Are you willing to submit PR?

No, but I'm happy to collaborate on a PR with someone else

awanlin avatar Jan 10 '25 18:01 awanlin

Hi @christoph-jerolimov, any chance you can do this for the rbac, acr and npm workspaces?

awanlin avatar Jan 10 '25 18:01 awanlin

Hi @04kash, can you do 3scale and scaffolder-relation-processor?

awanlin avatar Jan 10 '25 19:01 awanlin

Can I work on this @awanlin?

aljesusg avatar Jan 14 '25 10:01 aljesusg

For sure @aljesusg, feel free to pick a workspace. Ideally we would do these in individual PRs per workspace to make it easier to review and merge.

awanlin avatar Jan 14 '25 15:01 awanlin

A ok I was thinking about to do all together

aljesusg avatar Jan 14 '25 16:01 aljesusg

Opening this again as @spotify/prettier-config hasn't been removed from all the listed workspaces

04kash avatar Jan 15 '25 23:01 04kash

Hi @christoph-jerolimov, any chance you can do this for the rbac, acr and npm workspaces?

I missed that before.. yes I can do that. I will also remove it from ocm where I'm working on a bigger dependency-upgrade PR

christoph-jerolimov avatar Jan 16 '25 21:01 christoph-jerolimov

Reopening as I see that the following workspaces are still using @spotify/prettier-config:

  • pingidentity
  • quay
  • ocm
  • rbac
  • analytics
  • scaffolder-backend-module-regex
  • keycloak
  • acr
  • mta
  • npm

04kash avatar Feb 25 '25 19:02 04kash

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Apr 27 '25 00:04 github-actions[bot]

I think all spotify/prettier package have been deleted except 'graphiql'

apc-kamezaki avatar May 14 '25 01:05 apc-kamezaki

The usage was removed from graphiql workspace in https://github.com/backstage/community-plugins/pull/4428, so this should be good to close now! 🎉

BethGriggs avatar Jul 21 '25 23:07 BethGriggs