Programmatic API

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

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
javascript, python
Domain
api, compilers

Research direction

No files or tests are named. Start by checking whether the proposed compilationApi.compile entry point exists and tracing how Transcrypt currently compiles a module; define the public API and its handling of imported modules for the live-reload use case, then document and test the supported behavior.

Written by the indexing model from the issue text.

Description

Does transcrypt have a programmatic API?

I'd like to do something like this for a live-reload server:

from transcrypt import compilationApi
def requestHandler(req):
    # Suppose browser has made request to download localhost:3000/code/myproject.module.js
    moduleName = req.path.replace("/code/", "").replace(".js", "") # I know this logic is wrong, just simple for example
    return Response.text(compilationApi.compile(moduleName)).contentType("application/javascript")

If the compiled .js for myproject.module contains any import statements, they'll trigger other HTTP requests from the browser which will trigger other calls to requestHandler to compile those modules.

Dominant language
Python
Stars
2.9k
Forks
218
PR merge metrics
No merged PRs in 30d

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.

More from TranscryptOrg/Transcrypt

All issues in TranscryptOrg/Transcrypt

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.