https://github.com/zodern/comet
Meteor fork to experiment with HMR, faster rebuilds, and other changes
https://github.com/zodern/comet
Last synced: about 1 year ago
JSON representation
Meteor fork to experiment with HMR, faster rebuilds, and other changes
- Host: GitHub
- URL: https://github.com/zodern/comet
- Owner: zodern
- License: other
- Created: 2020-05-07T23:07:34.000Z (about 6 years ago)
- Default Branch: devel
- Last Pushed: 2022-02-10T20:19:01.000Z (over 4 years ago)
- Last Synced: 2024-10-19T15:15:30.328Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 68.9 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Comet
Fork of Meteor to experiment with changes to the meteor-tool. This should not be used for production builds.
Based off of Meteor 1.10.
### Build optimizations
There have been many improvements in the build process, focused on reducing the performance difference between Windows and Linux and reducing the number of times files are accessed. Compared to Meteor 1.10, on Windows these optimizations add up to:
- Initial build completes in 50% less time
- Full rebuilds complete in 40% less time
- CPU usage while not building is 60% lower
- Memory usage after first full rebuild is 40% lower
### Hot Module Reload
As an alternative to Hot Code Push in development, Hot Module Reload replaces modules in the bundle that were modified without reloading the page.
Use:
1. Clone comet
2. Run your app with:
```
# Windows
/path/to/comet/meteor.bat --extra-packages hot-module-reload
# osx or linux
../path/to/comet/meteor --extra-packages hot-module-reload
```
#### API
`module.hot.accept()` - The module will be rerun whenever it or any of its dependencies are modified
`module.hot.decline()` - If the module or any of its dependencies are modified, hot code push will be used instead of HMR.
`module.hot.dispose((data) => {})` - Adds a callback to run before the module is replaced. Any state that should be preserved can be stored in `data`. It will be available when the module is rerun at `module.hot.data`.
`module.hot.data` - If the module was reloaded, will have any data set by dispose handlers. If the file was not reloaded, or there were no dispose handlers, it will be `null`.
These should be wrapped by
```
if (module.hot) {
// Use module.hot here
}
```
Minifiers are able to remove the if statement for production, though none of the common minifiers for Meteor currently do.
#### Implementation details
For now, the linker emits an event that packages, such as `hot-module-reload`, can listen to for an up to date list of files in an unibuild. Eventually this will be replaced with moving the HMR code from a build plugin into the meteor-tool.
The `hot-module-reload` package compares the list of files between builds to identify what has changed. When a client tries to do a hot code push, the client will request changes over a websocket from the build plugin. If possible, it will use HMR to update the modules. Otherwise, it will let the page be reloaded using hot code push.
The client uses a modified version of [install](https://www.npmjs.com/package/install) to allow replacing modules.
#### Remaining tasks
This is an early version, and there is still a long list of items to implement. A partial list is:
- The linker cache is disabled in some situations for the web.browser architecture since bundles are compared as part of the linking process. We will need to instead store the necessary information in the linker cache, and allow prelinking only the parts that were modified.
- Support full webpack HMR API
- Look into allowing packages to replace the HMR api to allow experimentation
- Look into an api to allow packages to run code before and after each module is run. This could be used to implement react fast reload and for packages to automatically clean up after a file is modified. For example, this could be used to remove methods and publications previously added by a modified file.
- Better integration with the autoupdate and reload packages
- Require secret from client before sending changes over websocket
- Submit PRs for reify and install to add necessary apis and functionality for HMR
- Many other items are documented in the code with TODO comments
HMR is only enabled for the `web.browser` architectures. These architectures are remaining:
- web.browser.legacy
- web.cordova
- server architectures
HMR is not supported in these situations. Hot code push will be used instead:
- A package is modified
- A file is removed
- Files were modified that do not have a module id, are bare, are json data, or do not have meteorInstallOptions
# 
[](https://travis-ci.org/meteor/meteor)
[](https://circleci.com/gh/meteor/meteor/tree/devel)
Meteor is an ultra-simple environment for building modern web
applications.
With Meteor you write apps:
* in modern JavaScript
* that send data over the wire, rather than HTML
* using your choice of popular open-source libraries
Try a getting started tutorial:
* [React](https://www.meteor.com/tutorials/react/creating-an-app)
* [Blaze](https://www.meteor.com/tutorials/blaze/creating-an-app)
* [Angular](https://www.meteor.com/tutorials/angular/creating-an-app)
* [Vue](https://www.meteor.com/tutorials/vue/creating-an-app)
Next, read the [guide](https://guide.meteor.com) and the [documentation](https://docs.meteor.com/).
## Quick Start
On Windows, the installer can be found at https://www.meteor.com/install.
On Linux/macOS, use this line:
```bash
curl https://install.meteor.com/ | sh
```
Create a project:
```bash
meteor create try-meteor
```
Run it:
```bash
cd try-meteor
meteor
```
## Developer Resources
Building an application with Meteor?
* Deploy on Galaxy hosting: https://www.meteor.com/hosting
* Announcement list: sign up at https://www.meteor.com/
* Having problems? Ask for help at: https://stackoverflow.com/questions/tagged/meteor
* Discussion forums: https://forums.meteor.com/
* Join the Meteor community Slack by clicking this [invite link](https://join.slack.com/t/meteor-community/shared_invite/enQtODA0NTU2Nzk5MTA3LWY5NGMxMWRjZDgzYWMyMTEyYTQ3MTcwZmU2YjM5MTY3MjJkZjQ0NWRjOGZlYmIxZjFlYTA5Mjg4OTk3ODRiOTc).
Interested in helping or contributing to Meteor? These resources will help:
* [Core development guide](DEVELOPMENT.md)
* [Contribution guidelines](CONTRIBUTING.md)
* [Feature requests](https://github.com/meteor/meteor-feature-requests/)
* [Issue tracker](https://github.com/meteor/meteor/issues)
## Uninstalling Meteor
Aside from a short launcher shell script, Meteor installs itself inside your
home directory. To uninstall Meteor, run:
```bash
rm -rf ~/.meteor/
sudo rm /usr/local/bin/meteor
```
On Windows, just run the uninstaller from your Control Panel.