temporalio / temporalio/sdk-typescript

[Feature Request] eslint plugin

Open
#472 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
917
Forks
224
Avg merge
3d 16h
Merged PRs (30d)
43

Description

Mainly for catching some determinism things at compile time in workflow code, but perhaps there are other things we can do as well.

Shawn Wang 2 hours ago
we will probably make an eslint rule eventually but ultimately we are limited by what we can do with static analysis - cant query a module to see if it uses one of the banned Node globals. better to throw a helpful error.

src/workflows/.eslintrc.json

{
    "plugins": [
        "@temporalio",   // @temporalio/eslint-plugin
    ],
    "extends": [
        "plugin:@temporalio/recommended"
    ],
}

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with src/workflows/.eslintrc.json and review the proposed @temporalio plugin and recommended configuration. Clarify which determinism checks are in scope and how static analysis should handle banned Node globals. Done means the plugin’s scope and rules are defined and the workflow configuration can use the recommended preset.

Written by the indexing model from the issue text.

Assessment

Tech stack
eslint, typescript
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.