@pixi-build-tools/fiddle
v1.0.1
Published
Webpack + Babel Pixi.js Template
Downloads
4
Readme
@pixi-build-tools/fiddle
PixiJS + webpack + Babel + @pixi/eslint-config
This package spun off of @alkamin's pixijs-template repo. I have tuned this for local development of PixiJS so that you can test your changes to pixi.js-related packages locally.
The use of ECMAScript allows you to copy/paste your fiddle to online JavaScript editors like CodePen.
Usage
Clone the repository and create your first fiddle:
git clone https://github.com/SukantPal/pixi-fiddle
npm run open -- --fiddle basic-fiddle
npm run start
The entry point is src/index.js
. This will be initialized with some boilerplate code.
Your fiddles are stored in the fiddle-workspace
directory. This package helps you copy fiddles from and to the source directory src
.
Commands
This will save the current fiddle and "open" the fiddle passed via --fiddle. Opening a fiddle just copies its contents into the source directory.
You can pass a --no-save option to "forget" the current fiddle state.
This is also the current way to create a new fiddle!
This will save the current fiddle. You can use this before you start tearing down stuff in your fiddle for refactoring/restructuring something big!
This is used to delete the fiddle saved in fiddle-workspace
. It will not reset the source directory contents.
This will "print working fiddle" or the fiddle that is currently opened in src.
This will change the version suffix of your fiddle name. You can use this before flushing your fiddle to keep a "history" of your changes. If the current fiddle is my-fiddle, then it will become my-fiddle-1.
This will rollup all JS files in your src
directory using RollupJS. It also "tries" to erase any local requires to packages given in pkgWatch
(config file). The resulting fiddle is placed in the export
directory.
Config File
You can create a config file fiddle.config.json
to register your local PixiJS repo. For example,
{
"pkgWatch": {
"pixi.js": "../pixi.js/bundles/pixi.js/lib/pixi"
}
}
Make sure path is to the CommonJS bundle (not the project root). Support for adding more packages will be added.
Template
If you want to change what code new fiddles have, change the tools/template folder and update template.registrar.json
with the files you want "processed".
Assets
All assets are placed in the src/assets/
directory and will be available to the app at assets/
.
Scripts
npm run start
- start the development servernpm run build
- build a deployable bundlenpm run reinit
- after cloning the repo, run this command to re-initialize the repository for your own project