Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/plugins/woocommerce-admin/bin/hook-reference
History
Chi-Hsuan Huang 86fc8b62e5 Switch to pnpm (https://github.com/woocommerce/woocommerce-admin/pull/8349) 
* Add pnpm-workspace.yaml

* Add missing dependencies & replace file: with workspace:* in
package.json

* Replace "npm" with "pnpm"

* Replace "npx" with "pnpx"

* Remove package-lock.json

* Add pnpm setup action to github workflows

* Update webpack babel exclude path

* Upgrade woo e2e and fix e2e test command

Update e2e.yml

Use pnpm run e2e:docker-up in e2e.yml

* Remove unused docker-compose.yaml

* Replace lerna with pnpm commands

Update publish commands

* Exclude _locutus_shared_bc.js in babel.config.js

* Add .npmrc to set enable-pre-post-scripts=true by default

* Fix storybook babel config

Update babel.config.js

* Add changelog

* Update pnpm-lock.yaml

* Replace pnpx with pnpm exec

* Update pnpm-lock.yaml

* Remove js-tests/package-lock.json

* Fix @woocommerce/tracks -> workspace:*

* Update pnpm-lock.yaml

* Add @woocommerce/experimental to onboarding/package.json

* Add "@woocommerce/component" to onboarding/package.json

* Update pnpm-lock.yaml

* Use || instead of && for "test:watch"

Co-authored-by: RJ <27843274+rjchow@users.noreply.github.com>

* Fix packages/number "clean" command

* Add root: true to .eslintrc.js to enforce it to use the root config file

* Exclude packages/**/node_modules from babel transpiling

* Fix js-tests build config

Co-authored-by: RJ <27843274+rjchow@users.noreply.github.com>
 		2022-03-04 12:01:16 +08:00
..
README.md Switch to pnpm (https://github.com/woocommerce/woocommerce-admin/pull/8349) 2022-03-04 12:01:16 +08:00
data.js Add hook reference generator README and documentation (https://github.com/woocommerce/woocommerce-admin/pull/8004) 2022-02-11 10:38:38 -04:00
data.json Add hook reference generator README and documentation (https://github.com/woocommerce/woocommerce-admin/pull/8004) 2022-02-11 10:38:38 -04:00
index.js Hook reference: Add SlotFill support (https://github.com/woocommerce/woocommerce-admin/pull/6833) 2021-07-09 11:01:43 +12:00

README.md

Hook Reference Generator

Compile a publishable JSON object of WooCommerce's JavaScript filters and slotFill entry points.

Usage

Generate a new reference found at bin/hook-reference/data.json by running the following command.

pnpm run create-hook-reference

The data includes references to code in the Github repository by commit hash, so it is essential to commit the resulting data in a pull request to main so code references are publicly available.

DocBlock Requirements

JavaScript documentation blocks require certain fields in order to be included in the reference.

Filter

Tag Description
@filter Filter string used as addFilter's first argument

SlotFill

Tag Description
@slotFill The fill component's name