| 
									
										
										
										
											2022-07-17 03:47:27 +00:00
										 |  |  | --- | 
					
						
							|  |  |  | sidebar_position: 9 | 
					
						
							|  |  |  | title: Bundlers | 
					
						
							|  |  |  | --- | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | import current from '/version.js'; | 
					
						
							|  |  |  | import Tabs from '@theme/Tabs'; | 
					
						
							|  |  |  | import TabItem from '@theme/TabItem'; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | SheetJS predates ECMAScript modules and bundler tools like Webpack. As best | 
					
						
							|  |  |  | practices have evolved, stress testing SheetJS libraries have revealed bugs in | 
					
						
							|  |  |  | the respective bundlers.  This demo collects various notes and provides basic | 
					
						
							| 
									
										
										
										
											2022-07-20 08:58:29 +00:00
										 |  |  | examples. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | :::note | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Issues should be reported to the respective bundler projects.  Typically it is | 
					
						
							|  |  |  | considered a bundler bug if the tool cannot properly handle JS libraries. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ::: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-22 03:26:52 +00:00
										 |  |  | ## Browserify
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | `browserify` is compatible with the library and should "just work" with the | 
					
						
							|  |  |  | `require` form in a main page or in a web worker: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```js | 
					
						
							|  |  |  | var XLSX = require("xlsx"); | 
					
						
							|  |  |  | // ... use XLSX ... | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | [After installing the module](../../installation/nodejs), bundling is easy: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | browserify app.js > browserify.js | 
					
						
							|  |  |  | uglifyjs browserify.js > browserify.min.js | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Web Worker scripts can be bundled using the same approach. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <details><summary><b>Complete Example</b> (click to show)</summary> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 1) Install the tarball using a package manager: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <Tabs> | 
					
						
							|  |  |  |   <TabItem value="npm" label="npm"> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							| 
									
										
										
										
											2022-07-25 23:18:00 +00:00
										 |  |  | $ npm i --save https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							| 
									
										
										
										
											2022-07-22 03:26:52 +00:00
										 |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  |   <TabItem value="pnpm" label="pnpm"> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							| 
									
										
										
										
											2022-07-25 23:18:00 +00:00
										 |  |  | $ pnpm install https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							| 
									
										
										
										
											2022-07-22 03:26:52 +00:00
										 |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  |   <TabItem value="yarn" label="Yarn" default> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							| 
									
										
										
										
											2022-07-25 23:18:00 +00:00
										 |  |  | $ yarn add https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							| 
									
										
										
										
											2022-07-22 03:26:52 +00:00
										 |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  | </Tabs> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 2) Download the following files: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | - [`app.js`](pathname:///browserify/app.js) | 
					
						
							|  |  |  | - [`index.html`](pathname:///browserify/index.html) | 
					
						
							|  |  |  | - [`xlsxworker.js`](pathname:///browserify/xlsxworker.js) | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 3) Bundle the scripts: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | npx browserify app.js > browserify.js | 
					
						
							|  |  |  | npx browserify xlsxworker.js > worker.js | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 4) Spin up a local web server: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ``` | 
					
						
							| 
									
										
										
										
											2022-07-25 20:48:10 +00:00
										 |  |  | npx http-server | 
					
						
							| 
									
										
										
										
											2022-07-22 03:26:52 +00:00
										 |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 5) Access the site <http://localhost:8080/> and use the file input element to | 
					
						
							|  |  |  | select a spreadsheet. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | </details> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-20 08:58:29 +00:00
										 |  |  | ## Bun
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | `bun bun` is capable of optimizing imported libraries in `node_modules`.  In | 
					
						
							|  |  |  | local testing, a bundled script can save tens of milliseconds per run. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <details><summary><b>Complete Example</b> (click to show)</summary> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 1) Install the tarball using a package manager: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <Tabs> | 
					
						
							|  |  |  |   <TabItem value="npm" label="npm"> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							| 
									
										
										
										
											2022-07-25 23:18:00 +00:00
										 |  |  | $ npm i --save https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							| 
									
										
										
										
											2022-07-20 08:58:29 +00:00
										 |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  |   <TabItem value="pnpm" label="pnpm"> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							| 
									
										
										
										
											2022-07-25 23:18:00 +00:00
										 |  |  | $ pnpm install https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							| 
									
										
										
										
											2022-07-20 08:58:29 +00:00
										 |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  |   <TabItem value="yarn" label="Yarn" default> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							| 
									
										
										
										
											2022-07-25 23:18:00 +00:00
										 |  |  | $ yarn add https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							| 
									
										
										
										
											2022-07-20 08:58:29 +00:00
										 |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  | </Tabs> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 2) Save the following script to `bun.js`: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```js title="bun.js" | 
					
						
							|  |  |  | // highlight-next-line | 
					
						
							|  |  |  | import * as XLSX from 'xlsx/xlsx.mjs'; | 
					
						
							|  |  |  | // highlight-next-line | 
					
						
							|  |  |  | import * as fs from 'fs'; | 
					
						
							|  |  |  | // highlight-next-line | 
					
						
							|  |  |  | XLSX.set_fs(fs); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* fetch JSON data and parse */ | 
					
						
							|  |  |  | const url = "https://sheetjs.com/executive.json"; | 
					
						
							|  |  |  | const raw_data = await (await fetch(url)).json(); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* filter for the Presidents */ | 
					
						
							|  |  |  | const prez = raw_data.filter((row) => row.terms.some((term) => term.type === "prez")); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* flatten objects */ | 
					
						
							|  |  |  | const rows = prez.map((row) => ({ | 
					
						
							|  |  |  |   name: row.name.first + " " + row.name.last, | 
					
						
							|  |  |  |   birthday: row.bio.birthday | 
					
						
							|  |  |  | })); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* generate worksheet and workbook */ | 
					
						
							|  |  |  | const worksheet = XLSX.utils.json_to_sheet(rows); | 
					
						
							|  |  |  | const workbook = XLSX.utils.book_new(); | 
					
						
							|  |  |  | XLSX.utils.book_append_sheet(workbook, worksheet, "Dates"); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* fix headers */ | 
					
						
							|  |  |  | XLSX.utils.sheet_add_aoa(worksheet, [["Name", "Birthday"]], { origin: "A1" }); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* calculate column width */ | 
					
						
							|  |  |  | const max_width = rows.reduce((w, r) => Math.max(w, r.name.length), 10); | 
					
						
							|  |  |  | worksheet["!cols"] = [ { wch: max_width } ]; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* create an XLSX file and try to save to Presidents.xlsx */ | 
					
						
							|  |  |  | XLSX.writeFile(workbook, "Presidents.xlsx"); | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 3) Bundle the script with `bun bun`: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | bun bun bun.js | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | This procedure will generate `node_modules.bun`. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 4) Run the script | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | bun bun.js | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | </details> | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-22 03:26:52 +00:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-20 08:58:29 +00:00
										 |  |  | ## ESBuild
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | The `xlsx.mjs` source file are written in a subset of ES6 that ESBuild | 
					
						
							|  |  |  | understands and is able to transpile down for older browsers. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Both the `node` and `browser` platforms work out of the box. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <details><summary><b>Complete Example</b> (click to show)</summary> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <Tabs> | 
					
						
							|  |  |  |   <TabItem value="browser" label="Browser"> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 1) Install the tarball using a package manager: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <Tabs> | 
					
						
							|  |  |  |   <TabItem value="npm" label="npm"> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							| 
									
										
										
										
											2022-07-25 23:18:00 +00:00
										 |  |  | $ npm i --save https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							| 
									
										
										
										
											2022-07-20 08:58:29 +00:00
										 |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  |   <TabItem value="pnpm" label="pnpm"> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							| 
									
										
										
										
											2022-07-25 23:18:00 +00:00
										 |  |  | $ pnpm install https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							| 
									
										
										
										
											2022-07-20 08:58:29 +00:00
										 |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  |   <TabItem value="yarn" label="Yarn" default> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							| 
									
										
										
										
											2022-07-25 23:18:00 +00:00
										 |  |  | $ yarn add https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							| 
									
										
										
										
											2022-07-20 08:58:29 +00:00
										 |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  | </Tabs> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 2) Save the following to `esbrowser.js`: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```js title="esbrowser.js" | 
					
						
							|  |  |  | // highlight-next-line | 
					
						
							| 
									
										
										
										
											2022-07-26 19:24:43 +00:00
										 |  |  | import { utils, version, writeFileXLSX } from 'xlsx/xlsx.mjs'; | 
					
						
							| 
									
										
										
										
											2022-07-20 08:58:29 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | (async() => { | 
					
						
							|  |  |  | /* fetch JSON data and parse */ | 
					
						
							|  |  |  | const url = "https://sheetjs.com/executive.json"; | 
					
						
							|  |  |  | const raw_data = await (await fetch(url)).json(); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* filter for the Presidents */ | 
					
						
							|  |  |  | const prez = raw_data.filter(row => row.terms.some(term => term.type === "prez")); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* flatten objects */ | 
					
						
							|  |  |  | const rows = prez.map(row => ({ | 
					
						
							|  |  |  |   name: row.name.first + " " + row.name.last, | 
					
						
							|  |  |  |   birthday: row.bio.birthday | 
					
						
							|  |  |  | })); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* generate worksheet and workbook */ | 
					
						
							|  |  |  | const worksheet = utils.json_to_sheet(rows); | 
					
						
							|  |  |  | const workbook = utils.book_new(); | 
					
						
							|  |  |  | utils.book_append_sheet(workbook, worksheet, "Dates"); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* fix headers */ | 
					
						
							|  |  |  | utils.sheet_add_aoa(worksheet, [["Name", "Birthday"]], { origin: "A1" }); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* calculate column width */ | 
					
						
							|  |  |  | const max_width = rows.reduce((w, r) => Math.max(w, r.name.length), 10); | 
					
						
							|  |  |  | worksheet["!cols"] = [ { wch: max_width } ]; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* create an XLSX file and try to save to Presidents.xlsx */ | 
					
						
							| 
									
										
										
										
											2022-07-26 10:49:14 +00:00
										 |  |  | writeFileXLSX(workbook, "Presidents.xlsx"); | 
					
						
							| 
									
										
										
										
											2022-07-20 08:58:29 +00:00
										 |  |  | })(); | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 3) Create a small HTML page that loads the script.  Save to `index.html`: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```html title="index.html" | 
					
						
							|  |  |  | <body><script src="esb.browser.js"></script></body> | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 4) Create bundle: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | npx esbuild esbrowser.js --bundle --outfile=esb.browser.js | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 5) Start a local HTTP server, then go to http://localhost:8080/ | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | npx http-server . | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  |   <TabItem value="nodejs" label="NodeJS"> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 1) Install the tarball using a package manager: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <Tabs> | 
					
						
							|  |  |  |   <TabItem value="npm" label="npm"> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							| 
									
										
										
										
											2022-07-25 23:18:00 +00:00
										 |  |  | $ npm i --save https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							| 
									
										
										
										
											2022-07-20 08:58:29 +00:00
										 |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  |   <TabItem value="pnpm" label="pnpm"> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							| 
									
										
										
										
											2022-07-25 23:18:00 +00:00
										 |  |  | $ pnpm install https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							| 
									
										
										
										
											2022-07-20 08:58:29 +00:00
										 |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  |   <TabItem value="yarn" label="Yarn" default> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							| 
									
										
										
										
											2022-07-25 23:18:00 +00:00
										 |  |  | $ yarn add https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							| 
									
										
										
										
											2022-07-20 08:58:29 +00:00
										 |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  | </Tabs> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 2) Save the following to `esbnode.js`: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```js title="esbnode.js" | 
					
						
							|  |  |  | // highlight-next-line | 
					
						
							|  |  |  | import { set_fs, utils, version, writeFile } from 'xlsx/xlsx.mjs'; | 
					
						
							|  |  |  | // highlight-next-line | 
					
						
							|  |  |  | import * as fs from 'fs'; | 
					
						
							|  |  |  | // highlight-next-line | 
					
						
							|  |  |  | set_fs(fs); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | (async() => { | 
					
						
							|  |  |  | /* fetch JSON data and parse */ | 
					
						
							|  |  |  | const url = "https://sheetjs.com/executive.json"; | 
					
						
							|  |  |  | const raw_data = await (await fetch(url)).json(); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* filter for the Presidents */ | 
					
						
							|  |  |  | const prez = raw_data.filter(row => row.terms.some(term => term.type === "prez")); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* flatten objects */ | 
					
						
							|  |  |  | const rows = prez.map(row => ({ | 
					
						
							|  |  |  |   name: row.name.first + " " + row.name.last, | 
					
						
							|  |  |  |   birthday: row.bio.birthday | 
					
						
							|  |  |  | })); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* generate worksheet and workbook */ | 
					
						
							|  |  |  | const worksheet = utils.json_to_sheet(rows); | 
					
						
							|  |  |  | const workbook = utils.book_new(); | 
					
						
							|  |  |  | utils.book_append_sheet(workbook, worksheet, "Dates"); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* fix headers */ | 
					
						
							|  |  |  | utils.sheet_add_aoa(worksheet, [["Name", "Birthday"]], { origin: "A1" }); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* calculate column width */ | 
					
						
							|  |  |  | const max_width = rows.reduce((w, r) => Math.max(w, r.name.length), 10); | 
					
						
							|  |  |  | worksheet["!cols"] = [ { wch: max_width } ]; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* create an XLSX file and try to save to Presidents.xlsx */ | 
					
						
							|  |  |  | writeFile(workbook, "Presidents.xlsx"); | 
					
						
							|  |  |  | })(); | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 3) Create bundle: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | npx esbuild esbnode.js --bundle --platform=node --outfile=esb.node.js | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 4) Run the bundle: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | node esb.node.js | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  | </Tabs> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | </details> | 
					
						
							| 
									
										
										
										
											2022-07-17 03:47:27 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | ## Parcel
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Parcel Bundler should play nice with SheetJS out of the box. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-20 08:58:29 +00:00
										 |  |  | :::warning Parcel Bug | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-25 20:48:10 +00:00
										 |  |  | Errors of the form `Could not statically evaluate fs call` stem from a | 
					
						
							| 
									
										
										
										
											2022-07-17 03:47:27 +00:00
										 |  |  | [parcel bug](https://github.com/parcel-bundler/parcel/pull/523). Upgrade to | 
					
						
							|  |  |  | Parcel version 1.5.0 or later. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-20 08:58:29 +00:00
										 |  |  | ::: | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-17 03:47:27 +00:00
										 |  |  | <details><summary><b>Complete Example</b> (click to show)</summary> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | This demo follows the [Presidents Example](../../example). | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 1) Save the following to `index.html`: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```html title="index.html" | 
					
						
							|  |  |  | <body> | 
					
						
							|  |  |  | <h3>SheetJS <span id="vers"></span> export demo</h3> | 
					
						
							|  |  |  | <button id="xport">Click to Export!</button> | 
					
						
							|  |  |  | <!-- the script tag must be marked as `type="module"` --> | 
					
						
							|  |  |  | <!-- highlight-next-line --> | 
					
						
							|  |  |  | <script type="module"> | 
					
						
							|  |  |  | // ESM-style import from "xlsx" | 
					
						
							|  |  |  | // highlight-next-line | 
					
						
							| 
									
										
										
										
											2022-07-26 10:49:14 +00:00
										 |  |  | import { utils, version, writeFileXLSX } from 'xlsx'; | 
					
						
							| 
									
										
										
										
											2022-07-17 03:47:27 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | document.getElementById("vers").innerText = version; | 
					
						
							|  |  |  | document.getElementById("xport").onclick = async() => { | 
					
						
							|  |  |  |   /* fetch JSON data and parse */ | 
					
						
							|  |  |  |   const url = "https://sheetjs.com/executive.json"; | 
					
						
							|  |  |  |   const raw_data = await (await fetch(url)).json(); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |   /* filter for the Presidents */ | 
					
						
							|  |  |  |   const prez = raw_data.filter(row => row.terms.some(term => term.type === "prez")); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |   /* flatten objects */ | 
					
						
							|  |  |  |   const rows = prez.map(row => ({ | 
					
						
							|  |  |  |     name: row.name.first + " " + row.name.last, | 
					
						
							|  |  |  |     birthday: row.bio.birthday | 
					
						
							|  |  |  |   })); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |   /* generate worksheet and workbook */ | 
					
						
							|  |  |  |   const worksheet = utils.json_to_sheet(rows); | 
					
						
							|  |  |  |   const workbook = utils.book_new(); | 
					
						
							|  |  |  |   utils.book_append_sheet(workbook, worksheet, "Dates"); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |   /* fix headers */ | 
					
						
							|  |  |  |   utils.sheet_add_aoa(worksheet, [["Name", "Birthday"]], { origin: "A1" }); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |   /* calculate column width */ | 
					
						
							|  |  |  |   const max_width = rows.reduce((w, r) => Math.max(w, r.name.length), 10); | 
					
						
							|  |  |  |   worksheet["!cols"] = [ { wch: max_width } ]; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |   /* create an XLSX file and try to save to Presidents.xlsx */ | 
					
						
							| 
									
										
										
										
											2022-07-26 10:49:14 +00:00
										 |  |  |   writeFileXLSX(workbook, "Presidents.xlsx"); | 
					
						
							| 
									
										
										
										
											2022-07-17 03:47:27 +00:00
										 |  |  | }; | 
					
						
							|  |  |  | </script> | 
					
						
							|  |  |  | <body> | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 2) Install the SheetJS node module: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <Tabs> | 
					
						
							|  |  |  |   <TabItem value="npm" label="npm"> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							| 
									
										
										
										
											2022-07-25 23:18:00 +00:00
										 |  |  | $ npm i --save https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							| 
									
										
										
										
											2022-07-17 03:47:27 +00:00
										 |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  |   <TabItem value="pnpm" label="pnpm"> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							| 
									
										
										
										
											2022-07-25 23:18:00 +00:00
										 |  |  | $ pnpm install https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							| 
									
										
										
										
											2022-07-17 03:47:27 +00:00
										 |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  |   <TabItem value="yarn" label="Yarn" default> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							| 
									
										
										
										
											2022-07-25 23:18:00 +00:00
										 |  |  | $ yarn add https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							| 
									
										
										
										
											2022-07-17 03:47:27 +00:00
										 |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  | </Tabs> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 3) Run the Parcel CLI tool: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | npx -y parcel index.html | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 4) Access the page listed in the output (typically `http://localhost:1234`) and | 
					
						
							|  |  |  | click the "Click to Export!" button to generate a file. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-25 20:48:10 +00:00
										 |  |  | </details> | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-28 05:36:09 +00:00
										 |  |  | ## RequireJS
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | [Standalone scripts](../../installation/standalone) comply with AND `define` | 
					
						
							|  |  |  | semantics, enabling use in RequireJS out of the box. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | To enable use of the alias `xlsx`, the RequireJS config should set an alias in | 
					
						
							|  |  |  | the `paths` property: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```js | 
					
						
							|  |  |  | require.config({ | 
					
						
							|  |  |  |   baseUrl: ".", | 
					
						
							|  |  |  |   name: "app", | 
					
						
							|  |  |  |   paths: { | 
					
						
							|  |  |  |     // highlight-next-line | 
					
						
							|  |  |  |     xlsx: "xlsx.full.min" | 
					
						
							|  |  |  |   } | 
					
						
							|  |  |  | }); | 
					
						
							|  |  |  | // highlight-next-line | 
					
						
							|  |  |  | require(["xlsx"], function(XLSX) { | 
					
						
							|  |  |  | 	/* use XLSX here */ | 
					
						
							|  |  |  |   console.log(XLSX.version); | 
					
						
							|  |  |  | }); | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | The [Live demo](pathname:///requirejs/requirejs.html) loads RequireJS from the | 
					
						
							|  |  |  | CDN, uses it to load the standalone script from the SheetJS CDN, and uses the | 
					
						
							|  |  |  | `XLSX` variable to create a button click handler that creates a workbook. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | The `r.js` optimizer also supports the standalone scripts. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-31 18:48:02 +00:00
										 |  |  | ## Rollup
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Rollup requires `@rollup/plugin-node-resolve` to support NodeJS modules: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <details><summary><b>Complete Example</b> (click to show)</summary> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 1) Install the tarball using a package manager: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <Tabs> | 
					
						
							|  |  |  |   <TabItem value="npm" label="npm"> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							|  |  |  | $ npm i --save https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} rollup @rollup/plugin-node-resolve | 
					
						
							|  |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  |   <TabItem value="pnpm" label="pnpm"> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							|  |  |  | $ pnpm install https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} rollup @rollup/plugin-node-resolve | 
					
						
							|  |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  |   <TabItem value="yarn" label="Yarn" default> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							|  |  |  | $ yarn add https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} rollup @rollup/plugin-node-resolve | 
					
						
							|  |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  | </Tabs> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 2) Save the following to `index.js`: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```js title="index.js" | 
					
						
							|  |  |  | // highlight-next-line | 
					
						
							|  |  |  | import { utils, version, writeFileXLSX } from 'xlsx/xlsx.mjs'; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | document.getElementById("xport").addEventListener("click", async() => { | 
					
						
							|  |  |  | /* fetch JSON data and parse */ | 
					
						
							|  |  |  | const url = "https://sheetjs.com/executive.json"; | 
					
						
							|  |  |  | const raw_data = await (await fetch(url)).json(); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* filter for the Presidents */ | 
					
						
							|  |  |  | const prez = raw_data.filter(row => row.terms.some(term => term.type === "prez")); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* flatten objects */ | 
					
						
							|  |  |  | const rows = prez.map(row => ({ | 
					
						
							|  |  |  |   name: row.name.first + " " + row.name.last, | 
					
						
							|  |  |  |   birthday: row.bio.birthday | 
					
						
							|  |  |  | })); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* generate worksheet and workbook */ | 
					
						
							|  |  |  | const worksheet = utils.json_to_sheet(rows); | 
					
						
							|  |  |  | const workbook = utils.book_new(); | 
					
						
							|  |  |  | utils.book_append_sheet(workbook, worksheet, "Dates"); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* fix headers */ | 
					
						
							|  |  |  | utils.sheet_add_aoa(worksheet, [["Name", "Birthday"]], { origin: "A1" }); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* calculate column width */ | 
					
						
							|  |  |  | const max_width = rows.reduce((w, r) => Math.max(w, r.name.length), 10); | 
					
						
							|  |  |  | worksheet["!cols"] = [ { wch: max_width } ]; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* create an XLSX file and try to save to Presidents.xlsx */ | 
					
						
							|  |  |  | writeFileXLSX(workbook, "Presidents.xlsx"); | 
					
						
							|  |  |  | }); | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 3) Bundle the script: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | npx rollup index.js --plugin @rollup/plugin-node-resolve --file bundle.js --format iife | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 4) Create a small HTML page that loads the script.  Save to `index.html`: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```html title="index.html" | 
					
						
							|  |  |  | <!DOCTYPE html> | 
					
						
							|  |  |  | <html lang="en"> | 
					
						
							|  |  |  |   <head></head> | 
					
						
							|  |  |  |   <body> | 
					
						
							|  |  |  |     <h1>SheetJS Presidents Demo</h1> | 
					
						
							|  |  |  |     <button id="xport">Click here to export</button> | 
					
						
							|  |  |  |     <script type="module" src="./bundle.js"></script> | 
					
						
							|  |  |  |   </body> | 
					
						
							|  |  |  | </html> | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 5) Start a local HTTP server, then go to http://localhost:8080/ | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | npx http-server . | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Click on "Click here to export" to generate a file. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | </details> | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-25 20:48:10 +00:00
										 |  |  | ## Snowpack
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Snowpack works with no caveats. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <details><summary><b>Complete Example</b> (click to show)</summary> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 1) Install the tarball using a package manager: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <Tabs> | 
					
						
							|  |  |  |   <TabItem value="npm" label="npm"> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							| 
									
										
										
										
											2022-07-25 23:18:00 +00:00
										 |  |  | $ npm i --save https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							| 
									
										
										
										
											2022-07-25 20:48:10 +00:00
										 |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  |   <TabItem value="pnpm" label="pnpm"> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							| 
									
										
										
										
											2022-07-25 23:18:00 +00:00
										 |  |  | $ pnpm install https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							| 
									
										
										
										
											2022-07-25 20:48:10 +00:00
										 |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  |   <TabItem value="yarn" label="Yarn" default> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							| 
									
										
										
										
											2022-07-25 23:18:00 +00:00
										 |  |  | $ yarn add https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							| 
									
										
										
										
											2022-07-25 20:48:10 +00:00
										 |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  | </Tabs> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 2) Save the following to `index.js`: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```js title="index.js" | 
					
						
							|  |  |  | // highlight-next-line | 
					
						
							| 
									
										
										
										
											2022-07-26 19:24:43 +00:00
										 |  |  | import { utils, version, writeFileXLSX } from 'xlsx/xlsx.mjs'; | 
					
						
							| 
									
										
										
										
											2022-07-25 20:48:10 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | document.getElementById("xport").addEventListener("click", async() => { | 
					
						
							|  |  |  | /* fetch JSON data and parse */ | 
					
						
							|  |  |  | const url = "https://sheetjs.com/executive.json"; | 
					
						
							|  |  |  | const raw_data = await (await fetch(url)).json(); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* filter for the Presidents */ | 
					
						
							|  |  |  | const prez = raw_data.filter(row => row.terms.some(term => term.type === "prez")); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* flatten objects */ | 
					
						
							|  |  |  | const rows = prez.map(row => ({ | 
					
						
							|  |  |  |   name: row.name.first + " " + row.name.last, | 
					
						
							|  |  |  |   birthday: row.bio.birthday | 
					
						
							|  |  |  | })); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* generate worksheet and workbook */ | 
					
						
							|  |  |  | const worksheet = utils.json_to_sheet(rows); | 
					
						
							|  |  |  | const workbook = utils.book_new(); | 
					
						
							|  |  |  | utils.book_append_sheet(workbook, worksheet, "Dates"); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* fix headers */ | 
					
						
							|  |  |  | utils.sheet_add_aoa(worksheet, [["Name", "Birthday"]], { origin: "A1" }); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* calculate column width */ | 
					
						
							|  |  |  | const max_width = rows.reduce((w, r) => Math.max(w, r.name.length), 10); | 
					
						
							|  |  |  | worksheet["!cols"] = [ { wch: max_width } ]; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* create an XLSX file and try to save to Presidents.xlsx */ | 
					
						
							| 
									
										
										
										
											2022-07-26 10:49:14 +00:00
										 |  |  | writeFileXLSX(workbook, "Presidents.xlsx"); | 
					
						
							| 
									
										
										
										
											2022-07-25 20:48:10 +00:00
										 |  |  | }); | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 3) Create a small HTML page that loads the script.  Save to `index.html`: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```html title="index.html" | 
					
						
							|  |  |  | <!DOCTYPE html> | 
					
						
							|  |  |  | <html lang="en"> | 
					
						
							|  |  |  |   <head></head> | 
					
						
							|  |  |  |   <body> | 
					
						
							|  |  |  |     <h1>SheetJS Presidents Demo</h1> | 
					
						
							|  |  |  |     <button id="xport">Click here to export</button> | 
					
						
							|  |  |  |     <script type="module" src="./index.js"></script> | 
					
						
							|  |  |  |   </body> | 
					
						
							|  |  |  | </html> | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | :::note | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Unlike other bundlers, Snowpack requires a full page including `HEAD` element. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ::: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 4) Build for production: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | npx snowpack build | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 5) Start a local HTTP server, then go to http://localhost:8080/ | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | npx http-server build/ | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Click on "Click here to export" to generate a file. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | </details> | 
					
						
							| 
									
										
										
										
											2022-07-26 10:49:14 +00:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-31 09:22:30 +00:00
										 |  |  | ## SWC
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | SWC provides `spack` for bundling scripts. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <details><summary><b>Complete Example</b> (click to show)</summary> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 1) Install the dependencies using a package manager: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <Tabs> | 
					
						
							|  |  |  |   <TabItem value="npm" label="npm"> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							|  |  |  | $ npm i --save https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} regenerator-runtime @swc/cli @swc/core | 
					
						
							|  |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  |   <TabItem value="pnpm" label="pnpm"> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							|  |  |  | $ pnpm install https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} regenerator-runtime @swc/cli @swc/core | 
					
						
							|  |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  |   <TabItem value="yarn" label="Yarn" default> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							|  |  |  | $ yarn add https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} regenerator-runtime @swc/cli @swc/core | 
					
						
							|  |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  | </Tabs> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | :::note | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | The `regenerator-runtime` dependency is used for transpiling `fetch` and is not | 
					
						
							|  |  |  | required if the interface code does not use `fetch` or Promises. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ::: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 2) Save the following to `index.js`: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```js title="index.js" | 
					
						
							|  |  |  | import { utils, version, writeFileXLSX } from 'xlsx'; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | document.getElementById("xport").addEventListener("click", async() => { | 
					
						
							|  |  |  | /* fetch JSON data and parse */ | 
					
						
							|  |  |  | const url = "https://sheetjs.com/executive.json"; | 
					
						
							|  |  |  | const raw_data = await (await fetch(url)).json(); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* filter for the Presidents */ | 
					
						
							|  |  |  | const prez = raw_data.filter(row => row.terms.some(term => term.type === "prez")); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* flatten objects */ | 
					
						
							|  |  |  | const rows = prez.map(row => ({ | 
					
						
							|  |  |  |   name: row.name.first + " " + row.name.last, | 
					
						
							|  |  |  |   birthday: row.bio.birthday | 
					
						
							|  |  |  | })); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* generate worksheet and workbook */ | 
					
						
							|  |  |  | const worksheet = utils.json_to_sheet(rows); | 
					
						
							|  |  |  | const workbook = utils.book_new(); | 
					
						
							|  |  |  | utils.book_append_sheet(workbook, worksheet, "Dates"); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* fix headers */ | 
					
						
							|  |  |  | utils.sheet_add_aoa(worksheet, [["Name", "Birthday"]], { origin: "A1" }); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* calculate column width */ | 
					
						
							|  |  |  | const max_width = rows.reduce((w, r) => Math.max(w, r.name.length), 10); | 
					
						
							|  |  |  | worksheet["!cols"] = [ { wch: max_width } ]; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* create an XLSX file and try to save to Presidents.xlsx */ | 
					
						
							|  |  |  | writeFileXLSX(workbook, "Presidents.xlsx"); | 
					
						
							|  |  |  | }); | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 3) Create an `spack.config.js` config file: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```js title="spack.config.js" | 
					
						
							|  |  |  | const { config } = require('@swc/core/spack'); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | module.exports = ({ | 
					
						
							|  |  |  |   entry: { | 
					
						
							|  |  |  |     'web': __dirname + '/index.js', | 
					
						
							|  |  |  |   }, | 
					
						
							|  |  |  |   output: { | 
					
						
							|  |  |  |     path: __dirname + '/lib' | 
					
						
							|  |  |  |   }, | 
					
						
							|  |  |  |   module: {}, | 
					
						
							|  |  |  | }); | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 4) Build for production: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | npx spack | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | This command will create the script `lib/web.js` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 5) Create a small HTML page that loads the generated script: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```html title="index.html" | 
					
						
							|  |  |  | <!DOCTYPE html> | 
					
						
							|  |  |  | <html lang="en"> | 
					
						
							|  |  |  |   <head></head> | 
					
						
							|  |  |  |   <body> | 
					
						
							|  |  |  |     <h1>SheetJS Presidents Demo</h1> | 
					
						
							|  |  |  |     <button id="xport">Click here to export</button> | 
					
						
							|  |  |  |     <script src="lib/web.js"></script> | 
					
						
							|  |  |  |   </body> | 
					
						
							|  |  |  | </html> | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 6) Start a local HTTP server, then go to http://localhost:8080/ | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | npx http-server build/ | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Click on "Click here to export" to generate a file. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | </details> | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-26 10:49:14 +00:00
										 |  |  | ## Vite
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | :::caution | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ViteJS adopted nascent `package.json` patterns. Version 0.18.10 implements the | 
					
						
							|  |  |  | patterns required for ViteJS 3.0.3. These patterns are evolving and a future | 
					
						
							|  |  |  | version of Vite may require more packaging changes. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ::: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ViteJS 3.0.3 is known to work with SheetJS version 0.18.10. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <details><summary><b>Complete Example</b> (click to show)</summary> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 1) Create a new ViteJS project: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | npm create vite@latest | 
					
						
							|  |  |  | cd sheetjs-vite # (project name) | 
					
						
							|  |  |  | npm i | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | When prompted for **Project Name**, type **`sheetjs-vite`** | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | When prompted for **Framework**, select **`vue`** then **`vue-ts`** | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 2) Add the SheetJS dependency: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							|  |  |  | $ npm i --save https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							|  |  |  | </code></pre> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 3) Replace `src\components\HelloWorld.vue` with: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```html title="src\components\HelloWorld.vue" | 
					
						
							|  |  |  | <script setup lang="ts"> | 
					
						
							|  |  |  | import { version, utils, writeFileXLSX } from 'xlsx'; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | interface President { | 
					
						
							|  |  |  |   terms: { "type": "prez" | "viceprez"; }[]; | 
					
						
							|  |  |  |   name: { first: string; last: string; } | 
					
						
							|  |  |  |   bio: { birthday: string; } | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | async function xport() { | 
					
						
							|  |  |  | /* fetch JSON data and parse */ | 
					
						
							|  |  |  | const url = "https://sheetjs.com/executive.json"; | 
					
						
							|  |  |  | const raw_data: President[] = await (await fetch(url)).json(); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* filter for the Presidents */ | 
					
						
							|  |  |  | const prez = raw_data.filter(row => row.terms.some(term => term.type === "prez")); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* flatten objects */ | 
					
						
							|  |  |  | const rows = prez.map(row => ({ | 
					
						
							|  |  |  |   name: row.name.first + " " + row.name.last, | 
					
						
							|  |  |  |   birthday: row.bio.birthday | 
					
						
							|  |  |  | })); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* generate worksheet and workbook */ | 
					
						
							|  |  |  | const worksheet = utils.json_to_sheet(rows); | 
					
						
							|  |  |  | const workbook = utils.book_new(); | 
					
						
							|  |  |  | utils.book_append_sheet(workbook, worksheet, "Dates"); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* fix headers */ | 
					
						
							|  |  |  | utils.sheet_add_aoa(worksheet, [["Name", "Birthday"]], { origin: "A1" }); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* calculate column width */ | 
					
						
							|  |  |  | const max_width = rows.reduce((w, r) => Math.max(w, r.name.length), 10); | 
					
						
							|  |  |  | worksheet["!cols"] = [ { wch: max_width } ]; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* create an XLSX file and try to save to Presidents.xlsx */ | 
					
						
							|  |  |  | writeFileXLSX(workbook, "Presidents.xlsx"); | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | </script> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <template> | 
					
						
							|  |  |  |   <button type="button" @click="xport">Export with SheetJS version {{ version }}</button> | 
					
						
							|  |  |  | </template> | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 4) Run `npm run dev` and test functionality by opening a web browser to | 
					
						
							|  |  |  | http://localhost:5173/ and clicking the button | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 5) Run `npx vite build` and verify the generated pages work by running a local | 
					
						
							|  |  |  | web server in the `dist` folder: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | npx http-server dist/ | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Access http://localhost:8080 in your web browser. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | </details> | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-31 18:48:02 +00:00
										 |  |  | ## WMR
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | WMR follows the same structure as Snowpack | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <details><summary><b>Complete Example</b> (click to show)</summary> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 1) Install the tarball using a package manager: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <Tabs> | 
					
						
							|  |  |  |   <TabItem value="npm" label="npm"> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							|  |  |  | $ npm i --save https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							|  |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  |   <TabItem value="pnpm" label="pnpm"> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							|  |  |  | $ pnpm install https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							|  |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  |   <TabItem value="yarn" label="Yarn" default> | 
					
						
							|  |  |  | <pre><code parentName="pre" {...{"className": "language-bash"}}>{`\ | 
					
						
							|  |  |  | $ yarn add https://cdn.sheetjs.com/xlsx-${current}/xlsx-${current}.tgz`} | 
					
						
							|  |  |  | </code></pre> | 
					
						
							|  |  |  |   </TabItem> | 
					
						
							|  |  |  | </Tabs> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 2) Save the following to `index.js`: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```js title="index.js" | 
					
						
							|  |  |  | // highlight-next-line | 
					
						
							|  |  |  | import { utils, version, writeFileXLSX } from 'xlsx/xlsx.mjs'; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | document.getElementById("xport").addEventListener("click", async() => { | 
					
						
							|  |  |  | /* fetch JSON data and parse */ | 
					
						
							|  |  |  | const url = "https://sheetjs.com/executive.json"; | 
					
						
							|  |  |  | const raw_data = await (await fetch(url)).json(); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* filter for the Presidents */ | 
					
						
							|  |  |  | const prez = raw_data.filter(row => row.terms.some(term => term.type === "prez")); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* flatten objects */ | 
					
						
							|  |  |  | const rows = prez.map(row => ({ | 
					
						
							|  |  |  |   name: row.name.first + " " + row.name.last, | 
					
						
							|  |  |  |   birthday: row.bio.birthday | 
					
						
							|  |  |  | })); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* generate worksheet and workbook */ | 
					
						
							|  |  |  | const worksheet = utils.json_to_sheet(rows); | 
					
						
							|  |  |  | const workbook = utils.book_new(); | 
					
						
							|  |  |  | utils.book_append_sheet(workbook, worksheet, "Dates"); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* fix headers */ | 
					
						
							|  |  |  | utils.sheet_add_aoa(worksheet, [["Name", "Birthday"]], { origin: "A1" }); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* calculate column width */ | 
					
						
							|  |  |  | const max_width = rows.reduce((w, r) => Math.max(w, r.name.length), 10); | 
					
						
							|  |  |  | worksheet["!cols"] = [ { wch: max_width } ]; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /* create an XLSX file and try to save to Presidents.xlsx */ | 
					
						
							|  |  |  | writeFileXLSX(workbook, "Presidents.xlsx"); | 
					
						
							|  |  |  | }); | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 3) Create a small HTML page that loads the script.  Save to `index.html`: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```html title="index.html" | 
					
						
							|  |  |  | <!DOCTYPE html> | 
					
						
							|  |  |  | <html lang="en"> | 
					
						
							|  |  |  |   <head></head> | 
					
						
							|  |  |  |   <body> | 
					
						
							|  |  |  |     <h1>SheetJS Presidents Demo</h1> | 
					
						
							|  |  |  |     <button id="xport">Click here to export</button> | 
					
						
							|  |  |  |     <script type="module" src="./index.js"></script> | 
					
						
							|  |  |  |   </body> | 
					
						
							|  |  |  | </html> | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 4) Build for production: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | npx wmr build | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 5) Start a local HTTP server in `dist` folder and go to http://localhost:8080/ | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | npx http-server dist/ | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Click on "Click here to export" to generate a file. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | </details> | 
					
						
							|  |  |  | 
 |