Skip to content

Framework

framework

Framework detection — which ecosystem a project belongs to.

The audit registry is indexed by (category, framework). A project is audited against the rules of its detected (or explicitly requested) framework. svelte inherits node (a Svelte project runs the node rules plus the svelte-specific ones).

Dependency-free: stdlib + a tiny TOML/JSON read. Imported by base and auditor without creating cycles.

Framework

Bases: StrEnum

Ecosystem a project is written in.

node is the JS/TS base layer (ESLint, tsc, vitest, package.json …). svelte and react are UI-framework specializations that inherit the node layer and add their own rules (see :func:resolve_frameworks). Adding a new UI framework (vue, solid …) is one enum member + one resolve_frameworks branch + a rules/<fw>/ package — no refactor.

Source code in packages/axm-audit/src/axm_audit/core/framework.py
Python
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class Framework(StrEnum):
    """Ecosystem a project is written in.

    ``node`` is the JS/TS base layer (ESLint, tsc, vitest, package.json …).
    ``svelte`` and ``react`` are UI-framework specializations that *inherit*
    the node layer and add their own rules (see :func:`resolve_frameworks`).
    Adding a new UI framework (vue, solid …) is one enum member + one
    ``resolve_frameworks`` branch + a ``rules/<fw>/`` package — no refactor.
    """

    PYTHON = "python"
    NODE = "node"
    SVELTE = "svelte"
    REACT = "react"

detect_framework(project_path)

Detect the framework of project_path from its manifest markers.

Detection order (conservative — defaults to Python):

  1. package.json + Svelte marker → :attr:Framework.SVELTE
  2. package.json + React marker → :attr:Framework.REACT
  3. package.json alone → :attr:Framework.NODE
  4. otherwise (pyproject.toml or nothing) → :attr:Framework.PYTHON

Svelte wins over React when both are present (a SvelteKit app may pull a react-named transitive tool); per-package detection in a monorepo happens downstream.

Parameters:

Name Type Description Default
project_path Path

Project (or package) root directory.

 required

Returns:

Type Description
Framework

The detected :class:Framework.
Source code in packages/axm-audit/src/axm_audit/core/framework.py
Python
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
def detect_framework(project_path: Path) -> Framework:
    """Detect the framework of *project_path* from its manifest markers.

    Detection order (conservative — defaults to Python):

    1. ``package.json`` + Svelte marker → :attr:`Framework.SVELTE`
    2. ``package.json`` + React marker → :attr:`Framework.REACT`
    3. ``package.json`` alone → :attr:`Framework.NODE`
    4. otherwise (``pyproject.toml`` or nothing) → :attr:`Framework.PYTHON`

    Svelte wins over React when both are present (a SvelteKit app may pull a
    react-named transitive tool); per-package detection in a monorepo happens
    downstream.

    Args:
        project_path: Project (or package) root directory.

    Returns:
        The detected :class:`Framework`.
    """
    if not (project_path / "package.json").is_file():
        return Framework.PYTHON
    # A package.json is present → this is a node project. An unparsable manifest
    # still resolves to node (never python); we just can't read its UI marker.
    data = _read_package_json(project_path) or {}
    if _has_svelte_marker(project_path, data):
        return Framework.SVELTE
    if _has_react_marker(data):
        return Framework.REACT
    return Framework.NODE

resolve_frameworks(framework)

Expand a framework to the chain of rule-sets it should run.

A UI framework (svelte, react) runs the shared node rules first, then its own delta. node and python run only their own.

Parameters:

Name Type Description Default
framework Framework

The leaf framework to resolve.

 required

Returns:

Type Description
tuple[Framework, ...]

Tuple of frameworks whose rules apply, base first.
Source code in packages/axm-audit/src/axm_audit/core/framework.py
Python
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
def resolve_frameworks(framework: Framework) -> tuple[Framework, ...]:
    """Expand a framework to the chain of rule-sets it should run.

    A UI framework (``svelte``, ``react``) runs the shared ``node`` rules
    first, then its own delta. ``node`` and ``python`` run only their own.

    Args:
        framework: The leaf framework to resolve.

    Returns:
        Tuple of frameworks whose rules apply, base first.
    """
    if framework in _NODE_UI_FRAMEWORKS:
        return (Framework.NODE, framework)
    return (framework,)