woocommerce/packages/js
RJ 109744db33
fix: remove help panel user meta (#51249)
2024-09-13 05:46:27 +08:00
..
admin-e2e-tests Use syncpack to lock pnpm version till we can fix issues (#50828) 2024-08-22 12:34:42 +12:00
admin-layout Add changelogs to trigger version bumps in packages (#48645) 2024-07-25 13:57:30 -07:00
ai [testing workflows] Add workflow_call trigger in CI workflow - support daily and other types of runs (#47612) 2024-05-22 11:04:44 -07:00
api Use syncpack to lock pnpm version till we can fix issues (#50828) 2024-08-22 12:34:42 +12:00
api-core-tests Use syncpack to lock pnpm version till we can fix issues (#50828) 2024-08-22 12:34:42 +12:00
block-templates Add changelogs to trigger version bumps in packages (#48645) 2024-07-25 13:57:30 -07:00
components Upgrade storybook to version 7 and add pages workflow for GH publishing (#51168) 2024-09-09 12:06:01 -03:00
create-product-editor-block Use syncpack to lock pnpm version till we can fix issues (#50828) 2024-08-22 12:34:42 +12:00
create-woo-extension Use syncpack to lock pnpm version till we can fix issues (#50828) 2024-08-22 12:34:42 +12:00
csv-export Use syncpack to lock pnpm version till we can fix issues (#50828) 2024-08-22 12:34:42 +12:00
currency Use syncpack to lock pnpm version till we can fix issues (#50828) 2024-08-22 12:34:42 +12:00
customer-effort-score Use syncpack to lock pnpm version till we can fix issues (#50828) 2024-08-22 12:34:42 +12:00
data fix: remove help panel user meta (#51249) 2024-09-13 05:46:27 +08:00
date Fix typos. (#50047) 2024-08-23 18:26:09 +01:00
dependency-extraction-webpack-plugin Use syncpack to lock pnpm version till we can fix issues (#50828) 2024-08-22 12:34:42 +12:00
e2e-core-tests Use syncpack to lock pnpm version till we can fix issues (#50828) 2024-08-22 12:34:42 +12:00
e2e-environment Use syncpack to lock pnpm version till we can fix issues (#50828) 2024-08-22 12:34:42 +12:00
e2e-utils Clean up 'Profile Wizard' code (#51190) 2024-09-10 11:29:14 +08:00
eslint-plugin Use syncpack to lock pnpm version till we can fix issues (#50828) 2024-08-22 12:34:42 +12:00
experimental Upgrade storybook to version 7 and add pages workflow for GH publishing (#51168) 2024-09-09 12:06:01 -03:00
explat Use syncpack to lock pnpm version till we can fix issues (#50828) 2024-08-22 12:34:42 +12:00
expression-evaluation Fix typos. (#50047) 2024-08-23 18:26:09 +01:00
extend-cart-checkout-block Use syncpack to lock pnpm version till we can fix issues (#50828) 2024-08-22 12:34:42 +12:00
integrate-plugin [testing workflows] Add workflow_call trigger in CI workflow - support daily and other types of runs (#47612) 2024-05-22 11:04:44 -07:00
internal-e2e-builds Use syncpack to lock pnpm version till we can fix issues (#50828) 2024-08-22 12:34:42 +12:00
internal-js-tests Use syncpack to lock pnpm version till we can fix issues (#50828) 2024-08-22 12:34:42 +12:00
internal-style-build Use syncpack to lock pnpm version till we can fix issues (#50828) 2024-08-22 12:34:42 +12:00
navigation Use syncpack to lock pnpm version till we can fix issues (#50828) 2024-08-22 12:34:42 +12:00
notices Use syncpack to lock pnpm version till we can fix issues (#50828) 2024-08-22 12:34:42 +12:00
number [Accessibility] Fix typo in parse number tests (#48644) 2024-08-23 19:59:11 -04:00
onboarding Upgrade storybook to version 7 and add pages workflow for GH publishing (#51168) 2024-09-09 12:06:01 -03:00
product-editor Upgrade storybook to version 7 and add pages workflow for GH publishing (#51168) 2024-09-09 12:06:01 -03:00
remote-logging Prepare Packages for Release (#51222) 2024-09-09 04:54:09 +00:00
tracks Fix some comment typos. (#50993) 2024-08-27 10:54:10 -07:00
README.md [Accessibility] Fix typos in packages/js/**/*.md files (#48569) 2024-06-20 13:04:24 -07:00
tsconfig-cjs.json Enforce Strict `@types` Dependencies (#37351) 2023-03-23 18:02:20 -07:00
tsconfig.json Fix TypeScript Incremental Build Regression (#37432) 2023-03-24 12:07:49 -07:00

README.md

WooCommerce Packages

Currently we have a set of public-facing packages that can be downloaded from npm and used in external applications. Here is a non-exhaustive list.

  • @woocommerce/components: A library of components that can be used to create pages in the WooCommerce dashboard and reports pages.
  • @woocommerce/csv-export: A set of functions to convert data into CSV values, and enable a browser download of the CSV data.
  • @woocommerce/currency: A class to display and work with currency values.
  • @woocommerce/date: A collection of utilities to display and work with date values.
  • @woocommerce/navigation: A collection of navigation-related functions for handling query parameter objects, serializing query parameters, updating query parameters, and triggering path changes.
  • @woocommerce/tracks: User event tracking utility functions for Automattic based projects.

Working with existing packages

  • You can make changes to packages files as normal, and running pnpm start will compile and watch both app files and packages.
  • ⚠️ Add any dependencies to a package using pnpm add from the package root.
  • ⚠️ Make sure you're not importing from any other files outside of the package (you can import from other packages, just use the import from @woocommerce/package syntax).
  • Don't change the version in package.json.
  • Label your PR with the Packages label.
  • See the Package Release Tool for instructions on how to release packages.

Creating a new package

Most of this is pulled from the Gutenberg workflow.

To create a new package, add a new folder to /packages, containing…

  1. package.json based on the template:

    {
     "name": "@woocommerce/package-name",
     "version": "1.0.0-beta.0",
     "description": "Package description.",
     "author": "Automattic",
     "license": "GPL-2.0-or-later",
     "keywords": [ "wordpress", "woocommerce" ],
     "homepage": "https://github.com/woocommerce/woocommerce/tree/trunk/packages/js/[_YOUR_PACKAGE_]/README.md",
     "repository": {
      "type": "git",
      "url": "https://github.com/woocommerce/woocommerce.git"
     },
     "bugs": {
      "url": "https://github.com/woocommerce/woocommerce/issues"
     },
     "main": "build/index.js",
     "module": "build-module/index.js",
     "react-native": "src/index",
     "publishConfig": {
      "access": "public"
     }
    }
    
  2. .npmrc file which disables creating package-lock.json file for the package:

    package-lock=false
    
  3. README.md file containing at least:

    • Package name
    • Package description
    • Installation details
    • Usage example
  4. A src directory for the source of your module. Note that you'll want an index.js file that exports the package contents, see other packages for examples.

  5. A blank Changelog file, changelog.md.

    # Changelog
    
    This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
    
  6. Add the new package name to packages/js/dependency-extraction-webpack-plugin/assets/packages.js so that users of that plugin will also be able to use the new package without enqueuing it.