Add create-image script to generate example thumbnails #8029
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| 'use strict'; | ||
|
|
||
| const puppeteer = require('puppeteer'); // eslint-disable-line | ||
| const path = require('path'); // eslint-disable-line | ||
| const pack = require('../../package.json'); // eslint-disable-line | ||
|
|
||
| const fileName = process.argv[2]; | ||
| const token = process.argv[3] || process.env.MAPBOX_ACCESS_TOKEN; | ||
|
There was a problem hiding this comment. Ah sorry, I meant that it would be good to check for |
||
|
|
||
| if (!token || !fileName) { | ||
| throw new Error('\n Usage: npm run create-image <file-name> <mapbox-access-token>\nExample: npm run create-image 3d-buildings pk000011110000111100001111\n\n'); | ||
| } | ||
|
|
||
| // strip file extension from file name | ||
| const fileNameFormatted = fileName.replace('.html', '').replace('.js', ''); | ||
| // get the example contents/snippet | ||
| const snippet = require('fs').readFileSync(path.resolve(__dirname, '..', 'pages', 'example', `${fileNameFormatted}.html`), 'utf-8'); | ||
| // create an HTML page to display the example snippet | ||
| const html = `<!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <meta charset='utf-8' /> | ||
| <script src='https://api.tiles.mapbox.com/mapbox-gl-js/v${pack.version}/mapbox-gl.js'></script> | ||
| <link href='https://api.tiles.mapbox.com/mapbox-gl-js/v${pack.version}/mapbox-gl.css' rel='stylesheet' /> | ||
| <style> | ||
| body { margin:0; padding:0; } | ||
| #map { position: absolute; top:0; bottom:0; width: 600px; max-height: 300px; } | ||
| </style> | ||
| </head> | ||
| <body> | ||
| <script> | ||
| mapboxgl.accessToken = '${token}'; | ||
| </script> | ||
| ${snippet} | ||
| </body> | ||
| </html>`; | ||
|
|
||
| // initilize puppeteer | ||
| (async() => { | ||
| const browser = await puppeteer.launch(); | ||
| const page = await browser.newPage(); | ||
| // set html for page and then wait until mapbox-gl-js loads | ||
| await page.setContent(html, {waitUntil: 'networkidle2'}); | ||
| // set viewport and double deviceScaleFactor to get a closer shot of the map | ||
| await page.setViewport({ | ||
| width: 600, | ||
| height: 600, | ||
| deviceScaleFactor: 2 | ||
| }); | ||
| // create screenshot | ||
| await page.screenshot({ | ||
| path: `./docs/img/src/${fileNameFormatted}.png`, | ||
| type: 'png', | ||
| clip: { | ||
| x: 0, | ||
| y: 0, | ||
| width: 600, | ||
| height: 250 | ||
| } | ||
| }).then(() => console.log(`Created ./docs/img/src/${fileNameFormatted}.png`)) | ||
| .catch((err) => { console.log(err); }); | ||
| await browser.close(); | ||
| })(); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: should read
The script will take a screenshot of the map