Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Steve Piercy <[email protected]>
  • Loading branch information
sneridagh and stevepiercy authored Dec 8, 2024
1 parent 1c3a7d2 commit 431c991
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions PACKAGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,20 @@ This document describes the packages that come with Volto, the default frontend

These packages are part of Plone's API-first story.
Most of them are experimental and are marked in their respective `README` files.
Plone 6.1 (Volto 18) depends on:
Plone 6.1.x (Volto 18) depends on:
- `@plone/registry`
- `@plone/scripts`
- `@plone/volto-slate`

and as a development dependency:
- `@plone/types`

Plone 6 (Volto 17 and below) does not use any of them.
Plone 6.0.x (Volto 17 and below) does not use any of them.

These packages are expected to be used and part of Plone 7.
Could be that some of them will be part of the upcoming Plone minor versions prior to Plone 7.
These packages are expected to be used and become part of Plone 7.
Some of them might become part of Plone 6.1.x minor versions.

The packages are divided in three categories or types:
The packages are divided into three categories or types:

- core
- utilities
Expand Down Expand Up @@ -77,9 +77,9 @@ This bundle must work on both CommonJS and ESM environments.
Add-on or feature packages, can depend on any other package.
You must distribute them as source code, and not transpile them.
They must provide a default configuration registry loader as the default main entry point export.
Unlike Volto add-ons, it is preferibly *NOT* to place the code in `src` folder.
If the package is not being transpiled, the direct resolution must work OOTB, so the bundlers resolution is direct, as well as the TypeScript resolution.
They must be loadable as any other add-on and contain an add-on registry compatible `install`-able default export.
Unlike Volto add-ons, do *NOT* place the code in the `src` folder.
If you do not transpile the package, the direct resolution must work out of the box, where both the bundler and TypeScript resolution are direct.
They must be loadable as any other add-on, and contain an add-on registry compatible `install`-able default export.


## Development utility packages
Expand Down

0 comments on commit 431c991

Please sign in to comment.