[Connector-linter]: add core linter engine and project scaffold [1/4] by jabesq · Pull Request #6293 · OpenCTI-Platform/connectors

jabesq · 2026-04-23T10:04:28Z

Proposed changes

Add connector_linter project scaffolding (pyproject.toml, uv.lock, .python-version)
Implement core linter engine: models, runner, registry, formatters, noqa support, CLI entrypoint
Add README with usage documentation and check reference

Part 1 of 4 — This PR introduces the linter framework. Check rules are added in follow-up PRs (stacked on this branch).

Related issues

Closes [all] Create a verification script #5989 (partially — foundation only)

Checklist

I consider the submitted work as finished
I have signed my commits using GPG key.
I tested the code for its functionality using different use cases
I added/update the relevant documentation (either on github or on notion)
Where necessary I refactored code to improve the overall quality

Further comments

This is the first PR in a 4-part stacked PR series for the connector linter:

[Connector-linter]: add core linter engine and project scaffold [1/4] #6293 (this): Foundation — scaffold + core engine + README
[Connector-linter]: add VC1xx config and VC2xx metadata checks [2/4] #6292: VC1xx config + VC2xx metadata checks
[Connector-linter]: add VC3xx code checks [3/4] #6291: VC3xx code checks
[Connector-linter]: add VC4xx docker and VC5xx deprecation checks [4/4] #6294: VC4xx docker + VC5xx deprecation checks

Copilot

Pull request overview

Introduces a new shared/connector_linter Python project providing the foundational framework for a “Verified criteria” connector linter (CLI, registry, runner, result models, formatting, and # noqa support), to be extended with actual rule packs in follow-up stacked PRs.

Changes:

Added connector_linter project scaffolding (pyproject, lockfile, Python version pin).
Implemented core engine components: context/models, check registry, discovery/runner, # noqa filtering, and output formatters.
Added CLI entrypoints (check, list) and a comprehensive README describing usage and planned rule codes.

Reviewed changes

Copilot reviewed 11 out of 12 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
shared/connector_linter/uv.lock	Adds locked dependencies for the new linter project.
shared/connector_linter/pyproject.toml	Defines the new package, dependencies, and CLI script entrypoint.
shared/connector_linter/.python-version	Pins the local Python version for the linter project.
shared/connector_linter/connector_linter/init.py	Package metadata and version export.
shared/connector_linter/connector_linter/main.py	Click-based CLI (`check`, `list`) and exit-code handling.
shared/connector_linter/connector_linter/models.py	Core dataclasses and connector context loader.
shared/connector_linter/connector_linter/registry.py	Decorator-based global check registry.
shared/connector_linter/connector_linter/runner.py	Check auto-discovery, select/ignore filtering, execution, and result collection.
shared/connector_linter/connector_linter/formatters.py	Text/JSON/GitHub Actions output formatting and scoring summary.
shared/connector_linter/connector_linter/noqa.py	Inline suppression parsing and filtering logic.
shared/connector_linter/connector_linter/checks/init.py	Initializes the checks package for auto-discovery.
shared/connector_linter/README.md	Usage docs, architecture overview, and planned check reference.

codecov · 2026-04-23T10:17:44Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 41.27%. Comparing base (5623a9a) to head (0220586).
⚠️ Report is 6 commits behind head on master.
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #6293      +/-   ##
==========================================
+ Coverage   41.02%   41.27%   +0.25%     
==========================================
  Files        2150     2158       +8     
  Lines      129036   129540     +504     
==========================================
+ Hits        52939    53472     +533     
+ Misses      76097    76068      -29

Flag	Coverage Δ
baseline	`0.00% <ø> (ø)`
connectors	`74.56% <100.00%> (+0.22%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Powlinett

Great tool!! Can't wait to use it IRL 🔥

May I suggest to move it into /shared/tools alongside the scripts to generate the files required for the XTM Composer ?

Thank you @jabesq 🤘

…ors/warnings to JSON summary

…, and exception severity escalation

…display

…iour

Drop the redundant `passed: bool` field from CheckFinding and CheckResult. Severity (INFO / WARNING / ERROR) now fully encodes check outcome. All consumers (formatters, runner, __main__, tests) updated to branch on r.severity instead of r.passed. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…ntext, severity helpers

jabesq requested a review from Copilot April 23, 2026 10:04

github-actions Bot assigned jabesq Apr 23, 2026

github-actions Bot added the filigran team use to identify PR from the Filigran team label Apr 23, 2026

Copilot started reviewing on behalf of jabesq April 23, 2026 10:04 View session

jabesq changed the title ~~feat(connector-linter): add core linter engine and project scaffold [1/4]~~ feat(linter): add core linter engine and project scaffold [1/4] Apr 23, 2026

jabesq changed the title ~~feat(linter): add core linter engine and project scaffold [1/4]~~ [Connector-linter]: add core linter engine and project scaffold [1/4] Apr 23, 2026

jabesq force-pushed the feat/connector-linter-1-foundation branch from 3fe3c27 to 1d56c72 Compare April 23, 2026 10:09

Copilot AI reviewed Apr 23, 2026

View reviewed changes

This was referenced Apr 23, 2026

[Connector-linter]: add VC4xx docker and VC5xx deprecation checks [4/4] #6294

Open

[Connector-linter]: add VC1xx config and VC2xx metadata checks [2/4] #6292

Open

[Connector-linter]: add VC3xx code checks [3/4] #6291

Open

jabesq force-pushed the feat/connector-linter-1-foundation branch 6 times, most recently from dcf0b1b to 1180a4d Compare April 24, 2026 08:19

Powlinett previously approved these changes Apr 24, 2026

View reviewed changes

Comment thread shared/connector_linter/connector_linter/models.py Outdated

Comment thread shared/connector_linter/connector_linter/models.py

Comment thread shared/connector_linter/connector_linter/runner.py Outdated

jabesq dismissed Powlinett’s stale review via c611d6e April 27, 2026 13:25

jabesq force-pushed the feat/connector-linter-1-foundation branch from c611d6e to 4b22528 Compare April 30, 2026 14:25

jabesq added 9 commits May 5, 2026 17:44

chore(connector-linter): scaffold project with pyproject.toml and uv

b166ee1

feat(connector-linter): add core linter engine

a5acf99

docs(connector-linter): add README with usage and check reference

e00878c

test: Add UT

e37aeaa

fix(noqa): resolve relative paths against connector root

03526a2

fix(formatters): correct PASS/WARN/FAIL status derivation and add err…

e18ac07

…ors/warnings to JSON summary

test(linter): update tests for noqa path resolution, formatter status…

9856b75

…, and exception severity escalation

fix(linter): replace --quiet with --verbose flag and fix WARN status …

b27e29a

…display

test(formatters): update tests for verbose flag and WARN status behav…

e809531

…iour

jabesq and others added 8 commits May 5, 2026 17:44

docs(readme): update CLI example from --quiet to --verbose

0f2bb86

refactor(runner): rename _discover_checks to _import_checks_modules

80a9177

fix(models): tighten connector_type fallback and raise on unknown layout

1feef5c

test(models): add ConnectorContext type detection tests

bf3e408

feat(cli): support single-file path as check target

94e2b2e

feat(cli): add markdown output format and docs command

64616f8

refactor(context): add ConnectorType enum, python_sources/trees on co…

0220586

…ntext, severity helpers

jabesq force-pushed the feat/connector-linter-1-foundation branch from 4b22528 to 0220586 Compare May 5, 2026 15:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Connector-linter]: add core linter engine and project scaffold [1/4]#6293

[Connector-linter]: add core linter engine and project scaffold [1/4]#6293
jabesq wants to merge 17 commits intomasterfrom
feat/connector-linter-1-foundation

jabesq commented Apr 23, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov Bot commented Apr 23, 2026 •

edited

Loading

Uh oh!

Powlinett left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

jabesq commented Apr 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes

Related issues

Checklist

Further comments

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov Bot commented Apr 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Powlinett left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jabesq commented Apr 23, 2026 •

edited

Loading

codecov Bot commented Apr 23, 2026 •

edited

Loading