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

feature: Why stop at Python? #4

Open
pawamoy opened this issue Jul 9, 2024 · 1 comment
Open

feature: Why stop at Python? #4

pawamoy opened this issue Jul 9, 2024 · 1 comment
Assignees
Labels
feature New feature or request insiders Candidate for Insiders

Comments

@pawamoy
Copy link
Owner

pawamoy commented Jul 9, 2024

Is your feature request related to a problem? Please describe.

Just realized that docs can have legacy text too, so why stop at Python?

Describe the solution you'd like

Support other comment prefixes (not the YORE word but the actual characters to denote comments).

  • Markdown, HTML: <!-- ... -->
  • CSS: /* ... */
  • TOML, YAML, Ruby, shell: same (# ...)
  • Jinja: {# ... #}
  • Javascript/Typescript/C/C++/C#: // ...
  • what else? (please comment)

Looks like we can go with (comment_prefix, comment_suffix) tuples in a file extension mapping 🤔

Describe alternatives you've considered

/

Additional context

Since we wanted to support dependencies in #3, we would have to find a way to support other ecosystems 🤔 Maybe we could infer the ecosystem based on the extension of the file the comment was found in. For example, a comment found in a *.py file will target the Python ecosystem.

@pawamoy pawamoy added the feature New feature or request label Jul 9, 2024
@pawamoy pawamoy self-assigned this Jul 9, 2024
@pawamoy
Copy link
Owner Author

pawamoy commented Jul 10, 2024

Actually, a single file can use different comment syntaxes. For example, a Python module can both have # YORE: ... comments (code comments) and <!-- YORE: ... --> comments (Markdown docstrings). So maybe we should parse all syntaxes in every file 🤔

@pawamoy pawamoy added fund Issue priority can be boosted insiders Candidate for Insiders labels Oct 25, 2024
@pawamoy pawamoy removed the fund Issue priority can be boosted label Mar 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request insiders Candidate for Insiders
Projects
None yet
Development

No branches or pull requests

1 participant