Skip to content

1362 create import linter skill #1364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nathanjmcdougall merged 2 commits into from
Mar 11, 2026
Merged

1362 create import linter skill #1364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0a0d04
Create an Import Linter skill
nathanjmcdougall Mar 11, 2026
76ef96c
Declare missing compatibility decs in the `usethis-qa-static-checks` …
nathanjmcdougall Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions .agents/skills/usethis-qa-import-linter/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
name: usethis-qa-import-linter
description: Use the Import Linter software on the usethis project
compatibility: usethis, Python, import-linter
license: MIT
metadata:
version: "1.0"
---

# Import Linter

## About

Import Linter is a static analysis tool to enforce a self-imposed architecture on imports. It allows you to define rules about how different parts of your codebase can import each other, helping to maintain a clean and organized code structure.

## Usage

```bash
uv run lint-imports
```

## Configuration File

This project uses the `.importlinter` INI file to configure Import Linter. You specify _contracts_ which need to be complied with between modules' imports. For the `usethis` project, we mainly use the `layers` contract: earlier listed "higher" layers are not allowed to import from any "lower" layers.

### Example Structure

Where `xyz` is the name of the root package (i.e. `usethis` for this project):

```ini
[importlinter]
root_packages =
xyz

[importlinter:contract:xyz]
name = xyz
type = layers
containers =
xyz
layers =
ui
backend
domain
exhaustive = true

[importlinter:contract:core_submodule]
name = xyz.core.submodule
type = layers
containers =
xyz.core.submodule
layers =
layer1
layer2
exhaustive = true
```

## Procedure

1. Ensure the module structure complies with the Import Linter configuration.
2. Explicitly add/rename new/modified modules to their parent-level contract (to adhere to the `exhaustive` setting).
3. For major refactorings, rationalize the module structure and update the Import Linter configuration accordingly.
4. Run Import Linter to verify that all contracts are satisfied.
4 changes: 2 additions & 2 deletions .agents/skills/usethis-qa-static-checks/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
name: usethis-qa-static-checks
description: Perform static code checks
compatibility: prek, basedpyright
compatibility: usethis, Python, prek, basedpyright
license: MIT
metadata:
version: "1.0"
version: "1.1"
---

# Static Checks
Expand Down