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

Consistent style is not enforced in SCSS files #2741

Open
alanorth opened this issue Jan 14, 2024 · 0 comments
Open

Consistent style is not enforced in SCSS files #2741

alanorth opened this issue Jan 14, 2024 · 0 comments

Comments

@alanorth
Copy link
Contributor

Is your feature request related to a problem? Please describe.
We do not currently enforce any code style in SCSS files. This leads to an inconsistent use of indentation, spacing, and SCSS syntax, which makes it frustrating to compare component styles in themes with those in src/app as well as with each other (for example the custom and dspace themes).

Describe the solution you'd like
We should be enforcing a consistent code style in SCSS files with Prettier and or Stylelint. See this comparison from the Prettier documentation.

Further rationale: if we use an opinionated, automated formatter we can outsource that work to the tool and just forget about it. In the golang community there is gofmt and it is commonly said that:

Gofmt's style is nobody's favourite, but gofmt is everybody's favourite.

Describe alternatives or workarounds you've considered
None.

Additional context
We use checkstyle for Java code in the backend and eslint for TypeScript code in the frontend.

@tdonohue tdonohue moved this from 🆕 Triage to 🙋 Needs Help / Unscheduled in DSpace Backlog Jan 16, 2024
@github-project-automation github-project-automation bot moved this to 🆕 Triage in DSpace Backlog Jan 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 🙋 Needs Help / Unscheduled
Development

No branches or pull requests

1 participant