pressbooks / pressbooks-build-tools

NPM package which includes all asset linting and build tools for Pressbooks projects.

Pressbooks

Contributors: Pressbooks [email protected] Tags: ebooks, publishing, webbooks Requires at least: 6.6.1 Tested up to: 6.6.1

Stable tag: 6.19.2

Requires PHP: 8.1 License: GPL v3.0 or later License URI: https://github.com/pressbooks/pressbooks/blob/production/LICENSE.md

Pressbooks is an open source book publishing tool built on a WordPress multisite platform.

Description

Pressbooks is an open source book publishing tool built on a WordPress multisite platform. Pressbooks outputs books in multiple formats, including PDF, EPUB, web, and a variety of XML flavours, using a theming/templating system, driven by CSS. Pressbooks is free software, released under the GPL v3.0 or later license.

Our webbooks and EPUB/PDF exports are all driven by HTML + CSS. XML outputs have no styling.

Requirements

Pressbooks works with PHP 8.1 and WordPress 6.6.1. Lower versions are not supported.

Installing the Plugin

Pressbooks is not for use on an existing blog. Instead it should be used with a fresh, multisite WordPress installation.

To install Pressbooks on your site, download the latest release and follow our installation instructions.

You may want to try Pressbooks.com before deciding whether or not you wish to host and maintain your own instance of Pressbooks. We can also host and maintain an instance of Pressbooks for you.

Contributor guidelines

Developers who are interested in contributing to our project should consult our "Contributing" guidelines and the developer guides published on our documentation website.

Disclaimers

The Pressbooks plugin is supplied "as is" and all use is at your own risk.

Changelog

Please see the CHANGELOG file for more information.

pressbooks-build-tools's Issues

[Research] Replace Mix with Vite as build tool

The dev team has used Vite instead of Mix/Pressbooks Build Tools for the last two plugins they've created. We replace should update Pressbooks Build Tools to use Vite and use it consistently across all our maintained repos.

DoD:

• Research the use of Vite for build processes across all Pressbooks repo
• Write a brief report/recommendation for team to agree on
• Prepare Pressbooks Build Tools 5.0.0 release that uses the recommended approach

Resources

https://github.com/laravel/vite-plugin/blob/main/UPGRADE.md#migrating-from-laravel-mix-to-vite
https://christoph-rumpel.com/2022/6/moving-a-laravel-webpack-project-to-vite
https://creagia.com/blog/using-laravel-vite-with-bootstrap-and-sass

Standardize usage & update build tools

In old days, this repo was required as a dev dependency in most theme/plugin repos. When Ned left, Dac created a ‘no install build tools’ approach to reduce maintenance: pressbooks/pressbooks#1834. Ned preferred going the dev dependency route, so we reverted to that approach in some repos after Dac left. We’re kind of in between on which approach to take. Compare pressbooks-book: https://github.com/pressbooks/pressbooks-book/blob/065f0baacd232118ac3ca480c3614b4bd3c24c89/package.json#L21 with Malala: https://github.com/pressbooks/pressbooks-malala/blob/cecae23a35a8aa8eaa800ec516b7435cb9a6de36/package.json#L15.

Ned has historically been the expert here – but we should take this in house. See https://github.com/pressbooks/pressbooks-build-tools/pull/281/files + #279.

We also haven’t looked at or updated this repo itself in several months. I don’t think it supports node 16, for example. See: https://github.com/pressbooks/pressbooks-malala/runs/6281068108?check_suite_focus=true.

TODO:

• Update this repo/package as desired
• Decide whether we want to require this package as a dev dependency or use the no install method
• Apply this consistently across all relevant repos

Create automated tests for build tools

Create automated tests for 5 basic functions of this repo. Once done, could set up auto dependabot merging for repo.

Update deprecated eslint-config-humanmade package

When running npm install --no-save pressbooks-build-tools we receive a npm WARN deprecated [email protected]: Package moved to @humanmade/eslint-config warning. We should update the package reference:

pressbooks-build-tools/package.json

Line 35 in 37a9f33

"eslint-config-humanmade": "^0.7.0",

Old (deprecated) package: https://www.npmjs.com/package/eslint-config-humanmade
New package: https://www.npmjs.com/package/@humanmade/eslint-config