automattic/jetpack-mu-wpcom

Enhances your site with features powered by WordPress.com

Installs: 15 559

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 4

Forks: 0

Type:jetpack-library

v5.31.1 2024-05-20 18:04 UTC

README

Note: This package is intended for internal use by WordPress.com only.

Enhances your site with features powered by WordPress.com

Automattician? Read more at: PCYsg-Osp-p2

Using this package in your WordPress plugin

If you plan on using this package in your WordPress plugin, we would recommend that you use Jetpack Autoloader as your autoloader. This will allow for maximum interoperability with other plugins that use this package as well.

Security

Need to report a security vulnerability? Go to https://automattic.com/security/ or directly to our security bug bounty site https://hackerone.com/automattic.

Build System

Note: cd to projects/packages/jetpack-mu-wpcom before running these commands

  • npm run build-js
    Compiles the plugins for development - the files are not minified and we produce a source map.

  • npm run build-production-js
    Compiles the plugins for production - we produce minified files without source maps.

  • npm run clean
    Removes all build files.

The entry point is:

  • Plugin: projects/packages/jetpack-mu-wpcom/src/features/{{feature-name}}/index.js

The output is:

  • Plugin: /projects/packages/jetpack-mu-wpcom/src/build/{{feature-name}}/{{feature-name}}.js

Adding files to the build system

If you're adding a new feature that includes Javascript or Typescript, you will need to add the primary source file to the entry section in projects/packages/jetpack-mu-wpcom/webpack.config.js, where we'll use the key as the core file name, and the value as the primary input file for that module.

License

jetpack-mu-wpcom is licensed under GNU General Public License v2 (or later)