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

Automatically wrap admonition code-blocks in linting #1986

Open
sarayourfriend opened this issue May 2, 2023 · 1 comment
Open

Automatically wrap admonition code-blocks in linting #1986

sarayourfriend opened this issue May 2, 2023 · 1 comment
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: documentation Related to Sphinx documentation

Comments

@sarayourfriend
Copy link
Contributor

sarayourfriend commented May 2, 2023

Problem

Prettier skips wrapping code blocks. This becomes a problem for Sphinx admonition directives. See this commit as an example:

4e46865

Description

Write a plugin for prettier, as described by #2348. We need to find some other approach for this (see comment below)

@sarayourfriend sarayourfriend added 🟨 priority: medium Not blocking but should be addressed soon 🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🧱 stack: documentation Related to Sphinx documentation labels May 2, 2023
@sarayourfriend sarayourfriend changed the title Find some way to apply prettier to admonition code-blocks Automatically wrap admonition code-blocks in linting May 2, 2023
@sarayourfriend sarayourfriend self-assigned this Nov 22, 2023
@sarayourfriend
Copy link
Contributor Author

It's not possible to use a prettier plugin without publishing it or without switching to a local hook for prettier like we use for eslint. That's not really an option, it seems, otherwise we'll be adding pnpm as a dev dependency for the entire monorepo, rather than just the frontend (which is currently the case).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: documentation Related to Sphinx documentation
Projects
Status: 📋 Backlog
Development

No branches or pull requests

1 participant