refactor: isolate UI helpers with cascading linting configs - #1819
Merged
fderuiter merged 1 commit intoAug 6, 2026
Merged
Conversation
… ruff configuration and update docstring checks
Contributor
Author
|
[CI/CD Fix Attempt 1] Root Cause of the FailureThe test suite fails during the collection phase of pytest because Proposed SolutionWe configure pytest to automatically add the root directory ( pythonpath = ["."]This successfully allows |
fderuiter
deleted the
jules/nested-helpers-config-js0-c33004c7-25ee-484e-82e7-96966868f721
branch
August 6, 2026 15:49
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context & Rationale
Currently, shared UI helpers reside in the same flat directory as fast-evolving page editors. This setup forces stable utility helpers and experimental pages to share the same relaxed code-quality rules. As a result, critical utility code can degrade over time due to missing validation, while enforcing strict rules globally would slow down rapid page prototyping.
This Pull Request resolves this friction by isolating shared UI helpers into a dedicated subpackage (
studio/studio/helpers/) with its own cascading linting configuration. This secures high standards and documentation requirements for shared utilities without impeding fast iterations on experimental page layouts.Key Decisions & Implementation Details
1. Isolation of Shared UI Helpers
helpers.pylayout into a dedicated Python subpackage:studio/studio/helpers/__init__.py.2. Local Cascading Configurations (
ruff.toml)ruff.tomlunderstudio/studio/helpers/enforcing strict linting rules (E,F,W, and docstringDrules).3. Docstring Validation Integration
tools/tools/scripts/check_docstrings.py) to actively scan the nestedstudio/studio/helpersdirectory and added missing docstrings to the helpers.4. Import Path Resolution
from studio.helpers import ...).Verification & Testing
ruffcorrectly reports docstring violations instudio/studio/helpers/but ignores them in other non-strict directories.tools/tools/scripts/check_docstrings.pysucceeds.