CesiumGS · sanjeetsuhag · Jul 19, 2022 · May 11, 2022 · May 11, 2022 · May 24, 2022
diff --git a/.gitignore b/.gitignore
@@ -23,29 +23,11 @@ Thumbs.db
 /Source/Workers/**
 !/Source/Workers/cesiumWorkerBootstrapper.js
 !/Source/Workers/transferTypedArrayTest.js
+!/Source/Workers/package.json
 
 Source/ThirdParty/_commonjsHelpers*
-Source/ThirdParty/Autolinker.js
-Source/ThirdParty/bitmap-sdf.js
-Source/ThirdParty/dompurify.js
-Source/ThirdParty/earcut.js
 Source/ThirdParty/draco_decoder.wasm
 Source/ThirdParty/Workers/draco_decoder_nodejs.js
-Source/ThirdParty/grapheme-splitter.js
-Source/ThirdParty/jsep.js
-Source/ThirdParty/kdbush.js
-Source/ThirdParty/ktx-parse.js
-Source/ThirdParty/lerc.js
-Source/ThirdParty/mersenne-twister.js
-Source/ThirdParty/meshoptimizer.js
-Source/ThirdParty/nosleep.js
-Source/ThirdParty/pako.js
-Source/ThirdParty/protobufjs.js
-Source/ThirdParty/rbush.js
-Source/ThirdParty/topojson.js
-Source/ThirdParty/Tween.js
-Source/ThirdParty/Uri.js
-Source/ThirdParty/zip.js
 Source/ThirdParty/Workers/pako_inflate.min.js
 Source/ThirdParty/Workers/pako_deflate.min.js
 Source/ThirdParty/Workers/z-worker-pako.js

diff --git a/.travis.yml b/.travis.yml
@@ -12,14 +12,14 @@ script:
   - npm --silent run markdownlint
   - npm --silent run prettier-check
 
-  - npm --silent run build
+  - npm --silent run build -- --node
+
   - npm --silent run coverage -- --browsers FirefoxHeadless --webgl-stub --failTaskOnError --suppressPassed
 
   - travis_wait 20 npm --silent run makeZipFile -- --concurrency 1
   - npm pack &> /dev/null
 
   - npm --silent run buildApps
-  - npm --silent run build-specs
 
   - npm --silent run deploy-s3 -- -b cesium-dev -d cesium/$TRAVIS_BRANCH --confirm -c 'no-cache'
   - npm --silent run deploy-status -- --status success --message Deployed
@@ -28,7 +28,7 @@ script:
 
   # Various Node.js smoke-screen tests
   - node -e "const Cesium = require('./');"
-  - NODE_ENV=development node index.cjs
-  - NODE_ENV=production node index.cjs
+  - NODE_ENV=development node Specs/test.cjs
+  - NODE_ENV=production node Specs/test.cjs
 
   - npm --silent run cloc
diff --git a/Apps/CesiumViewer/CesiumViewer.js b/Apps/CesiumViewer/CesiumViewer.js
@@ -1,4 +1,6 @@
-window.CESIUM_BASE_URL = "../../Source/";
+if (window.CESIUM_BASE_URL === undefined) {
+  window.CESIUM_BASE_URL = "../../Build/CesiumUnminified/";
+}
 
 import {
   Cartesian3,
@@ -16,7 +18,7 @@ import {
   Viewer,
   viewerCesiumInspectorMixin,
   viewerDragDropMixin,
-} from "../../Source/Cesium.js";
+} from "../../Build/CesiumUnminified/index.js";
 
 function main() {
   /*

diff --git a/Apps/CesiumViewer/index.js b/Apps/CesiumViewer/index.js
@@ -0,0 +1 @@
+window.CESIUM_BASE_URL = ".";
diff --git a/Apps/Sandcastle/load-cesium-es6.js b/Apps/Sandcastle/load-cesium-es6.js
@@ -1,7 +1,7 @@
 // This file loads the unbuilt ES6 version of Cesium
 // into the global scope during local developmnet
-window.CESIUM_BASE_URL = "../../../Source/";
-import * as Cesium from "../../Source/Cesium.js";
+window.CESIUM_BASE_URL = "../../../Build/CesiumUnminified/";
+import * as Cesium from "../../Build/CesiumUnminified/index.js";
 window.Cesium = Cesium;
 
 // Since ES6 modules have no guaranteed load order,

diff --git a/Apps/Sandcastle/standalone.html b/Apps/Sandcastle/standalone.html
@@ -11,11 +11,6 @@
     <script type="text/javascript" src="Sandcastle-header.js"></script>
     <script type="text/javascript" src="Sandcastle-client.js"></script>
     <script type="text/javascript" src="ThirdParty/pako.min.js"></script>
-    <script
-      type="text/javascript"
-      src="../../Build/CesiumUnminified/Cesium.js"
-      nomodule
-    ></script>
     <script type="module" src="load-cesium-es6.js"></script>
     <script type="text/javascript" src="Sandcastle-helpers.js"></script>
     <style>

diff --git a/Apps/Sandcastle/templates/bucket-requirejs.html b/Apps/Sandcastle/templates/bucket-requirejs.html
@@ -9,11 +9,6 @@
     />
     <title>Cesium Demo</title>
     <script type="text/javascript" src="../Sandcastle-header.js"></script>
-    <script
-      type="text/javascript"
-      src="../../../Build/CesiumUnminified/Cesium.js"
-      nomodule
-    ></script>
     <script type="module" src="../load-cesium-es6.js"></script>
   </head>
   <body

diff --git a/CHANGES.md b/CHANGES.md
@@ -5,6 +5,10 @@
 ##### Breaking Changes :mega:
 
 - Tilesets and entities now use `ModelExperimental` by default. This can still be changed by setting `ExperimentalFeatures.enableModelExperimental = false`. [#10530](https://github.com/CesiumGS/cesium/pull/10530)
+- Built `Cesium.js` is no longer AMD format. This may or may not be a breaking change depending on how you use Cesium in your app. See our [blog post](TODO) for the full details. [#10399](https://github.com/CesiumGS/cesium/pull/10399)
+  - If you were ingesting individual ESM-style modules from the combined file `Build/Cesium/Cesium.js` or `Build/CesiumUnminified/Cesium.js`, instead use `Build/Cesium/index.js` or `Build/CesiumUnminified/index.js` respectively.
+  - `CESIUM_BASE_URL` should be set to either `Build/Cesium` or `Build/CesiumUnminfied`.
+  - Built `Cesium.js` has gone from `12.5MB` to `8.4MB` unminified and from `4.3MB` to `3.6MB` minified. `Cesium.js.map` has gone from `22MB` to `17.2MB`.
 
 ##### Additions :tada:
 

diff --git a/Documentation/Contributors/BuildGuide/README.md b/Documentation/Contributors/BuildGuide/README.md
@@ -4,6 +4,8 @@
   - [Quickstart](#quickstart)
   - [Get the Code](#get-the-code)
   - [Build the Code](#build-the-code)
+    - [Development Server](#development-server)
+    - [Build Output](#build-output)
   - [Build Scripts](#build-scripts)
   - [Travis and Continuous Integration](#travis-and-continuous-integration)
     - [Configure a Different S3 Bucket](#configure-a-different-s3-bucket)
@@ -29,8 +31,6 @@
 
 4. Navigate to : [`http://localhost:8080/`](http://localhost:8080)
 
-_NOTE: If you change branches, you might have to rebuild._
-
 ---
 
 ## Get the Code
@@ -55,7 +55,7 @@ _NOTE: If you change branches, you might have to rebuild._
 
 Prerequisites:
 
-- Install [Node.js](http://nodejs.org/) on your system. Building Cesium requires Node 6.x or newer.
+- Install [Node.js](http://nodejs.org/) on your system. Building Cesium requires Node 14.x or newer.
 
 Cesium uses [npm modules](https://docs.npmjs.com/getting-started/what-is-npm) for development, so after syncing, you need to run `npm install` from the Cesium root directory:
 
@@ -69,6 +69,12 @@ Once all modules have been installed, run `npm run build` to actually build the
 npm run build
 ```
 
+Alternatively, if you want to edit source files and see the changes reflected for testing, use `npm run build-watch`.
+
+```bash
+npm run build-watch
+```
+
 Cesium ships with a simple HTTP server for testing, run `npm start` after building to use it:
 
 ```bash
@@ -82,12 +88,7 @@ Then browse to [http://localhost:8080/](http://localhost:8080/). The landing pag
 - **Test Suites** : tests using [Jasmine](https://jasmine.github.io/). [Testing guide here.](https://github.com/CesiumGS/cesium/blob/main/Documentation/Contributors/TestingGuide/README.md#testing-guide)
 - **Documentation** : reference documentation built from source. [Documentation guide here.](https://github.com/CesiumGS/cesium/blob/main/Documentation/Contributors/DocumentationGuide/README.md#documentation-guide)
 
-Cesium can be used in two different ways. Cesium can be either a set of modules using [Asynchronous Module Definition (AMD)](https://github.com/amdjs/amdjs-api/wiki/AMD), or it can be built as one combined file containing all modules. The basics:
-
-- `npm run build` will build AMD Cesium. This also builds Cesium Viewer and Sandcastle.
-- `npm run minifyRelease` creates the built version of Cesium. This also builds Hello World.
-
-Read the complete list of build scripts below for more details.
+### Development Server
 
 By default, the server only allows connections from your local machine. To allow connections from other machines, pass
 the `--public` option to npm. Note the extra `--` is intentional and required by npm.
@@ -96,12 +97,26 @@ the `--public` option to npm. Note the extra `--` is intentional and required by
 npm start -- --public
 ```
 
-The development server has a few other options as well, which you can see by pasing the `--help` parameter:
+The development server has a few other options as well, which you can see by passing the `--help` parameter:
 
 ```bash
 npm start -- --help
 ```
 
+### Build Output
+
+Cesium offers a few different distributions. When developing, make sure to pick the one that fits your app's architecture.
+
+- [IIFE (immediately-invoked function expression)](https://developer.mozilla.org/en-US/docs/Glossary/IIFE) - A pre-processed bundle and optimized for the browser, which defines a `Cesium` global variable upon loading `Build/Cesium/Cesium.js`. While much of our documentation uses IIFE-style globals for ease-of-use, we do not recommend this approach for production apps.
+- [ESM (ECMAScript modules)](https://nodejs.org/api/esm.html) - Standard for packaging JS code which is supported by most browsers and NodeJS. Modules use `import` and `export` statements. Unprocessed, individual modules are available in the `Source` directory, accessible by importing `Source/Cesium.js`; A single pre-processed bundle by importing `Build/Cesium/index.js`.
+- [CJS (CommonJS)](https://nodejs.org/api/modules.html) - A pre-processed, bundled module packaged for running in NodeJS accessible by requiring `index.cjs`.
+
+In much of our documentation, we use IIFE as it can be easily loaded with a CDN and defines a global _Cesium_ variable with all modules attached.
+
+For a production app, we recommend using the `Source` modules directly which will allow your build tool of choice to reduce the final release's size using tree shaking.
+
+Read the complete list of build scripts and options below for more details.
+
 While you can use the editor of your choice to develop Cesium, certain files, such as `glsl` and new tests, require that
 the `build` task be executed in order for the changes to take effect. You can use the `build-watch` script to have this
 happen automatically.
@@ -119,40 +134,43 @@ npm run [target-name]
 Here's the full set of scripts and what they do.
 
 - **Build scripts** -- build and package the source code and documentation
-  - `build` - A fast, developer-oriented build that prepares the source tree for use as standard [Asynchronous Module Definition (AMD)](https://github.com/amdjs/amdjs-api/wiki/AMD) modules, suitable for running tests and most examples (some Sandcastle examples require running `combine`). Run this when a GLSL shader is changed since the .glsl file is converted to a .js file with a string for the GLSL source. This runs automatically when saving files in Eclipse.
-  - `build-watch` - A never-ending task that watches your file system for changes to Cesium and runs `build` on the source code as needed.
-  - `combine` - Runs `build`, plus the [the RequireJS optimizer](http://requirejs.org/docs/optimization.html) to combine Cesium and [the Almond AMD loader](http://requirejs.org/docs/faq-optimization.html#wrap) to produce all-in-one files in the `Build/Cesium` directory that exposes the entire Cesium API attached to a single global `Cesium` object. This version is useful if you don't want to use the modules directly with a standard AMD loader.
-  - `minify` - Runs `combine`, plus [minifies](<http://en.wikipedia.org/wiki/Minification_(programming)>) Cesium.js.
-  - `combineRelease` - Runs `combine`, plus uses the optimizer to remove debugging code that validates function input and throws DeveloperErrors. The removed sections are marked with `//>>includeStart('debug', pragmas.debug);` blocks in the code.
-  - `minifyRelease` - Runs `minify`, and removes debugging code.
-  - `requirejs` - Used internally by the build system and can not be called directly.
-  - `buildApps` - Builds the example applications (such as Cesium Viewer) to produce self-contained, minified, deployable versions in the `Build` directory. This script requires a release build of Cesium, run the `release` script to build one if needed.
-  - `generateDocumentation` - Generates HTML documentation in `Build/Documentation` using [JSDoc 3](https://github.com/jsdoc3/jsdoc). More [details here](https://github.com/rahwang/cesium/tree/main/Documentation/Contributors/DocumentationGuide).
+  - `build` - A fast, developer-oriented build that bundles the source modules to produce all-in-one files in the `Build/CesiumUnminified` directory that exposes the entire Cesium API attached to a single global `Cesium` object. Run this when a GLSL shader is changed since the .glsl file is converted to a .js file with a string for the GLSL source.
+    - `--minify` - [Minifies](<http://en.wikipedia.org/wiki/Minification_(programming)>) the output for optimized loading. Specifying this option will output to `Build/Cesium`.
+    - `--removePragmas` - Optimizes the output by removing debugging code that validates function input and throws `DeveloperError`s. The removed sections are marked with `//>>includeStart('debug', pragmas.debug);` blocks in the code.
+    - `--node` - Bundles an `index.cjs` module targeted for use in NodeJS
+  - `build-watch` - A never-ending task that watches your file system for changes to Cesium and builds the source code as needed. All `build` options are also available for this task.
+  - `minify` - Bundles the source modules and [minifies](<http://en.wikipedia.org/wiki/Minification_(programming)>) to produce an all-in-one files in the `Build/Cesium` directory.
+  - `combineRelease` - Bundles plus removes debugging code that validates function input and throws DeveloperErrors. The removed sections are marked with `//>>includeStart('debug', pragmas.debug);` blocks in the code.
+  - `minifyRelease` - Bundles, minifies, and removes debugging code.
+  - `buildApps` - Builds the example applications (such as Cesium Viewer) to produce self-contained, minified, deployable versions in the `Build` directory.
+  - `generateDocumentation` - Generates HTML documentation in `Build/Documentation` using [JSDoc 3](https://github.com/jsdoc3/jsdoc). See the [Documentation Guide](../DocumentationGuide/README.md) for more details.
+  - `build-ts` - Generates a TypeScript definitions file for the Cesium library
+  - `build-third-party` - Generates `ThirdParty.json`, a file which lists the latest licensing information of installed third party modules
   - `release` - A full release build that creates a shippable product, including generating documentation.
-  - `makeZipFile` - Builds a zip file containing all release files. This includes the source tree (suitable for use from an AMD-aware application), plus the combined and minified Cesium.js files, the generated documentation, the test suite, and the example applications (in both built and source form).
+  - `makeZipFile` - Builds a zip file containing all release files. This includes the source ESM modules, bundled ESM and IIFE format `Cesium.js`, plus the bundled minified versions of ESM and IIFE, the generated documentation, the test suite, and the example applications (in both built and source form).
 - **Utility scripts** -- code coverage, static code analysis, and other utilities
-  - `coverage` - Runs coverage and opens the default browser with the results.
-  - `eslint` - Runs [ESLint](http://eslint.org/), a static code analysis tool, on the entire source tree.
-  - `eslint-watch` - A never-ending task that watches your file system for changes to Cesium and runs ESLint on any changed source files.
-  - `markdownlint` - Runs [markdownlint](https://github.com/DavidAnson/markdownlint) on the Markdown files used for documentation.
-  - `clean` - Removes all generated build artifacts.
+  - `clean` - Removes all generated build artifacts
   - `cloc` - Runs [CLOC](https://github.com/AlDanial/cloc) to count the lines of code on the Source and Specs directories. This requires [Perl](http://www.perl.org/) to execute.
+  - `coverage` - Runs coverage and opens the default browser with the results
+  - `eslint` - Runs [ESLint](http://eslint.org/), a static code analysis tool, on the entire source tree
+  - `prettier` - Formats the code base using [Prettier](https://prettier.io/)
+  - `prettier-check` - Verifies prettier formatting, but does not write the output
 - **Testing scripts** -- build and run the unit tests
   - `test` - Runs all tests with [Karma](http://karma-runner.github.io/0.13/index.html) using the default browser specified in the Karma config file.
-  - `test-all` - Runs all tests with Karma using all browsers installed on the current system.
-  - `test-non-webgl` - Runs only non-WebGL tests.
-  - `test-webgl` - Runs only WebGL tests.
-  - `test-webgl-stub` - Runs all tests using the WebGL stub, which WebGL calls a noop and ignores related test expectations.
-  - `test-webgl-validation` - Runs all tests with Karma and enables low-level WebGL validation.
-  - `test-release` - Runs all tests on the minified release version of built Cesium.
+  - `test-all` - Runs all tests with Karma using all browsers installed on the current system
+  - `test-non-webgl` - Runs only non-WebGL tests
+  - `test-webgl` - Runs only WebGL tests
+  - `test-webgl-stub` - Runs all tests using the WebGL stub, which WebGL calls a noop and ignores related test expectations
+  - `test-webgl-validation` - Runs all tests with Karma and enables low-level WebGL validation
+  - `test-release` - Runs all tests on the minified release version of built Cesium
 - **Deployment scripts**
-  - `deploy-s3` - Deploys the built CesiumJS files, the npm package, and the zip file to Amazon S3. This requires having credentials set up for the S3 bucket to which you are deploying.
-  - `deploy-status` - Set the deployment statuses in GitHub, for use with Travis.
-  - `deploy-set-version` - Sets the version of `package.json`, for use with Travis.
+  - `deploy-s3` - Deploys the built CesiumJS files, the npm package, and the zip file to Amazon S3. This requires having credentials set up for the S3 bucket to which you are deploying
+  - `deploy-status` - Sets the deployment statuses in GitHub, for use with Travis
+  - `deploy-set-version` - Sets the version of `package.json`, for use with Travis
 
 ## Travis and Continuous Integration
 
-Cesium uses [Travis](https://travis-ci.com/) for continuous integration. The Travis configuration and all the steps of the build process are defined in `travis.yml`. The blog post [Cesium Continuous Integration](http://cesium.com/blog/2016/04/07/Cesium-Continuous-Integration/) contains an in-depth explaination of the travis build process.
+Cesium uses [Travis](https://travis-ci.com/) for continuous integration. The Travis configuration and all the steps of the build process are defined in `travis.yml`. The blog post [Cesium Continuous Integration](http://cesium.com/blog/2016/04/07/Cesium-Continuous-Integration/) contains an in-depth explanation of the travis build process.
 
 Travis triggers a build whenever someone opens a pull request or pushes code to the Cesium repository. After the build has completed, at the bottom on the pull request, the status of the build is shown and you can access the build by clicking the "Details" link.
 
@@ -200,7 +218,7 @@ To configure the additional commit statuses on GitHub for your fork of Cesium, y
 
 - In GitHub, go to "Settings" and "Personal access tokens"
 - Click "Generate new token" and confirm your password when prompted
-- Give a breif description of the token such as "Travis Statuses" and select "repo:status" and click "Generate token"
+- Give a brief description of the token such as "Travis Statuses" and select "repo:status" and click "Generate token"
   - `repo:status` gives the token access to only commit statuses
 
 ![Token Access](token.jpg)