pxt
pxt copied to clipboard
Category comments do not work when generating from simulator
Bug Template
Describe the bug
When using auto-generation from the simulator, the category comments for namespaces do not work, as they are simply ignored.
To Reproduce
-
Configure
corelib to use auto-generated blocks (createsims.d.tsfile, add it topxt.json). -
Create a simulator file that exposes some blocks in a category:
/** * Provides access to basic micro:bit functionality. */ //% color=#1E90FF weight=116 icon="\uf00a" namespace pxsim.basic { /** * Repeat the code forever in the background * @param body code to execute */ //% help=functions/forever weight=55 //% blockId=device_forever block="forever" afterOnStart=true export function forever (body: RefAction): void { thread.forever(body) } /** * Pause for the specified time in milliseconds * @param ms how long to pause for, eg. 100, 200, 500, 1000, 2000 */ //% help=functions/pause weight=54 //% blockId=device_pause block="pause (ms) %pause" export function pause (ms: number): void { if (isNaN(ms)) ms = 20 thread.pause(ms) } } -
See that
sims.d.tsdoes not contain the category comment:// Auto-generated from simulator. Do not edit. declare namespace basic { /** * Repeat the code forever in the background * @param body code to execute */ //% help=functions/forever weight=55 //% blockId=device_forever block="forever" afterOnStart=true //% shim=basic::forever function forever(body: () => void): void; /** * Pause for the specified time in milliseconds * @param ms how long to pause for, eg. 100, 200, 500, 1000, 2000 */ //% help=functions/pause weight=54 //% blockId=device_pause block="pause (ms) %pause" //% shim=basic::pause function pause(ms: number): void; } // Auto-generated. Do not edit. Really.
Expected behavior
The category comment should be present and applied correctly in the editor.