npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@zappar/parcel-transformer-mattercraft

v1.0.0

Published

Transforms .zcomp files into JavaScript for Mattercraft projects, with TypeScript support.

Downloads

4

Readme

@zappar/parcel-transformer-mattercraft

Overview

The @zappar/parcel-transformer-mattercraft plugin is a Parcel transformer designed to enhance the development of Mattercraft projects. With this plugin, you can build your projects outside of the Mattercraft environment, which is particularly useful for integrating into CI/CD pipelines.

This transformer specifically handles the conversion of .zcomp files into JavaScript and automatically generates corresponding .d.ts files.

Table Of Contents

Prerequisites

Before you can use this plugin, make sure you have Parcel installed.

If you haven't installed Parcel yet, you can do so via npm:

npm i --save-dev parcel

Installation

To install the @zappar/parcel-transformer-mattercraft plugin, run the following command in your project directory:

npm i --save-dev @zappar/parcel-transformer-mattercraft

Configuration

After installation, you need to set up your Parcel configuration.

Parcel Configuration

Create a .parcelrc file in your project root with the following content:

{
  "extends": "@parcel/config-default",
  "transformers": {
    "*.zcomp": ["@zappar/parcel-transformer-mattercraft"]
  }
}

This configuration tells Parcel to use the @zappar/parcel-transformer-mattercraft for handling .zcomp files.

Usage

Adding Build and Start Scripts

In your package.json, add build and start scripts to leverage Parcel:

"scripts": {
  "start": "parcel serve ./src/index.html",
  "build": "parcel build ./src/index.html"
}

Replace ./src/index.html with the path to your project's entry file.

Running Your Project

To start your development server, run:

npm run start

To build your project for production, run:

npm run build

Example Repository

To help you get started with the @zappar/parcel-transformer-mattercraft plugin, we have created an example project that demonstrates its use in a real-world scenario. This example repository showcases how to set up and serve a Mattercraft project using Parcel along with our plugin.

The project was initially exported from Mattercraft and includes features like HTML UI integration within a Mattercraft scene. It also provides a detailed README to guide you through the setup, configuration, and usage, making it an ideal starting point for both beginners and experienced developers.

You can find the example project here: Mattercraft-Parcel Example

This example serves as a practical reference for understanding how to effectively use the @zappar/parcel-transformer-mattercraft in your projects.

Caveats

HTTPS

If your Mattercraft project requires access to the device's camera, it's important to note that most modern browsers require a secure context (https) for camera access. To ensure your project works correctly during development, you will need to set up HTTPS serving for your Parcel server.

Add the --https flag to your start script. This will make Parcel serve your project over HTTPS:

"scripts": {
  "start": "parcel serve ./src/index.html --https",
  "build": "parcel build ./src/index.html"
}