Enable Vue attribute formatting rules without changing rendered behavior

未关闭
#9,499 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
半天
新手友好度
70/100
Issue 类型
重构
描述清晰度
基本清楚
活跃度
活跃
技术栈
javascript

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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

主要语言
PHP
星标
844
派生
176
平均合并
14 小时 3 分钟
30 天内合并 PR
344

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

LibreSign/libresign 的其他 Issue

查看 LibreSign/libresign 的全部 Issue

相似的 Issue

更多 PHP Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。