microsoft / microsoft/pxt

Local extension testing / documentation

Open
#9,271 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
2.3k
Forks
641
Avg merge
12h 4m
Merged PRs (30d)
57

Description

This is a bug, or at least a lack of clarity, in the documentation.

Describe the bug
In step 5 of the custom extension documentation
pxt/docs/extensions/getting-started/vscode.md it says:

  • Add an entry under dependencies that points to your extension folder:
{
    "name": "banana test",
    "dependencies": {
        ...
        "banana": "file:../pxt-banana"
    },
    ...
}

But it’s not clear how to make the relative file:../pxt-banana local file reference work.

Expected behaviour
Explain the directory structure, where pxt serve should have been run from and how this relates to the directory where pxt-banana is being developed.

or if this isn’t based on directories explain how to set up the development environment to make this work.

Environment:

  • OS: MacOS
  • Browser: safari
  • Tools: node, pxt, vscode

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

Open docs/extensions/getting-started/vscode.md and inspect step 5, especially the file:../pxt-banana dependency example. Reproduce the local extension setup with pxt serve and verify how the project directories relate to the pxt-banana development folder. Done means the documentation clearly explains the directory structure, command location, and local reference setup.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, typescript, vscode
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
56/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.