Cleanup

[lilleyse]

Here is a rough list of tasks for bringing this repo up to production. Feel free to edit or add new items to the list:

• We should have a common set of models that we use for testing new features, especially models that have created problems in the past. However I'm not sure if they should be hosted in this repo.
• Refactor gltf-pipeline as a series of stages with dependencies
  • Uniform function templates #99
  • Concept code for dependency management and custom pipelines #75
  • Use promises instead of callbacks
• General cleanup, api standardizing, file renaming, folder organization
  • Many functions expect an options object. Instead of sending in {} in a lot of places, just do it the Cesium way and create the options object if it's not defined with options = defaultValue(options, defaultValue.EMPTY_OBJECT);
• Use recommended libraries, Review npm dependencies #178
• Use JSDoc everywhere
• Progress events: Progress events #92
• Something like jQuery for glTF to eliminate redundant glTF data structure traversal
• Note: If there are any changes to the api we will need to update OBJ2GLTF and the website model converter

[lasalvavida]

Added a list of functions that are considered "stages" and should be converted to use promises in #99.

[JoshuaStorm]

We use mkdirp in a handful of files, which the Node guide encourages be replaced with fs-extra's ensureDir and ensureFile. Should this be added to the cleanup?

[lasalvavida]

We use mkdirp in a handful of files, which the Node guide encourages be replaced with fs-extra's ensureDir and ensureFile. Should this be added to the cleanup?

Yes

[JoshuaStorm]

Oh, I guess that is included in the

Use libraries recommended in the node guide

my bad

[lasalvavida]

We should have a common set of models that we use for testing new features, especially models that have created problems in the past. However I'm not sure if they should be hosted in this repo.

@lilleyse What do you think about including the glTF sampleModels as a git submodule?

[lilleyse]

I'm worried that may bloat the size of this repo.

[lasalvavida]

If it's linked via submodule, don't the files only get pulled if you git submodule --init?