Adding Imports in Code Snippets

[veillette]

Hello! I'm new to this community and appreciate all your efforts in developing this technology (and community). The documentation at https://scenerystack.org/ is quite useful to get started. I have some feedback regarding the documentation: some examples include code snippets and lack import statements, which would be very helpful for a newbie (and not so new).

While working on adding localization to my simulation using the guide at https://scenerystack.org/learn/translation-and-localization/, I had difficulty (as did my IDE) determining where to import components like LocalizedString or getFluentModule. ALthough, I managed to track it down, it is not clear a priori, which modules contain these elements. Including an import statement in the examples could save users considerable time.

[veillette]

This was my sentiment a few minutes ago, but then I found out that one can also import this directly from scenerystack.

@samreid said:'''Yes, it seems very important to put the imports. Great idea. But I'm kind of confused because I saw that import { LocalizedString } from "scenerystack/chipper"; works and is probably correct for this case, but somehow import { LocalizedString } from "scenerystack"; also kind of works. It works at runtime, but I get this error:

error while loading peak detector worklet, peak detector probably won't work, error: AbortError: Unable to load a worklet's module.'''

In fact, one does not need to go in 'axon' , 'dot', etc,... This works fine.

import {
  Vector2,
  NumberProperty,
  BooleanProperty,
  EnumerationProperty,
  TimeSpeed,
  RangeWithValue,
  EnumerationValue,
  Enumeration,
  Property,
  ObservableArray,
  createObservableArray} from "scenerystack";

So I think my initial observation/suggestion is not relevant.

[veillette]

I'll note that not all modules are exported.

for instance, (this is not an exhaustive list),

ScreenView and ScreenViewOptions from "scenerystack/sim"
Sim and onReadyToLaunch from "scenerystack/sim"

[jonathanolson]

That is true, apologies! Importing anything under "scenerystack/sim" will cause non-simulations to fail out, so it is unfortunately unsuitable for inclusion in the "scenerystack" import.

Perhaps that makes including imports in examples potentially helpful? (Or perhaps a "show imports" button on every code example?)