Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Bento: Reorganizing

See original GitHub issue

Summary

I believe that over the past few years of development, we’ve developed some alignment/messaging/naming cruft. Here are some items I believe we should update with urgency:

amp-base-carousel --> amp-carousel, bento-base-carousel --> bento-carousel: (https://github.com/ampproject/amphtml/issues/37380)
publish packages to @ampproject/bento-XYZ instead of @ampproject/amp-XYZ
Stop publishing the AMP Binary to NPM. It isn’t realistically usable outside of the AMP Cache.
Direct all consumers to use NPM Caches instead of the AMP Cache for all use cases (unpkg, cdnjs, etc). Do this by updating the bentojs documentation website.
Decouple Bento’s versioning scheme from AMP versions. Bento can follow a more traditional semver model, whereas AMP can continue with its RTVs. This means removing the file-based versioning scheme.

Notifications

/cc @ampproject/wg-bento

Issue Analytics

State:
Created 2 years ago
Comments:12 (12 by maintainers)

Top GitHub Comments

1reaction

kvcharicommented, Feb 18, 2022

Following-up on this after discussion yesterday:

Decouple Bento’s versioning scheme from AMP versions. Bento can follow a more traditional semver model, whereas AMP can continue with its RTVs. This means removing the file-based versioning scheme

We’re going to continue using AMP’s versioning scheme (using RTVs) for Bento components because using a more traditional semver model would require bumping the major (since our minor is already so high). Bumping the major of all the extensions is disruptive and places additional maintenance burden on preserving the old versions (in source code or a release branch).

Direct all consumers to use NPM Caches instead of the AMP Cache for all use cases (unpkg, cdnjs, etc). Do this by updating the bentojs documentation website.

When we begin directing consumers to use NPM caches, we’ll also have to remember to direct them to either use importmaps, to remap @bentoproject/core (any any other dependencies of a particular component, e.g. mustache) to the corresponding CDN package [^example], or use a CDN that expands bare import specifiers (e.g unpkg See ?module documentation in Query Parameters section)

importmaps example:

<head>
  <script type="importmap">
  {
      "imports": {
        "@bentoproject/core": "https://unpkg.com/@bentoproject/core@<version>/dist/bento.core.module.js"
    }
  }
  </script>
  <script type="module" src="https://unpkg.com/@bentoproject/accordion@<version>/dist/web-component.module.js"></script>
</head>

0reactions

samouricommented, Feb 4, 2022

To declare that a package has sideEffects, we would have to add sideEffects: false

Do you mean to declare that a package doesn’t have side effects? The default is to assume that all packages have side effects. Also, AFAIK this entire concept is only important for CJS and barely relevant for ESM.

I don’t think a side-effecting auto-registration vs. allowing them to choose when to register has a bundle size impact (both are equally good as far as bundlers are concerned).