daisy / daisy/pipeline-scripts

Clean up and homogenize scripts code

Open
#141 7 comments 1 reaction 1 assignee Claimed by @bertfrees View on GitHub
2 - In Progress L maintainability
Dominant language
HTML
Stars
6
Forks
3
PR merge metrics
No merged PRs in 30d

Description

### Part 1

- [x] Split scripts into load, convert and store steps. Name them all "px:foo.convert" and not "px:foo-convert".
- [ ] Homogenize names of ports of component steps. E.g. "source.fileset" and "source.in-memory" and not "fileset.in" and "in-memory.in".
- [ ] Possibly convert single-document ports and even anyFileURI options to fileset + in-memory ports.
- [ ] Merge fileset and in-memory ports into a single port, where the first document would be the fileset and the rest the in-memory documents.

### Part 2

- [ ] Add input validation to all scripts (to load steps): https://github.com/daisy/pipeline-scripts/issues/112. There should be an option named "validation" with possible values "off", "report" and "abort" (see https://github.com/daisy/pipeline-scripts/issues/111).
- [ ] Give all scripts a "status" output port with a `d:status` document (for now `d:validation-status`, see https://github.com/daisy/pipeline-framework/issues/121).
- [ ] Give all store steps an output port with a `c:result` document.
- [ ] Make sure all scripts have media-type set on all inputs, outputs and options (https://github.com/daisy/pipeline-tasks/issues/105)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.