misc: add user-defined chokidar files to watch (2) #3633

galvez · 2018-08-05T20:30:04Z

@Atinux @clarkdo This is me picking up on this PR, which seems abandoned. I've refactored CLI tests a bit and added a nuxt dev test to make sure the custom chokidar watchers were working.

cc @SabatinoMasala

…ined-chokidar

codecov-io · 2018-08-05T21:39:27Z

Codecov Report

Merging #3633 into dev will decrease coverage by 0.25%.
The diff coverage is 66.66%.

@@            Coverage Diff            @@
##             dev    #3633      +/-   ##
=========================================
- Coverage   99.2%   98.94%   -0.26%     
=========================================
  Files         18       18              
  Lines       1125     1134       +9     
  Branches     303      304       +1     
=========================================
+ Hits        1116     1122       +6     
- Misses         9       12       +3

Impacted Files	Coverage Δ
lib/common/nuxt.config.js	`100% <ø> (ø)`	⬆️
lib/builder/builder.js	`98.42% <66.66%> (-1.58%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7349add...0c2c754. Read the comment docs.

Atinux

Small changes required, but otherwise, amazing work!

Atinux · 2018-08-08T13:39:30Z

lib/builder/builder.js

@@ -622,6 +623,15 @@ export default class Builder {
    this.customFilesWatcher = chokidar
      .watch(customPatterns, options)
      .on('change', refreshFiles)
+
+    // Watch for nuxt.config.js and user-defined changes
+    const nuxtConfigPatterns = _.concat(


I don't think that nuxtConfigPatterns is the right name, maybe something like nuxtRestartWatch

Atinux · 2018-08-08T13:40:04Z

lib/builder/builder.js

@@ -633,6 +643,10 @@ export default class Builder {
      this.customFilesWatcher.close()
    }

+    if (this.nuxtConfigWatcher) {
+      this.nuxtConfigWatcher.close()


Same here, nuxtRestartWatcher is more understandable

Atinux · 2018-08-08T13:41:27Z

lib/common/options.js

@@ -195,5 +195,8 @@ Options.from = function (_options) {
  options.build.transpile = [].concat(options.build.transpile || [])
    .map(module => module instanceof RegExp ? module : new RegExp(module))

+  // User-defined changes
+  options.watch = []


I think this should move to https://github.com/nuxt/nuxt.js/blob/dev/lib/common/nuxt.config.js (I will use this file in the docs to display all configurations)

clarkdo · 2018-08-08T13:49:22Z

lib/builder/builder.js

@@ -633,6 +643,10 @@ export default class Builder {
      this.customFilesWatcher.close()
    }

+    if (this.nuxtConfigWatcher) {


Can't we reuse customPatterns, is there any special reason for a separated watcher ?

clarkdo · 2018-08-08T13:51:21Z

lib/builder/builder.js

+    )
+    this.nuxtConfigWatcher = chokidar
+      .watch(nuxtConfigPatterns, options)
+      .on('change', refreshFiles)


If the purpose is to restart the server, can refreshFiles work here ?

Woops, good watch, no we need to sent an event from nuxt internal that nuxt-dev will listen to kill Nuxt and restart it

…o user-defined-chokidar

clarkdo · 2018-08-08T15:44:22Z

bin/nuxt-dev

@@ -128,6 +110,15 @@ function startDev(oldInstance) {
        if (oldInstance) {
          return nuxt.listen(port, host)
        } else {
+          nuxt.hook('watcher:restart', () => {


If we move the hook out of startDev and under the startDev(), will it work ?

And also watcher:restart should have a more proper name which describe the hook scenario (not restart, restart is just one hook purpose, this hook can be used for any purpose)

This was missing in #3633.

simonbrunel · 2018-08-11T20:03:58Z

lib/builder/builder.js

+    )
+    this.nuxtRestartWatcher = chokidar
+      .watch(nuxtRestartWatch, options)
+      .on('change', (event, _path) => {


@galvez npm run dev is crashing with the following error every time nuxt.config.js is modified:

path.js:39 throw new ERR_INVALID_ARG_TYPE('path', 'string', path); ^ TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received type object at assertPath (path.js:39:11) at Object.parse (path.js:910:5) at FSWatcher.watchers.restart.chokidar.watch.on (E:\Repositories\website\node_modules\nuxt-edge\dist\nuxt.js:3868:42) at FSWatcher.emit (events.js:182:13) at FSWatcher.EventEmitter.emit (domain.js:442:20) at FSWatcher.<anonymous> (E:\Repositories\website\node_modules\chokidar\index.js:199:15) at FSWatcher._emit (E:\Repositories\website\node_modules\chokidar\index.js:241:5) at FSWatcher.<anonymous> (E:\Repositories\website\node_modules\chokidar\lib\nodefs-handler.js:267:16) at FSReqWrap.oncomplete (fs.js:159:5)

According the chokidar docs, the first argument should be the path and the second one the stats:

// 'add', 'addDir' and 'change' events also receive stat() results as second // argument when available: http://nodejs.org/api/fs.html#fs_class_fs_stats watcher.on('change', (path, stats) => { if (stats) console.log(`File ${path} changed size to ${stats.size}`); });

@simonbrunel thanks for reporting! will fix ASAP :)

@simonbrunel we just merged a fix for this, thanks again.

@clarkdo

@clarkdo need to merge this asap -- related to #3633 (comment)

lock · 2018-10-31T21:39:43Z

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

SabatinoMasala and others added 24 commits May 11, 2018 12:19

misc: add user-defined chokidar files to watch

538dc35

Merge branch 'dev' of github.com:SabatinoMasala/nuxt.js into user-def…

231979a

…ined-chokidar

Improved user-defined chokidar files setup

b58ca3b

Improved user-defined chokidar files setup (2)

5955379

Added custom file for CLI watch test

45218e3

Added cli.dev.test.js

814d0e1

Added cli.dev.test.js (2)

9c2a0ef

Remove cli-start/cli.dev, just use cli.test

b357a6e

Refactored CLI test

b879e93

Missing dot in fname

f692abc

Improved user-defined chokidar files setup (3)

96977f5

Fix killNuxt()

250ac59

Remove genHandlers

dc78699

Refactored CLI test (2)

93d373c

Refactor exitCode

bd32074

Remove debugging code

ad0e2e5

Remove debugging code (2)

bdbfe11

Linting

727bc79

Linting (2)

b4658ec

Disable nuxt-start test for now

d10085c

Disable nuxt-start test for now (2)

28d1bd1

Tweaking nuxt-start test

ca9e5ba

Tweaking nuxt-start test (2)

a639076

Tweaking nuxt-start test (3)

23090c3

galvez mentioned this pull request Aug 5, 2018

misc: add user-defined chokidar files to watch #3328

Closed

galvez added 4 commits August 5, 2018 19:09

Fix ext

bf07f53

Tweaked wait params

aa4d97a

Merge latest dev

6c97a43

Fix conflicts

0a87ac0

galvez and others added 6 commits August 7, 2018 23:40

Fixed nuxt-dev test

4092e40

Debugging nuxt-dev test

a7da8b0

Debugging nuxt-dev test (2)

349bd0b

Skip in appveyor

817f7ef

Linting

c5c5a30

Merge branch 'dev' into user-defined-chokidar

7759eed

Atinux requested changes Aug 8, 2018

View reviewed changes

clarkdo reviewed Aug 8, 2018

View reviewed changes

galvez added 4 commits August 8, 2018 11:00

Requested changes

36843cf

Merge branch 'user-defined-chokidar' of github.com:galvez/nuxt.js int…

bb183cc

…o user-defined-chokidar

Hook into nuxt-dev

483982f

Hook into nuxt-dev (2)

bc1476d

Atinux approved these changes Aug 8, 2018

View reviewed changes

clarkdo reviewed Aug 8, 2018

View reviewed changes

galvez added 6 commits August 8, 2018 14:25

Get fname

b3d3a71

Get fname (2)

ecd4372

Get fname (3)

4c29280

Change hook name

1a1d725

Fixed conflicts

82160ba

Fixed conflict

0c2c754

clarkdo merged commit a522aaf into nuxt:dev Aug 8, 2018

galvez mentioned this pull request Aug 10, 2018

Relative path in custom watchers #3673

Merged

clarkdo pushed a commit that referenced this pull request Aug 10, 2018

Relative path in custom watchers (#3673)

1842a3b

This was missing in #3633.

simonbrunel reviewed Aug 11, 2018

View reviewed changes

galvez mentioned this pull request Aug 11, 2018

Fix chokidar on() handler #3694

Merged

clarkdo pushed a commit that referenced this pull request Aug 11, 2018

Fix chokidar on() handler (#3694)

ec52104

@clarkdo need to merge this asap -- related to #3633 (comment)

lock bot locked as resolved and limited conversation to collaborators Oct 31, 2018

danielroe added the 2.x label Jan 18, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

misc: add user-defined chokidar files to watch (2) #3633

misc: add user-defined chokidar files to watch (2) #3633

galvez commented Aug 5, 2018 •

edited

codecov-io commented Aug 5, 2018 •

edited

Atinux left a comment

Atinux Aug 8, 2018

Atinux Aug 8, 2018

Atinux Aug 8, 2018

clarkdo Aug 8, 2018

clarkdo Aug 8, 2018

Atinux Aug 8, 2018

clarkdo Aug 8, 2018 •

edited

simonbrunel Aug 11, 2018

galvez Aug 11, 2018

galvez Aug 11, 2018

simonbrunel Aug 11, 2018

lock bot commented Oct 31, 2018

misc: add user-defined chokidar files to watch (2) #3633

misc: add user-defined chokidar files to watch (2) #3633

Conversation

galvez commented Aug 5, 2018 • edited

codecov-io commented Aug 5, 2018 • edited

Codecov Report

Atinux left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

clarkdo Aug 8, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lock bot commented Oct 31, 2018

galvez commented Aug 5, 2018 •

edited

codecov-io commented Aug 5, 2018 •

edited

clarkdo Aug 8, 2018 •

edited