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

[TECH] Améliorer le debug des polices d'écriture (PIX-5249) #569

Merged
merged 1 commit into from
Mar 20, 2024

Conversation

yannbertrand
Copy link
Member

🎄 Problème

Avec l'usage historique de SCSS, il n'est pas évident de savoir pourquoi une police d'écriture est utilisée. Une fois compilé, on se retrouve avec un ensemble de propriétés relatives aux polices assez peu utiles pour l'usager de Pix UI, notamment la font-family.

🎁 Proposition

Ajouter une couche d'abstraction sur la font-family utilisée, ainsi "Nunito", Arial, sans-serif devient var(--pix-font-family-title) pour faciliter le debug.

🌟 Remarques

J'aurai bien indiqué que ces nouvelles "variables" sont "privées" car elles ne sont pas censée être utilisées directement, mais le linter m'ennuie :

Expected custom property name "--_pix-font-family-title" to be kebab-case  custom-property-pattern

🎅 Pour tester

Vérifier que les polices sont bien rendues dans la doc des typographies et qu'au debug on retrouve une variable plutôt que des valeurs finales.

@yannbertrand yannbertrand added 👀 Tech Review Needed cross-team Toutes les équipes de dev labels Mar 13, 2024
@yannbertrand yannbertrand self-assigned this Mar 13, 2024
@pix-bot-github
Copy link

Une fois l'application déployée, elle sera accessible à cette adresse https://ui-pr569.review.pix.fr
Les variables d'environnement seront accessibles sur scalingo https://dashboard.scalingo.com/apps/osc-fr1/pix-ui-review-pr569/environment

@yannbertrand yannbertrand changed the title [TECH] Améliorer le debug des polices d'écriture [TECH] Améliorer le debug des polices d'écriture (PIX-5249) Mar 13, 2024
@xav-car
Copy link
Contributor

xav-car commented Mar 14, 2024

mettre un commentaire au dessus // this is private attribut ( use only on placeholder %pix-title / %pix-body)

@yannbertrand
Copy link
Member Author

mettre un commentaire au dessus // this is private attribut ( use only on placeholder %pix-title / %pix-body)

Est-ce que tu penses que rajouter un underscore au début et ajouter un eslint ignore serait utile aussi ?

@xav-car
Copy link
Contributor

xav-car commented Mar 14, 2024

mettre un commentaire au dessus // this is private attribut ( use only on placeholder %pix-title / %pix-body)

Est-ce que tu penses que rajouter un underscore au début et ajouter un eslint ignore serait utile aussi ?

je pense que c'est pas necessaire. après ce sera au reviewer de faire attention. Rien n'empêchera d'utiliser celle avec _ tout de même. (si on va chercher la property. on verra le commentaire donc cela me parait suffisant seulement le commentaire).

@yannbertrand yannbertrand force-pushed the feat-improve-font-debugging branch from d100d9b to 5f814b2 Compare March 14, 2024 14:50
@yannbertrand
Copy link
Member Author

yannbertrand commented Mar 14, 2024

je pense que c'est pas necessaire. après ce sera au reviewer de faire attention. Rien n'empêchera d'utiliser celle avec _ tout de même. (si on va chercher la property. on verra le commentaire donc cela me parait suffisant seulement le commentaire).

Finalement j'ai fait les deux, pour sécuriser au max ^^ (pour ma part j'ai du mal à remonter jusqu'à l'implem de Pix UI quand je travaille côté Pix :()

@yannbertrand yannbertrand force-pushed the feat-improve-font-debugging branch 3 times, most recently from d86d06a to e424ab9 Compare March 19, 2024 10:18
@yannbertrand yannbertrand force-pushed the feat-improve-font-debugging branch from e424ab9 to 7967bda Compare March 20, 2024 10:22
@pix-service-auto-merge pix-service-auto-merge merged commit 7d962f9 into dev Mar 20, 2024
8 of 9 checks passed
@pix-service-auto-merge pix-service-auto-merge deleted the feat-improve-font-debugging branch March 20, 2024 12:32
pix-service-auto-merge pushed a commit that referenced this pull request Mar 20, 2024
## [44.3.8](v44.3.7...v44.3.8) (2024-03-20)

### 🏗️ Tech

- [#569](#569) Améliorer le debug des polices d'écriture (PIX-5249)
@pix-service-auto-merge
Copy link
Contributor

🎉 This PR is included in version 44.3.8 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants