[Feature]: Linter

[yaythomas]

What would you like?

The AWS Durable Execution TypeScript SDK has a client-side linter to parse for best practices and avoid common issues:

https://github.com/aws/aws-durable-execution-sdk-js/tree/main/packages/aws-durable-execution-sdk-js-eslint-plugin

Investigate how or if this can integrate with a modern Python IDE experience. Pylint does support custom plugins, but the newer/faster linter environment Ruff does not (astral-sh/ruff#283)

Possible Implementation

No response

Is this a breaking change?

No

Does this require an RFC?

No

Additional Context

No response

[leandrodamascena]

This is a really nice idea @yaythomas and I really like the lint project in Durable SDK TS.

I think Flake8 could work well here. It has good adoption (1M+ downloads/day), a mature plugin API, and fits nicely into CI/pre-commit workflows. Users who prefer Ruff for general linting can still run Flake8 just for the SDK-specific rules.

As you said, Ruff doesn't support custom plugins yet and that issue doesn't seem to be going anywhere soon. I think we can do the same with flake8.

Maybe we should think about both Flake8 and Pyright to cover different scenarios:

• Flake8 for CI, pre-commit hooks - catches non-determinism issues, best practices
• Pyright/Pylance for real-time IDE feedback - catches type errors, improper API usage
• Both should have the same types of checks, but working in different space in the development lifecycle journey

I think we can start with a basic Flake8 plugin - just AST visitors that flag violations like random.random() or datetime.now() inside durable functions. We can see if this works and then think about all the rules we want to cover.

We could also update our docs and maybe write a blog post explaining how to set up the plugins and why they matter for Durable execution.

I'd like to hear your opinion here. I can create a small PoC with this.