xcx-example

Xcratch Example

An example extension for Xcratch

This extension add extra-block “do it”, that executes string in its input field as a sentence in Javascript and return the result.

✨ What You Can Do With This Extension

Play Example Project to look at what you can do with “Xcratch Example” extension.

How to Use in Xcratch

This extension can be used with other extension in Xcratch.

1. Open Xcratch Editor
2. Click ‘Add Extension’ button
3. Select ‘Extension Loader’ extension
4. Type the module URL in the input field

   https://xcratch.github.io/xcx-example/dist/xcratchExample.mjs
   

5. Click ‘OK’ button
6. Now you can use the blocks of this extension

Development

Install Dependencies

npm install

Setup Development Environment

Change vmSrcOrg to your local scratch-vm directory in ./scripts/setup-dev.js then run setup-dev script to setup development environment.

npm run setup-dev

Bundle into a Module

Run build script to bundle this extension into a module file which could be loaded on Xcratch.

npm run build

Watch and Bundle

Run watch script to watch the changes of source files and bundle automatically.

npm run watch

Test

Run test script to test this extension.

npm run test

Versioning and Deployment

This project uses npm version commands and GitHub Actions for versioning and deployment.

Create a New Version

Use npm version command to update the version number. This will automatically:

1. Update version in package.json
2. Run the build script
3. Create version-specific build files in dist/{version}/
4. Update dist/versions.json with the new version info
5. Create a git commit and tag

# Patch version (1.3.0 → 1.3.1)
npm version patch

# Minor version (1.3.1 → 1.4.0)
npm version minor

# Major version (1.4.0 → 2.0.0)
npm version major

Deploy to GitHub Pages

After creating a new version, push the tag to trigger automatic deployment:

# Push the version tag
git push origin v1.4.0

# Or push all tags
git push --tags

The GitHub Actions workflow will:

1. Build the extension
2. Deploy dist/, projects/, and README.md to GitHub Pages

You can also manually trigger deployment from the Actions tab in GitHub.

Version Information

All build versions are recorded in dist/versions.json:

{
  "extensionId": "xcratchExample",
  "latest": "1.4.0",
  "versions": [
    {
      "version": "1.4.0",
      "buildDate": "2025-10-19T12:34:56.789Z",
      "module": "1.4.0/xcratchExample.mjs"
    }
  ]
}

🏠 Home Page

Open this page from https://xcratch.github.io/xcx-example/

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

This site is open source. Improve this page.