Enforce MOD3/MOD4: `using`, never `import`

Aperta
  • Qualcosa non va?
#831 2 commenti 0 reazioni 1 assegnatario Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@ocots ci sta già lavorando.

Dal 30/7/2026.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

Context

ct-conventions mandates, in MOD3 (no import) and MOD4 (qualified external imports):

Everything is qualified — with using, never import. Bring modules into scope, not their symbols (using Pkg: Pkg, using Pkg: Sub); call Module.symbol everywhere and extend methods qualified (Base.show(...)).

Two distinct violations to fix here:

  1. import anywhere — replace with using.
  2. The dotted submodule form using Pkg.Sub — it silently pulls Sub's exported names into scope too (unlike using Pkg: Sub), which MOD4 explicitly forbids.

Translation table (from MOD3):

Instead of Write
import Pkg using Pkg: Pkg
import Pkg.Sub using Pkg: Sub
import Pkg.Sub: Sub using Pkg: Sub
import Pkg: sym1, sym2 using Pkg: sym1, sym2
using Pkg.Sub (forbidden) using Pkg: Sub

Scope — doc, code, and tests

  • Code — src/, ext/, and any # Example docstring blocks.
  • Docs — docs/src/*.md (@example/@setup blocks) and any other .md showing Julia code (README, BREAKING.md/CHANGELOG.md migration snippets).
  • Tests — everything under test/, plus a regression-guard test (see below) so this can't silently regress again.

⚠️ Exception: a migration doc that quotes a past API verbatim in a "Before" snippet should be left as-is — that's a historical fact, not a style violation. Only fix "After"/current-usage examples.

Finding offending lines

# `import` statements, anywhere in Julia code or Markdown docs
rg --fixed-strings 'import ' -g '*.jl' -g '*.md' .

# forbidden dotted `using Pkg.Sub` form
rg -n 'using [A-Za-z][A-Za-z0-9]*\.[A-Za-z]' -g '*.jl' -g '*.md' .

Current count in this repo (rough — includes some CHANGELOG/BREAKING prose mentions that don't need changing; review each hit):

  • import: ~87
  • dotted using Pkg.Sub: ~3

Regression guard

CTLie already completed this migration (control-toolbox/CTLie.jl#24) and added a meta-test that scans every tracked .jl/.md file for both patterns:

test/suite/meta/test_no_import.jl

It's self-contained and auto-discovered by the standard CTBase.run_tests runner (suite/*/test_* glob) — copy/adapt it directly, and extend the DOTTED_USING_EXEMPT list for any files here with legitimate historical "Before" snippets.

Note on sibling submodule imports

If this repo has a submodule manifest structure (src/<Name>/<Name>.jl), relative sibling imports like using ..Lower or using ..Core: AbstractTag are fine as-is and not part of this rule. Only the absolute dotted form (using Pkg.Sub, with a real package name, not ..) is forbidden.

🤖 Filed with Claude Code

Lingua principale
Julia
Stelle
135
Fork
11
Merge medio
7h 51m
PR unite (30g)
22

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di control-toolbox/OptimalControl.jl

Tutte le issue di control-toolbox/OptimalControl.jl

Issue simili

Altre issue su Julia

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.