@hizzlewp/history

History utilities for WordPress plugins


Keywords
wordpress, hizzle
License
CNRI-Python-GPL-Compatible
Install
npm install @hizzlewp/history@1.0.1

Documentation

HizzleWP Monorepo

A monorepo containing shared packages for WordPress plugin development.

Packages

Check out the packages the directory for information on each package and how to create/use them.

Development Setup

  1. Clone the repository:
git clone https://github.com/hizzle-co/hizzle.git
cd hizzle
  1. Install dependencies:
npm install
  1. Start development watcher:
npm run dev
  1. Build all packages:
npm run build

Usage in WordPress Plugins

  1. Install the HizzleWP package:
composer require hizzle/wp
  1. Install the required npm packages:
npm install @hizzlewp/components
npm install --save-dev @hizzlewp/dependency-extraction-webpack-plugin
  1. Configure your webpack build to use the dependency extraction plugin:
const HizzleWPDependencyExtractionPlugin = require('@hizzlewp/dependency-extraction-webpack-plugin');

module.exports = {
	// ... other webpack config
	plugins: [new HizzleWPDependencyExtractionPlugin()],
};
  1. Import components in your code:
import { Setting } from '@hizzlewp/components';

The imports will be automatically transformed to use the global window.hizzlewp object at runtime.

License

GPL-2.0-or-later

Release (to npm and composer)

npm run release release_type=minor

type accepts: major, minor, patch, premajor, preminor, prepatch, prerelease

This will:

  • Build the packages
  • Update the composer.json file with the new version
  • Update the npm package version
  • Generate the docs
  • Commit and push the changes
  • Create a new release on GitHub
  • Release changed packages to npm
  • Update the changelogs
  • Update the composer package

NOTE:-

  • You must have the GitHub CLI installed.
  • You must be authenticated with sufficient permissions.