Enable Vue attribute formatting rules without changing rendered behavior

Open
#9,499 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
Half a day
Newbie friendliness
70/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Active
Tech stack
javascript

Research direction

Start in eslint.config.mjs under the libresign/disabled-during-migration block and remove only the 'off' entries for vue/first-attribute-linebreak and vue/max-attributes-per-line. Run the dry-run layout preview on src/**/*.vue and check that the proposed edits only split or join attribute lines. Done when both rules are enabled, the diff changes only attribute layout, and npm run lint, npm run ts:check and npm run build pass.

Written by the indexing model from the issue text.

Description

frontend good first issue help wanted javascript technical debt

Goal

Enable two Vue template attribute-layout ESLint rules without changing HTML content, component behavior or visible UI. The work is layout-only and uses the existing ESLint preset and autofix workflow.

Rules

  • vue/first-attribute-linebreak (historical estimate: ~435 hits)
  • vue/max-attributes-per-line (historical estimate: ~68 hits)

Counts are historical and may overlap; measure the current main before starting.

Good first issue

Start at eslint.config.mjs, inside libresign/disabled-during-migration, and at existing .vue templates under src/. This is similar to the merged formatting contribution in #9145. You do not need to design a Vue component, change business logic or modify APIs. Check ongoing work and discuss a genuine ambiguity with maintainers; no advance permission or assignment is required.

Step-by-step implementation

  1. Create a branch based on the latest main and confirm a clean working tree.

  2. Verify the effective Nextcloud preset options for both rules. Remove only their 'off' entries from eslint.config.mjs and leave their preset severity unchanged.

  3. Preview layout-only fixes without changing files:

    npx eslint 'src/**/*.vue' --fix-dry-run --fix-type layout \
      --format json > /tmp/eslint-vue-preview.json
    
  4. Record the current warning/error count and files affected. If the preview is limited to attribute line breaks and formatting, apply:

    npx eslint 'src/**/*.vue' --fix --fix-type layout
    
  5. Review git diff -- src/ eslint.config.mjs. Confirm changes only split/join attribute lines or adjust harmless layout. Verify every attribute name and value, Vue directive, binding expression, aria-* value, slot, event, selector and visible text is unchanged. Revert unrelated fixes produced by other already-enabled rules.

  6. Keep rule-specific commits separately reviewable with valid DCO sign-off. If a fix for one rule overlaps the other, explain the overlap rather than manufacturing meaningless edits.

  7. Open one focused PR linking this issue. Report the changed-file count, before/after ESLint diagnostics and executed checks.

Verification

git diff --check
npm run lint
npm run ts:check
npm run build

Run npm test or the focused Vitest tests for any modified component whose rendering behavior needs verification. If a change unexpectedly affects rendered markup, include a sanitized screenshot or short video and request review before claiming success. A screenshot alone does not replace automated tests.

Done when

  • Both layout rules inherit the intended Nextcloud preset options and applicable violations are resolved.
  • Only attribute layout changes; props, slots, events, directives, CSS classes, accessible labels and user-visible text remain identical.
  • The PR includes a reviewed diff, current diagnostics, file count, appropriate passing checks and signed-off commits.
  • No generated code, translations, tests' assertions, new dependencies or unneeded suppressions are introduced.

Out of scope

Do not enable vue/attribute-hyphenation, event/slot casing rules, component-renaming rules, or introduce unrelated template refactors.

Additional context

Development workflow: https://docs.libresign.coop/developer_manual/development-workflow.html
Questions and community support: https://t.me/LibreSign

Dominant language
PHP
Stars
844
Forks
176
Avg merge
14h 3m
Merged PRs (30d)
344

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from LibreSign/libresign

All issues in LibreSign/libresign

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.