Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 28 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Test

on:
pull_request:
branches: [main]

jobs:
test:
runs-on: ubuntu-latest

strategy:
matrix:
node-version: [20.x, 22.x, 24.x]

steps:
- uses: actions/checkout@v4

- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'

- name: Install dependencies
run: npm ci

- name: Run tests
run: npm test
6 changes: 0 additions & 6 deletions .travis.yml

This file was deleted.

8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,14 @@ When submitting code, please keep commits small, and do not modify the README fi

# Changelog

### 0.10.2
* Dependencies: Update Chokidar, opts, and WS to latest versions.
* CLI: Fix `--corp` flag not working as intended
* CLI: Fix `--cors` flag no longer sets CORP header.
* CLI: Fix `--originalpath` flag sets proper value.
* CLI: Fix some typos in CLI help
* Add tests for CLI arguments and reworked CLI code to allow for testing.

### 0.10.1
* Fix errant debug message in CLI

Expand Down
97 changes: 70 additions & 27 deletions lib/command.coffee
Original file line number Diff line number Diff line change
@@ -1,9 +1,30 @@
pjson = require('../package.json')
livereload = require './livereload'
resolve = require('path').resolve

runner = ->
pjson = require('../package.json')
version = pjson.version
livereload = require './livereload'
resolve = require('path').resolve
opts = require 'opts'
res = parseArgsAndCreateServer(true)
server = res.server
path = res.path

console.log "Starting LiveReload v#{pjson.version} for #{path} on #{server.host}:#{server.port}."

server.on 'error', (err) ->

if err.code == "EADDRINUSE"
console.log("The port LiveReload wants to use is used by something else.")
else
throw err

process.exit(1)

server.watch(path)

# Parse the arguments and create the server.
# shouldListen option exists so we can start the server under CLI, but not when
# we use this from the entrypoint for tests
parseArgsAndCreateServer = (shouldListen = true) ->
opts = require 'opts'

args = [
{
Expand All @@ -19,7 +40,7 @@ runner = ->
description: "Show the version"
required: false
callback: ->
console.log version
console.log pjson.version
process.exit(1)
}
{
Expand Down Expand Up @@ -52,7 +73,7 @@ runner = ->
{
short: "e"
long: "exts",
description: "A comma-separated list of extensions that should trigger a reload when changed. Replaces default extentions",
description: "A comma-separated list of extensions that should trigger a reload when changed. Replaces default extensions",
required: false,
value: true
}
Expand Down Expand Up @@ -86,43 +107,43 @@ runner = ->
{
short: "op"
long: "originalpath",
description: "Set a URL you use for development, e.g 'http:/domain.com', then LiveReload will proxy this url to local path."
description: "Set a URL you use for development, e.g 'http://domain.com', then LiveReload will proxy this url to local path."
required: false,
value: true
}
{
short: "cp"
long: "corp"
description: "Enable CORP Header with cross-origin",
require: false
required: false
}
{
short: "cs"
long: "cors"
description: "Enable CORS Header for all or specific origins",
require: false,
required: false,
value: true
}
]

opts.parse(options.reverse(), args, true)
opts.parse(options.reverse(), args, true)

path = (opts.arg('path') || '.')
.split(/\s*,\s*/)
.map((x)->resolve(x))

debug = opts.get('debug') || false
port = opts.get('port') || 35729
port = parseInt(opts.get('port')) || 35729
host = opts.get('bind') || 'localhost'
exclusions = if opts.get('exclusions') then opts.get('exclusions' ).split(',' ).map((s) -> new RegExp(s)) else []
exts = if opts.get('exts') then opts.get('exts').split(',').map((ext) -> ext.trim()) else []
extraExts = if opts.get('extraExts') then opts.get('extraExts').split(',').map((ext) -> ext.trim()) else []
filesToReload = if opts.get('filesToReload') then opts.get('filesToReload').split(',').map((file) -> file.trim()) else []
exclusions = if opts.get('exclusions') then opts.get('exclusions').split(',').map((s) -> new RegExp(s)) else []
exts = if opts.get('exts') then opts.get('exts').split(',').map((ext) -> ext.trim()) else []
extraExts = if opts.get('extraExts') then opts.get('extraExts').split(',').map((ext) -> ext.trim()) else []
filesToReload = if opts.get('filesToReload') then opts.get('filesToReload').split(',').map((file) -> file.trim()) else []
usePolling = opts.get('usepolling') || false
wait = opts.get('wait') || 0
originalPath = opts.get('originalPath') || ''
wait = parseInt(opts.get('wait')) || 0
originalPath = opts.get('originalpath') || ''
cors = opts.get('cors') || false
corp = opts.get('cors') || false
corp = opts.get('corp') || false

server = livereload.createServer({
port: port
Expand All @@ -137,18 +158,40 @@ runner = ->
originalPath: originalPath
cors: cors
corp: corp
noListen: not shouldListen
})

console.log "Starting LiveReload v#{version} for #{path} on #{host}:#{port}."

server.on 'error', (err) ->
if err.code == "EADDRINUSE"
console.log("The port LiveReload wants to use is used by something else.")
else
throw err
process.exit(1)
{
server: server
path: path
}

server.watch(path)

# This is the entrypoint that tests use to verify our option parsing.
# It doesn't start the server.
# The opts library directly parses process.argv. That means
# when we run tests with Mocha it gets the Mocha args, not our args.
# So this is hacky indirection that lets us send our own args
# from the tests and still run them through the same parsing function
# the CLI uses.
createServerFromArgs = (testArgv) ->
# Save original process.argv and parse with test arguments
originalArgv = process.argv

# replace the args with our test args
process.argv = ['node', 'test'].concat(testArgv)

# Reset opts internal state by requiring a fresh instance
delete require.cache[require.resolve('opts')]

try
result = parseArgsAndCreateServer(false) # false = don't listen, for testing
return result
finally
# Always restore original process.argv
process.argv = originalArgv

module.exports =
run: runner
createServerFromArgs: createServerFromArgs
96 changes: 69 additions & 27 deletions lib/command.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading