nodejs / nodejs/orchestrion-js

Potential JavaScript API

Open
#8 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
24
Forks
11
PR merge metrics
No merged PRs in 30d

Description

From looking at the Rust API it would be something like this?

interface InstrumentationConfig {
  // Some instrumentation config
}

function create(...configs: InstrumentationConfig[]): InstrumentationMatcher;

interface InstrumentationMatcher {
  // If this returns undefined, we know there's no transforming required for this specific file
  getTransformer(moduleName: string, moduleVersion: string, file_path: string): Transformer | undefined;
}

interface Transformer {
  transform(source: string): string;
  transformWithSourcemap(source: string, sourcemap: string): [string, string];
}

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 by reviewing the Rust API referenced in the issue and the repository's existing JavaScript entry points. Determine whether this proposed TypeScript surface matches the project's intended configuration, matching, transformation, and sourcemap behavior; the work is done when the API design is agreed and its implementation and validation scope are defined.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
api
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.