playcanvas / playcanvas/editor

REST API support for auto-parsing scripts

Open
#34 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

area: rest api area: scripts enhancement
Dominant language
TypeScript
Stars
1.3k
Forks
215
Avg merge
1d 29m
Merged PRs (30d)
30

Description

Feature request:

It would be nice if REST api would be able to parse script after getting it from outside.

Why it would be useful:
It's quite common that if you are programming locally and sending your code ('Webpacked' mostly),
the next thing you will have to do is hit the 'parse'-button. Why not do it automatically? As a parameter

form.append("file", JSON.stringify(settings), {
     filename: filePath,
     contentType: "application/json"
     parseScript: true // like this
 });

or an another request with callback?

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 locating the REST API endpoint that accepts external scripts and the existing parse action in the editor. Compare the proposed parseScript parameter with the alternative callback request, then define the request behavior and verify that uploaded scripts are parsed without a manual parse action.

Written by the indexing model from the issue text.

Assessment

Tech stack
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.