Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(build)!: Introduce exports section in package.json #7822

Merged
merged 10 commits into from
Mar 15, 2024
Merged

feat(build)!: Introduce exports section in package.json #7822

merged 10 commits into from
Mar 15, 2024

Commits on Mar 13, 2024

  1. fix(typings): Remove bogus .d.ts files; add new languages 

    PR google#3821 added .d.ts files for every file in msg/json/, but several
of these are internal utility files rather than translations, and
do not result in a langfile being output by create_messages.py
when building langfiles.

In the meantime we have added a few new languages that are being
published but which have (until now) not had the corresponding
type declarations.
    @cpcallen
    cpcallen committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    ba97923 View commit details
    Browse the repository at this point in the history

  2. feat(build)!: Add exports section to package.json 

    Add an exports stanza to package.json, enumerating existing
entrypoints in a new format.

- The original main entrypoint, index.js, is removed since the
  exports section can point directly at node.js or browser.js.
- No change made (yet) to other entrypoints (core, blocks,
  generators); these will be dealt with in a subsequent PR.
- The msg/en entrypoint is included in the top-level package.json
  as an example; entries for all other languages created as part
  of the packageJSON package task.

BREAKING CHANGE: The introduction of an exports stanza means that
correctly-behaved tools (node.js, bundlers like webpack, etc.)
will only allow importing of the specified entrypoints.  Here
is the full list of permitted entrypoints that can be imported
or required:

- blockly
- blockly/core
- blockly/blocks
- blockly/dart
- blockly/lua
- blockly/javascript
- blockly/php
- blockly/python
- blockly/msg/<lang>, for all supported language codes <lang>
  (e.g blockly/msg/en, blockly/msg/fr, blockly/msg/de, etc.)

If you previously impored any other paths from the blockly package
you will need to update your imports.  Here are the most common
paths that may have been used, and their correct replacements:

| If you previously imported:      | Import instead:            |
| -------------------------------- | -------------------------- |
| blockly/index.js                 | blockly                    |
| blockly/node.js                  | blockly                    |
| blockly/browser.js               | blockly                    |
| blockly/blockly.min | This file should only be loaded as a <script>. |
| blockly/core.js                  | blockly/core               |
| blockly/core-browser.js          | blockly/core               |
| blockly/blockly_compressed.js    | blockly/core               |
| blockly/blocks.js                | blockly/blocks             |
| blockly/blocks_compressed.js     | blockly/blocks             |
| blockly/dart.js                  | blockly/dart               |
| blockly/dart_compressed.js       | blockly/dart               |
| blockly/lua.js                   | blockly/lua                |
| blockly/lua_compressed.js        | blockly/lua                |
| blockly/javascript.js            | blockly/javascript         |
| blockly/javascript_compressed.js | blockly/javascript         |
| blockly/php.js                   | blockly/php                |
| blockly/php_compressed.js        | blockly/php                |
| blockly/python.js                | blockly/python             |
| blockly/python_compressed.js     | blockly/python             |
| blockly/msg/en.js                | blockly/msg/en             |
    @cpcallen
    cpcallen committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    67ddeac View commit details
    Browse the repository at this point in the history

  3. fix(build): Use package-paths (blockly/*) in wrapper imports 

    Use 'blockly/core' instead of './core' when importing core into
other wrappers (and similarly for other entries in package.json
exports stanza), so that (e.g.) dist/javascript.js won't
import dist/core.js (the node.js version that loads jsdom) when
being loaded in a browser environment.

This fixes an issue where blockly attempts to load jsdom even
in browser environments because the browser stanza in
package.json, which caused attempts to load core.js to load
core-browser.js instead in browser environments, was removed
in a previous commit.
    @cpcallen
    cpcallen committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    0ce9008 View commit details
    Browse the repository at this point in the history

  4. refactor(build): Remove unnecessray wrappers 

    Remove pointless wrapper modules that no longer server any
purpose; use exports stanza in package.json to point directly to
compiled chunks where possible.
    @cpcallen
    cpcallen committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    0cadbd0 View commit details
    Browse the repository at this point in the history

  5. refactor(build)!: Eliminate separate browser and node entrypoints 

    Combine scripts/package/browser/index.js (becomes dist/browser.js)
and scripts/package/node/index.js (becomes dist/node.js) into
a single environment-agnostic index.js.

BREAKING CHANGE: Historically, importing the main 'blockly' package
would import 'blockly/core', 'blockly/blocks', 'blockly/en' and
'blockly/javascript' - and additionally, in node.js, also import
'blockly/dart', 'blockly/lua', 'blockly/php' and 'blockly/python'.

Now the main 'blockly' package entrypoint never loads any of the
generator modules.

This change has been made because of changes to generator exports
made in blockly v9.0.0 that make necessary to always separately
import generator modules.

Note that this change does not affect loading the blockly package
via <script src="https://unpkg.com/blockly"; that continues to
load to blockly.min.js, which includes javascript_compressed.js
and (due to being loaded as a script) makes it available via
Blockly.JavaScript.
    @cpcallen
    cpcallen committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    7372c49 View commit details
    Browse the repository at this point in the history

  6. refactor(build): Simplify core entrypoint wrapper for node.js 

    Move scripts/package/node/core.js to scripts/package/core-node.js,
and have it packaged as dist/core-node.js rather than dist/core.js
- without a UMD wrapper, since it will always be loaded as a CJS
module.
    @cpcallen
    cpcallen committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    d6b019e View commit details
    Browse the repository at this point in the history

  7. chore(build): Remove disused packageCommonJS helper

    @cpcallen
    cpcallen committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    268f772 View commit details
    Browse the repository at this point in the history

  8. refactor(build): Use subpath pattern (wildcard) for msg/* exports 

    Use a subpath pattern (wildcard) for the msg/* entrypoints,
obviating the need for special handling in packageJSON.
    @cpcallen
    cpcallen committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    50be58b View commit details
    Browse the repository at this point in the history

  9. fix(tests): Fix node tests 

    run_node_test.js previously directly require()d the dist/blockly.js
and dist/javascript.js wrapper module, which no longer exist.

Change it to require('blockly-test') (and …blockly-test/javascript)
and create a symlink ./node_modules/blocky-test -> dist/ to satisfy
this.
    @cpcallen
    cpcallen committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    c72630d View commit details
    Browse the repository at this point in the history

  10. fix(build): Add types: and default: entries to exports['./core'] 

    In the 'blockly/core' export:

- Replace the browser: entrypoint with a default: one.
- Add a types: entrypoint for core.
    @cpcallen
    cpcallen committed Mar 13, 2024
    Configuration menu
    Copy the full SHA
    df2da72 View commit details
    Browse the repository at this point in the history