Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[Feature Request] Filename-based suppression per engine or file

Đang mở
#2,028 6 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
45/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
typescript, yaml
Lĩnh vực
cli, tooling

Hướng nghiên cứu

Điểm bắt đầu là cấu hình CLI của code-analyzer; hãy bắt đầu bằng cách lần theo cách thiết lập YAML cấp cao nhất ignores.files được phân tích cú pháp và áp dụng. So sánh các dạng được yêu cầu ở cấp engine và theo từng rule, sau đó xác định phạm vi kiểm thử cho thấy việc loại trừ tên tệp có thể được giới hạn mà không ảnh hưởng đến các engine hoặc rule khác.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Product Area

The "code-analyzer" CLI

Your Need or Problem

I like the

ignores:
  files:
    - "**/utils.js"

feature.

Currently, it exists at the top level, meaning we can only exclude filenames for all engines. I would like to exclude at the engine or file level.

The background: Salesforce provides some stock/standard files (JavaScript, Visualforce, Aura, LWC) that have rule violations in them. Instead of having to fix them all when importing starter metadata, I want to exclude them... but I would like to do that from the config file.

IDEALLY, I could do a suppression PER RULE, but I fear that is too much to ask.

This is resulting in a LOT of false-positives and noise, and is stopping our pipeline every time we create a new kind of Experience Cloud site.

Your Desired Solution
engines:
  pmd:
    ignores:
      - "selfRegister.cmp"
      - "CommunityTemplate.page"

or

rules:
  pmd:
    "LoadCSSApexStylesheet":
      severity: 2
      ignores:
        - "CommunityTemplate.page"
      tags:
        - AppExchange
        - Security
        - Visualforce

My vision for using Code Analyzer is that I have a standard config file I use for all my projects as a starting point, and that one would include suppressing checks on those files. I could load that as a default in each of my repos/projects.

Alternatives Considered

PMD doesn't have a robust "ignore this rule for this filepath" from the ruleset feature, so I know I'm asking for a lot here.

I can exclude files in my custom ruleset, but that only applies to pmd rules.

I can override the specific rule and make a very long XPath exception property, which works, and might be good for some files, but isn't ideal.

Additional Context (Screenshots, Files, etc)

No response

Workaround

I have been able to suppress for most files (not JavaScript) by editing the file. But I don't want to have to edit each default file as Salesforce creates them.

Urgency

Moderate

Ngôn ngữ chính
TypeScript
Star
240
Fork
52
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của forcedotcom/code-analyzer

Tất cả issue của forcedotcom/code-analyzer

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.