OpenFn / OpenFn/kit

Warn user of unexported identifiers available in globals that are used in job code

Open
#945 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

DevX enhancement
Dominant language
TypeScript
Stars
21
Forks
23
Avg merge
1d 22h
Merged PRs (30d)
17

Description

Description

User might forget to export existing functions from the globals file.
eg.

const USER_DEFAULT = 'something'

And then go ahead to use this value in job code like below.

fn(state=> {
  state.user = state.response.user || USER_DEFAULT;
  return state;
})

This code will error since USER_DEFAULT was never exported.
With the info we have during compile-time. we can notify users whenever they make these mistakes.

Contributor guide

No contributing guide indexed for this repository

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

No file, test, or entry point is named. Start by locating the compile-time handling of globals and job code, then determine how references to unexported global identifiers are represented. Done means users are notified when job code uses a global that exists but was not exported.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.