Skip to content

Latest commit

 

History

History
179 lines (124 loc) · 22.5 KB

plugin-scorecard.md

File metadata and controls

179 lines (124 loc) · 22.5 KB

Plugin Scorecard for RSS Dashboard

https://community.obsidian.md/plugins/rss-dashboard

This document tracks compliance status against the Obsidian Community Plugin audit scorecard.

Current Public Snapshot

Checked August 10, 2026. The public listing reports RSS Dashboard version 2.5.0 with Health: Excellent and Review: Caution. The unauthenticated public view does not identify a specific current finding behind the caution rating, so this document does not infer one. Recheck the listing during release, compliance, security, platform, storage, and audit-remediation work.

Current CSS policy requires zero !important declarations in src/styles/. npm run check:important enforces this without comment-based exceptions.

Post-2.6.0 remediation status

Remediation is in progress following the post-2.6.0 community plugin scorecard review (44 findings total from automated scans):

  1. document.createElement -> Obsidian createEl helpers (34 findings): Staged across test and UI files.
  2. mjx-container unknown type selector (6 findings): Resolved by replacing raw mjx-container type selectors in src/styles/articles.css and src/styles/reader.css with attribute and class selectors ([class*="mjx-container"], .MathJax).
  3. Unnecessary assertion in src/utils/settings-loader.ts:367 (1 finding): Resolved by typing migrateDefaultFilterToDashboardMultiFilters parameters to accept DisplaySettings directly and removing the double cast.
  4. Declarative settings API getSettingDefinitions() suggestion (1 finding): Evaluated for PluginSettingTab in src/settings/settings-tab.ts. Obsidian 1.13.0 declarative settings search suggestion; standard imperative display() tab implementation remains compliant with obsidian.d.ts baseline (1.8.7).
  5. Build verification (1 finding): Local npm run build completes cleanly (CSS scoping, platform compatibility, zero-!important, commit message linting, ESLint with zero warnings, TypeScript compilation, and esbuild production bundling).

Assessment and disposition table

Priority Captured finding Current disposition Follow-up scope and validation
Done locally; awaiting release/rescan 34 document.createElement occurrences Remediated: migrated across test fixtures and UI stubs to Obsidian's standard DOM helpers (createEl, createDiv, createSpan). Staged for next release. Unit tests (192 files, 1734 tests) and ESLint pass cleanly. Verify in next release build.
Done locally; awaiting release/rescan 6 mjx-container unknown type selector warnings Remediated in src/styles/articles.css and src/styles/reader.css: replaced raw custom-element type selector mjx-container with attribute/class selectors [class*="mjx-container"] and .MathJax. Preserves normal line-height rules for MathJax formulas while eliminating unknown type selector warnings. npm run check:css-scope, npm run check:important, and full build pass cleanly.
Done locally; awaiting release/rescan Unnecessary assertion in src/utils/settings-loader.ts:367 Remediated in src/utils/settings-loader.ts and src/utils/settings-migration.ts: updated parameter type of migrateDefaultFilterToDashboardMultiFilters to accept `DisplaySettings Record<string, unknown>and{ statusFilters?: unknown[]; tagFilters?: unknown[]; logic?: string }
Documented / Informational PluginSettingTab does not implement getSettingDefinitions() Architectural note: RSS Dashboard settings use a multi-tab tabbed orchestrator architecture (RssDashboardSettingTab) across 11 distinct tabs. The Obsidian 1.13.0+ getSettingDefinitions() is an optional declarative search index enhancement. Retained existing standard PluginSettingTab implementation compatible with minimum Obsidian target 1.8.7. Retain current settings tab structure. Consider declarative search definitions in a future milestone targeting Obsidian >= 1.13.0.
Done locally; awaiting release/rescan Build verification failed during clean environment run Verified: all pipeline gates (check:compliance, check:css-scope, check:platform, check:important, check:commit-message, lint, tsc, and esbuild) pass with exit code 0. Production bundle verified locally via npm run build.
Done locally; awaiting release/rescan Missing contributing guide Remediated in current source: the root guide is tracked as CONTRIBUTING.md. Documentation/repository-metadata remediation complete locally.
Deferred. See link in comments. Clipboard access disclosure Genuine, intentional runtime capability. Current code has no programmatic clipboard read; native paste remains user-mediated. Writes support settings-export copy buttons, article/feed URL context-menu actions, copying a local-storage address, Reader copy with LaTeX source preservation, and a YouTube embed clipboard-write permission. The clipboard removal assessment itemizes each path and its removal impact. Retain capability and maintain disclosure.

Clipboard decision: retain all identified clipboard behavior unchanged. The remaining work is transparent disclosure and confirmation in the next community rescan.

Historical Compliance Score

Earlier public scorecard snapshots are archived: post-2.5.0.

Version Score Date Status
2.2.0 46% May 15, 2026 ✅ Remediated — 100% target verified
2.3.0 72% May 26, 2026 ✅ Remediated — seeaudit-remediation-2.3.0.md
2.4.0 Risks Jul 2, 2026 🔄 Remediated in 2.4.1 — pending community rescan
2.4.1 TBD Jul 2, 2026 ✅ Local compliance gates pass — see2.4.0 audit remediation plan

v2.4.1 Remediation Summary (Completed July 2026)

Addressed the 2.4.0 community audit (455 findings) on branch release/2.4.1:

  • CI guardrails: Added check:platform, check:important, and extended check:commit-message (full-repo scan, block directives, production disable ban). Wired into check:compliance, pre-commit, commit-msg, and GitHub Actions.
  • Risks: Removed all production eslint-disable suppressions for banned rules; fixed test stub descriptions.
  • Platform API: Migrated ~109 timer call sites to window.*, replaced document with activeDocument in production UI paths, eliminated globalThis usage.
  • CSS: Resolved duplicate viewport properties via @supports, added missing audit-ok comments on remaining !important declarations (~69 total in src/styles/).
  • Strict ESLint: Promoted obsidianmd/ui/sentence-case and @typescript-eslint/no-unnecessary-type-assertion to error; @typescript-eslint/no-explicit-any error in production.

Verification: npm run check:compliance, npm run lint, and npm run test:unit (1530 tests) all pass locally.


v2.2.0 Remediation Summary (Completed May 2026)

All audit findings from the 46% audit were addressed through seven systematic compliance passes:

  • Clipboard & Deprecated APIs: Migrated to modern Clipboard API
  • Unsafe HTML Rendering: Replaced all innerHTML assignments with sanitizeAndAppendHtml(...)
  • Type Safety & ESLint: Resolved 3239+ errors across 130 test files via boundary casting and strict interfaces
  • Popout Window Compatibility: Migrated 100+ DOM API calls to activeWindow/activeDocument contexts
  • DOM Helpers: Replaced raw document.createElement calls with Obsidian framework helpers
  • Lint Disable Descriptions: Added explicit audit guardrails with inline justifications to all 37 eslint-disable comments
  • Parameter Hygiene: Removed 10+ unused parameters across core services

Detailed remediation history: See test-lint backlog tracker (Passes 1–7)


v2.3.0 Audit Findings

Risks — 1 Risk (Must Fix)

  1. Dynamic <script> element creation — Dynamically injecting script elements can load and execute arbitrary external code. CI/CD rule added to block future regressions.
  2. Direct Filesystem Access — Uses the Node.js fs module to access the filesystem outside of the Obsidian vault API. Can read and write any file on the system. Must migrate to Obsidian vault API.

Warnings — 950 Warnings

Per project policy (see CONTRIBUTING.md), warnings that cannot be eliminated are documented with inline /* audit-ok: ... */ comments and approved in CONTRIBUTING.md.

Category Count Files
!important declarations 900 styles.css, modals.css, sidebar.css
css-scrollbar partial support 14 styles.css, modals.css, sidebar.css
multicolumn partial support 8 styles.css, card-view.css, modals.css, settings.css
Duplicatemax-height 8 styles.css, modals.css, reader.css, sidebar.css
Duplicateheight 4 styles.css, modals.css
Duplicatemin-height 4 styles.css, modals.css
css-display-contents partial support 2 styles.css, controls.css
Duplicatepadding 2 styles.css, articles.css
Duplicateposition 2 styles.css, controls.css
Duplicatebottom 2 styles.css, dropdown-portal.css
Duplicatecolor 1 articles.css
Duplicateborder 1 articles.css
Duplicateline-height 1 modals.css

Other

  • Release contains extra artifact: obsidian-rss-dashboard.zip — only main.js, manifest.json, and styles.css are supported by the plugin registry.
  • Clipboard access disclosure — verified current.

Historical v2.3.0 Re-Audit Checklist

Remediation was tracked in audit-remediation-2.3.0.md.

The community audit should re-scan to verify:

  1. Dynamic <script> injection removed and CI/CD rule enforced
  2. Node.js fs usage removed or migrated to Obsidian vault API
  3. CSS warnings either eliminated or documented under the policy in effect for that audit
  4. Extra .zip release artifact removed from registry entry
  5. Test suite remains fully compliant (130+ files, 1180+ tests, 0 lint errors)

Health

  • Status: Excellent
  • Details: Actively maintained, highest commit velocity to date (486 commits / year). Remediation pipeline well-established.

Hygiene

Has readme, license, description. ✅ Contributing guide exists (CONTRIBUTING.md in root).

Maintenance

Last commit 4 days ago. 486 commits in the past year. Last release 4 days ago.

Responsiveness

Closed 87% of 77 issues. 3 contributors active in the past year.

Adoption

6.7k installations, 528 stars.


Disclosures

  • External Domains: Plugin may make requests to external domains for feed content. See docs/SECURITY.md.
  • Clipboard Access: Reads or writes the system clipboard for export features. Uses modern Clipboard API.
  • Vault Read: vault.read, vault.cachedRead. Core features: save article, shard storage model. See docs/SECURITY.md.
  • Vault Write: vault.modify, vault.create. Core features: save article, shard storage model. See docs/SECURITY.md.
  • Malware scan not available.
  • Vulnerable dependencies scan not available.
  • Obfuscation scan not available.
  • Network requests scan not available.
  • Build verification not available.

Documentation & Governance