draw2d

To compile the project and enable hot-reloading for a development workflow, use the serve script.

npm run serve

To compile and minify the project for production deployment, use the build script.

npm run build

To build the project, use a Python 3.9 virtual environment to run the build script:

1. Create and activate a Python 3.9 virtual environment.
2. Execute ./build.sh.

python3.9 -m venv venv  
source ./venv/bin/activate 
./build.sh

To set up the jsdoc project environment, install the necessary dependencies using npm.

npm install

To use the Haruki template, run the jsdoc command pointing to the Haruki template directory. You can specify the output format using the -q flag. Using -d console directs the output to stdout, allowing you to pipe the results into other tools.

./jsdoc myscript.js -t templates/haruki -d console -q format=xml

To release a new version to npm, use the following commands to patch the version and publish:

1. npm version patch
2. npm publish

To develop Draw2D locally, ensure you are using Node.js version v14.15.0 via nvm. Follow these steps to install dependencies and run the development server with examples:

1. Switch to the required Node version: nvm use v14.15.0
2. Install dependencies: npm install
3. Run the development server: DIR=/examples yarn dev

To run linting and automatically fix issues in the codebase, use the lint script.

npm run lint

The draw2d.command.CommandStack manages the execution, undoing, and redoing of draw2d.command.Command objects. It maintains an undo stack and a redo stack. When a new command is executed, the redo stack is automatically cleared to maintain a clean history.

You can access the current command stack from a canvas instance using canvas.getCommandStack().

const commandStack = canvas.getCommandStack();

// Execute a command
commandStack.execute(myCommand);

// Undo the last action
if (commandStack.canUndo()) {
  commandStack.undo();
}

// Redo an undone action
if (commandStack.canRedo()) {
  commandStack.redo();
}