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

add LNG_LIVE_RELOAD_HOST environment variable #203

Merged
merged 3 commits into from
Sep 21, 2022
Merged

add LNG_LIVE_RELOAD_HOST environment variable #203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
727ffaf
Merge pull request #199 from rdkcentral/dev
michielvandergeest Aug 22, 2022
edb86fe
feat(build/LIVE_RELOAD): add LNG_LIVE_RELOAD_HOST env variable to all…
cidevant Sep 20, 2022
bb88c98
chore(doc): update docs for LNG_LIVE_RELOAD_HOST
cidevant Sep 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/environmentvariables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,9 @@ You can use the following environment variables to customize the behavior of the
| `LNG_BUILD_FAIL_ON_WARNINGS` | false | Specifies whether or not to show the warning to the user when a build warning occurs. Note that the build process is triggered in several commands (`lng build`, `lng dev`, `lng watch` and `lng dist`) |
| `LNG_BUNDLER` | rollup | Specify which bundler the CLI should use to bundle the app. Possible values: `rollup`, `esbuild`. |
| `LNG_BROWSER_BUILD` | false | Specify whether or not browser build is to be generated. Possible values: `true`, `false`. |
| `LNG_LIVE_RELOAD` | false | Instructs your browser to reload the location when a new app bundle is created (using `lng dev`). When the watcher resolves, `document.location.reload()` is called in the browser (tab) that serves your app. Possible value:  `true`, `false`. |
| `LNG_LIVE_RELOAD_PORT` | 8888 | Specifies the port Websocket is listening on. Live reload communication is driven by WebSockets. Possible values: Any numeric value. |
| `LNG_LIVE_RELOAD` | false | Instructs your browser to reload the location when a new app bundle is created (using `lng dev`). When the watcher resolves, `document.location.reload()` is called in the browser (tab) that serves your app. Live reload communication is driven by WebSockets. Possible value:  `true`, `false`. |
| `LNG_LIVE_RELOAD_HOST` | localhost | Specifies the Websocket host your application will attempt to connect to listen for livereload events. Possible values: ip or host. |
| `LNG_LIVE_RELOAD_PORT` | 8991 | Specifies the port Websocket is listening on. Possible values: Any numeric value. |


#### `LNG_SETTINGS_ENV`
Expand Down
5 changes: 3 additions & 2 deletions src/helpers/build.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,15 @@ const copySupportFiles = folder => {
// if live reload is enabled we write the client WebSocket logic
// to index.html
if (process.env.LNG_LIVE_RELOAD === 'true' && command === 'dev') {
const host = process.env.LNG_LIVE_RELOAD_HOST || 'localhost'
const port = process.env.LNG_LIVE_RELOAD_PORT || 8991
const file = path.join(folder, 'index.html')
const data = fs.readFileSync(file, { encoding: 'utf8' })
const wsData = `
<script>
var socket = new WebSocket('ws://localhost:${port}');
var socket = new WebSocket('ws://${host}:${port}');
socket.addEventListener('open', function() {
console.log('WebSocket connection succesfully opened - live reload enabled');
console.log('WebSocket connection successfully opened - live reload enabled');
});
socket.addEventListener('close', function() {
console.log('WebSocket connection closed - live reload disabled');
Expand Down