npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript.Learn more »

@wpackio/scripts

3.5.0 • Public • Published

@wpackio/scripts

This is the main scripts package of wpack.io tool.

Please refer to the readme of this repo for usage instruction.

What is wpack.io?

Put simply, wpack.io is a nodejs based build tool to ease up using modern javascript in WordPress Themes and Plugins. It gives a fine Developer Experience (DX) and a single dependency for all your bundling requirement.

It is a fine-tuned webpack/browser-sync configuration made specifically for WordPress Theme and Plugin Development.

With the rise of Gutenberg editor, the usage of modern JavaScript and libraries like react is imminent. The goal of this tooling is to:

  • ✅ Provide out of the box compiling and bundling of all front-end assets.
  • ✅ Give best in class Developer Experience (DX).
    • Hot Module Replacement and Live Reload.
    • Compile files on save.
    • Work on any local development server.
  • ✅ Support modern and useful concepts like modules, tree-shaking, dynamic import etc.

and eliminate the pain points such as:

  • ❌ Boilerplate for setting up your project.
  • ❌ Doing a lot of configuration to setup webpack.
  • ❌ A lot of things to hook webpack with browsersync. We can not safely have webpack dev server because it doesn't reload for PHP files.
  • ❌ A lot of dependencies like babel, webpack loaders and what not.

What is supported out of the box

  • 👉 Have Create React App like developer experience for WordPress Plugin/Theme development.
  • 👉 Consume all the modern packages from npm registry.
  • 👉 Write javascript with modern ES2018 (ES6+) syntax and compile it down to ES5 (or in accordance to your .browserslistrc).
  • 👉 Automatically minify and bundle code with webpack.
  • 👉 Split large files automatically and have PHP library to wp_enqueue_script all generated parts.
  • 👉 Use SASS/SCSS language to create stylesheets.
  • 👉 Use postcss autoprefixer to automatically make your CSS work with needed vendor prefixes.
  • 👉 Implement all the above to your existing wamp, mamp, vvv (basically any) dev server.
  • 👉 Create production grade, super optimized and minified files with one command (hello CI).

Here are a few more bonus you get for using wpackio.

  • 😎 Using ES6 Modules you will never run into namespace collision.

    Remember when that third-party plugin was using that old version of foo library which caused your system to completely fail? No more!.

  • 😎 Zero configuration for a sane default of all the tooling involved (babel, sass, webpack).
  • 😎 Your CSS/SCSS changes will reflect instantly.
  • 😎 Typescript and Flowtype to take your js carrier to the next level. This tooling itself is written in typescript 😉.
  • 😎 All the stuff you need to start developing using react. Hello Gutenberg!

Getting Started

Everything is documented in our website.

TL;DR

  • Add @wpackio/scripts to a project by running this.
    npx @wpackio/cli
    and after that
    npm run bootstrap
  • Edit the wpackio.project.js file to write your javascript entry-points.
  • Use wpackio/enqueue from composer to consume the assets.
  • Start the server using npm start.
  • Create production file using npm run build.

How wpack.io solves the problems?

Behind the scene wpack.io uses webpack along with browsersync.

It doesn't concern itself with providing boilerplate or starter templates. It assumes that you (the awesome developer 👨‍💻 || 👩‍💻) is already doing that and what you want is a simple to configure, yet hackable to the core tooling for bundling all your frontend assets (js, css, images, svgs) in the most optimized way and make it work within your WordPress theme or plugin.

Keeping that in mind, wpack.io provides three dependencies for your projects:

  1. @wpackio/entrypoint - As main dependency of your package.json.
  2. @wpackio/scripts - As main dev dependency of your package.json.
  3. wpackio/enqueue - As main dependency of your composer.json.

The first handles all the tasks for building the assets and providing a damn good DX.

The second handles enqueuing the assets using WordPress' API (wp_enqueue_script and wp_enqueue_style).

Both the tools communicate with each other through the means of manifest.json file. The first tell the later which files to consume and the later publicPath to the first.

For more information do check the official documentation.

Development

This package has the same npm scripts as this monorepo. These should be run using lerna run <script>. More information can be found under CONTRIBUTION.md.

  • build: Use babel to build for nodejs 8.6+. Files inside src are compiled and put under lib. All type definitions are stripped and individual type declaration files are created.
  • prepare: Run build after yarn and before publish.
  • lint: Lint all files using eslint.
  • test: Run tests on files using jest.

install

npm i @wpackio/scripts

Downloadsweekly downloads

93

version

3.5.0

license

MIT

homepage

wpack.io

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability