3 | 
5 | [](https://www.npmjs.com/package/nuxt-generate-cluster)
6 | [](https://www.npmjs.com/package/nuxt-generate-cluster)
7 | 
8 |
9 | > Use multiple workers to generate the static files for your Nuxt.js project
10 |
11 | ## Setup
12 |
13 | Install the package
14 | ```
15 | yarn add nuxt-generate-cluster
16 | ```
17 |
18 | Add a generate script to your `package.json`
19 | ```js
20 | "scripts": {
21 | "generate": "nuxt-generate -w 4"
22 | }
23 | ```
24 |
25 | ## Nuxt config options
26 |
27 | Configure the generate options in `nuxt.config.js`
28 | ```js
29 | generate: {
30 | workers: 4,
31 | workerConcurrency: 500,
32 | concurrency: 500,
33 | routes (callback, params) {
34 | return axios.get('https://api.example.com/routes?since=' + params.lastFinished)
35 | .then((res) => {
36 | return res.data
37 | })
38 | },
39 | done ({ duration, errors, workerInfo }) {
40 | if (errors.length) {
41 | axios.post('https://api.example.com/routes', { generate_errors: errors })
42 | }
43 | }
44 | }
45 | ```
46 |
47 | ### `workers`
48 | - Default: number of processors
49 |
50 | The number of workers that should be started. It probably has no use to start more workers then number of processors in your system.
51 |
52 | ### `workerConcurrency`
53 | - Default: `500`
54 |
55 | To even the load between workers they are sent batches of routes to generate, otherwise a worker with 'easy' routes might finish long before others. Workers will also still use the concurrency option from Nuxt.
56 |
57 | ### `routes`
58 |
59 | The default [Nuxt.js routes method](https://nuxtjs.org/api/configuration-generate#routes) has been extended so you can pass additional parameters to it, see params parameter in example config under Setup. By default
60 | it will list 3 timestamps:
61 |
62 | - `lastStarted`
63 | The unix timestamp when the nuxt-generate command was last executed, should be just now
64 |
65 | - `lastBuilt`
66 | The unix timestamp when the nuxt project was last built by nuxt-generate
67 |
68 | - `lastFinished`
69 | The unix timestamp when nuxt-generate last finished succesfully (eg not interrupted by `ctrl+c`)
70 |
71 | > Timestamps are locally stored in `~/.data-store/nuxt-generate-cluster.json`, see [data-store](https://github.com/jonschlinkert/data-store)
72 |
73 | ### `beforeWorkers`
74 |
75 | This method is called on the master just before the workers are started/forked. It receives the Nuxt options as first argument.
76 |
77 | Use this method if you experience serialization issues or when your Nuxt config is too big. The Nuxt options are stringified and then passed as environment variable to the workers, on Windows there seems to be a maximum size of 32KB for env variables.
78 |
79 | Properties which should be safe to remove are (not a complete list):
80 | - buildModules (and their options)
81 | - serverMiddleware
82 |
83 | ### `done`
84 |
85 | This method will be called when all workers are finished, it receives two arguments:
86 |
87 | - The first argument is an object with statistics:
88 | - `duration`
89 | The total time in seconds that the command ran
90 |
91 | - `errors`
92 | An array of all the errors that were encountered. Errors can have type `handled` or `unhandled`, for the latter the error message will contain the stacktrace
93 |
94 | ```js
95 | [ { type: 'handled',
96 | route: '/non-existing-link',
97 | error:
98 | { statusCode: 404,
99 | message: 'The message from your 404 page' } }
100 | ]
101 | ```
102 |
103 | - `workerInfo`
104 | An object with detailed information about each worker. Data passed is from the watchdog object that we use internally to monitor the worker status.
105 |
106 | ```js
107 | {{ '6707': // the process id of the worker
108 | { start: [ 1929158, 859524606 ], // process.hrtime the worker was started
109 | duration: 109567, // how long the worker was active
110 | signal: 0, // the signal by which the worker was killed (if any)
111 | code: 0, // the exit status of the worker
112 | routes: 73, // the number of routes generated by this worker
113 | errors: [] }, // the errors this worker encountered, errors of all workers
114 | // combined is the error argument above
115 | }
116 | ```
117 |
118 | - The second argument is the Nuxt instance
119 |
120 | ## Command-line options
121 |
122 | > Please note that you need to explicitly indicate with `-b` that you want to (re-)build your project
123 |
124 | ```
125 | $ ./node_modules/.bin/nuxt-generate -h
126 |
127 | Multi-threaded generate for nuxt using cluster
128 |
129 | Description
130 | Generate a static web application (server-rendered)
131 | Usage
132 | $ nuxt-generate {{ name }}
3 | 4 | 5 | 14 | -------------------------------------------------------------------------------- /test/fixtures/basic/pages/await-async-data.vue: -------------------------------------------------------------------------------- 1 | 2 |{{ name }}
3 | 4 | 5 | 19 | -------------------------------------------------------------------------------- /test/fixtures/basic/pages/callback-async-data.vue: -------------------------------------------------------------------------------- 1 | 2 |{{ name }}
3 | 4 | 5 | 14 | -------------------------------------------------------------------------------- /test/fixtures/basic/pages/config.vue: -------------------------------------------------------------------------------- 1 | 2 |{{ $store.state.meta }}
3 |
4 |
5 |
13 |
--------------------------------------------------------------------------------
/test/fixtures/basic/pages/no-ssr.vue:
--------------------------------------------------------------------------------
1 |
2 | {{ loaded }}
5 |The answer is {{ answer }}
4 |{{ $store.state.counter }}
6 |The answer is 42
Nuxt.js
') 145 | }) 146 | 147 | test('/тест雨 (test non ascii route)', async () => { 148 | const window = await generator.nuxt.server.renderAndGetWindow(url('/тест雨')) 149 | const html = window.document.body.innerHTML 150 | expect(html).toContain('Hello unicode') 151 | }) 152 | 153 | test('/users/1/index.html', async () => { 154 | const html = await rp(url('/users/1/index.html')) 155 | expect(html).toContain('The answer is 42
Nuxt.js
') 144 | }) 145 | 146 | test('/тест雨 (test non ascii route)', async () => { 147 | const window = await generator.nuxt.server.renderAndGetWindow(url('/тест雨')) 148 | const html = window.document.body.innerHTML 149 | expect(html).toContain('Hello unicode') 150 | }) 151 | 152 | test('/users/1/index.html', async () => { 153 | const html = await rp(url('/users/1/index.html')) 154 | expect(html).toContain('