Skip to content

Build tooling, packaging updates, and documentation site #42

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

Merged
merged 18 commits into from
Jun 18, 2025

Conversation

microbit-grace
Copy link
Contributor

  • Update tooling and build to generate ESM and CJS bundle (consistent with microbit-fs).
  • Use "NodeNext" as module and "type: module".
  • Use TypeDoc to generate documentation site, simplify docs, and add GH workflow for it.

Internal task

@@ -310,7 +311,7 @@ describe('Test parseRecord() for standard records', () => {
// TODO: Add tests for parsing BlockStart records
});

describe('Test parseRecord() for custom records', () => {
describe.skip('Test parseRecord() for custom records', () => {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Skip empty test to avoid test fail

@microbit-grace
Copy link
Contributor Author

Tested and works on a CJS project and on a ESM project

@microbit-grace microbit-grace changed the title [DRAFT - DO NOT MERGE] Build tooling, packaging updates, and documentation site Build tooling, packaging updates, and documentation site Jun 18, 2025
@microbit-grace microbit-grace marked this pull request as ready for review June 18, 2025 14:59
@microbit-grace
Copy link
Contributor Author

microbit-grace commented Jun 18, 2025

Works for me when I tested it in a more elaborate CJS project (private)

@microbit-grace microbit-grace merged commit a476a6b into main Jun 18, 2025
3 checks passed
@microbit-grace microbit-grace deleted the update-build branch June 18, 2025 15:58
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.

2 participants