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

Add syntax highlighting in web frontend #27

Open
1 of 2 tasks
flosell opened this issue Sep 12, 2021 · 0 comments · May be fixed by #40
Open
1 of 2 tasks

Add syntax highlighting in web frontend #27

flosell opened this issue Sep 12, 2021 · 0 comments · May be fixed by #40
Labels
enhancement New feature or request Hacktoberfest These issues are good if you want some hacktoberfest contributions help wanted Extra attention is needed web-frontend Issues related to the web frontend

Comments

@flosell
Copy link
Owner

flosell commented Sep 12, 2021

Context

#24 introduced a basic web frontend to use. At the moment, it provides only very bare-bones functionality with minimal styling.
This issue would add syntax highlighting to both input and output to make it easier to edit and spot things.

Outcomes

  • Add a well supported syntax highlighter and use it on input and output (needs to support JSON and HCL)
    • HCL
    • JSON
  • Prioritise function and usability over prettiness - this tool is used by people who quickly need to achieve a task (to convert a json policy into a different format). The design shouldn't distract from this.

Constraints

  • My own frontend-skills exist but are rusty - you are free to choose the best tools and frameworks for the job, however I'd prefer minimal learning curves and complexity. In doubt, err on the side of simplicity and well known tools for myself and other contributors to maintain this in the long run
  • The tool is primarily used by infrastructure people for their work - I assume most will use it on their desktops and laptops. Therefore, responsive design or mobile friendly features are not a priority (however nice to have)

Related Issues

There are several other issues dealing with the web frontend - check the web-frontend label to get an understanding where overlaps might exist

@flosell flosell added enhancement New feature or request help wanted Extra attention is needed web-frontend Issues related to the web frontend Hacktoberfest These issues are good if you want some hacktoberfest contributions labels Sep 12, 2021
@gordonbondon gordonbondon linked a pull request Nov 1, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Hacktoberfest These issues are good if you want some hacktoberfest contributions help wanted Extra attention is needed web-frontend Issues related to the web frontend
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant