Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate just an OBF file when exporting a single board #739

Merged
merged 6 commits into from
Jul 4, 2020

Conversation

sylvansson
Copy link
Collaborator

This PR changes the behaviour when exporting a single board in the Open Board Format to generate a single OBF file rather than an OBZ archive. I tested this in my browser and everything seems fine, but I'll do another round of QA tomorrow evening. I suggest someone else test this too.

A few notes:

  • Images are embedded in the file with the data property. It would be useful to embed sounds as well, but it seemed out of scope so I simply added a TODO.
  • OBF files are pretty printed to make them easier to read and edit manually.
  • Exports in the Open Board Format are now prefixed with the date, and the time uses the 24-hour clock. This makes exports easier to sort chronologically.

@martinbedouret @shayc Have we considered or tried using TypeScript before? I started using it for this task but it got slightly out of hand, so I undid the changes. It seems we could use the type safety.

Close #653

@sylvansson sylvansson self-assigned this Jul 3, 2020
Copy link
Collaborator

@martinbedouret martinbedouret left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have been testing it and worked great. Still need to do testing using symbols from APIs and do some code review.

Copy link
Collaborator

@martinbedouret martinbedouret left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job @sylvansson ! My only comment is to use the same naming convention you are using for obf's, on the other two types (pdf and cboard ).

src/components/Settings/Export/Export.helpers.js Outdated Show resolved Hide resolved
@martinbedouret martinbedouret merged commit b3bbd5b into master Jul 4, 2020
@martinbedouret martinbedouret deleted the 653-export-to-obf branch July 4, 2020 00:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow exporting just a single board using the obf file format
2 participants