Skip to content

Publish @minecraft/api-docs-generator and @minecraft/markup-generators-plugin #74

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

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

zachcampbellskyboxlabs
Copy link
Contributor

@zachcampbellskyboxlabs zachcampbellskyboxlabs commented Jun 19, 2025

This adds @minecraft/api-docs-generator and @minecraft/markup-generators-plugin as well as a test snapshots package under ./tools. Many configuration changes to accommodate the docs generator.

@minecraft/core-build-tasks minor update:

  • Updates the publishRelease task to be able to upload a pre-existing NPM tarball by specifying its directory i.e. publishRelease({ artifact: { path: ..., sourceFormat: 'archive' }, ... });
    • This is to avoid creating a release with a double-zipped tarball for the docs generator.
    • Also adds support for specifying a directory other than dist as well as multi-directory support.
    • Existing behaviour when no directory is specified is unchanged, defaults to zipping dist.
  • Update package.json to add exports.types, because imports from core-build-tasks in just configs were previously any-typed.

Configuration file updates:

  • VSCode settings - Updates settings.json, adds launch.json, tasks.json, with launch tasks for running/testing api-docs-generator, adds extensions.json with extensions for developing with api-docs-generator.
  • Update root package.json with test:ci to reduce turbo concurrency on CI (PR feedback), and test:update / lint:fix sub-commands for convenience.
  • Update turbo.json.
  • Update .gitignore and add .prettierignore.

Documentation updates:

  • Update root README.md and CONTRIBUTING.md; formatting, update referenced Node.js version to v22.x; add details to contribution guidelines.

GitHub Workflows:

  • Update workflows to use test:ci.

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