single-file 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  1. #!/usr/bin/env node
  2. /*
  3. * Copyright 2010-2019 Gildas Lormeau
  4. * contact : gildas.lormeau <at> gmail.com
  5. *
  6. * This file is part of SingleFile.
  7. *
  8. * The code in this file is free software: you can redistribute it and/or
  9. * modify it under the terms of the GNU Affero General Public License
  10. * (GNU AGPL) as published by the Free Software Foundation, either version 3
  11. * of the License, or (at your option) any later version.
  12. *
  13. * The code in this file is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
  16. * General Public License for more details.
  17. *
  18. * As additional permission under GNU AGPL version 3 section 7, you may
  19. * distribute UNMODIFIED VERSIONS OF THIS file without the copy of the GNU
  20. * AGPL normally required by section 4, provided you include this license
  21. * notice and a URL through which recipients can access the Corresponding
  22. * Source.
  23. */
  24. /* global require */
  25. const args = require("yargs")
  26. .wrap(null)
  27. .command("$0 <url> [output]", "Save a page into a single HTML file.", yargs => {
  28. yargs.positional("url", { description: "URL of the page to save", type: "string" });
  29. yargs.positional("output", { description: "Output filename", type: "string" });
  30. })
  31. .default({
  32. "browser-headless": true,
  33. "browser-executable-path": "",
  34. "browser-width": 1280,
  35. "browser-height": 720,
  36. "browser-wait-until": "networkidle0",
  37. "compress-CSS": true,
  38. "compress-HTML": true,
  39. "filename-template": "",
  40. "group-duplicate-images": true,
  41. "load-deferred-images": true,
  42. "load-deferred-images-max-idle-time": 1500,
  43. "max-resource-size-enabled": false,
  44. "max-resource-size": 10,
  45. "remove-hidden-elements": true,
  46. "remove-unused-styles": true,
  47. "remove-unused-fonts": true,
  48. "remove-imports": true,
  49. "remove-scripts": true,
  50. "remove-audio-src": true,
  51. "remove-video-src": true,
  52. "remove-alternative-fonts": true,
  53. "remove-alternative-medias": true,
  54. "remove-alternative-images": true,
  55. "save-raw-page": false,
  56. "web-driver-executable-path": ""
  57. })
  58. .options("browser-headless", { description: "Run the browser in headless mode" })
  59. .boolean("browser-headless")
  60. .options("browser-executable-path", { description: "Path to chrome/chromium executable" })
  61. .string("browser-executable-path")
  62. .options("browser-width", { description: "Width of the browser viewport in pixels" })
  63. .number("browser-width")
  64. .options("browser-height", { description: "Height of the browser viewport in pixels" })
  65. .number("browser-height")
  66. .options("browser-wait-until", { description: "When to consider the page is loaded" })
  67. .choices("browser-wait-until", ["networkidle0", "networkidle2", "load", "domcontentloaded"])
  68. .options("compress-CSS", { description: "Compress CSS stylesheets" })
  69. .boolean("compress-CSS")
  70. .options("compress-HTML", { description: "Compress HTML content" })
  71. .boolean("compress-HTML")
  72. .options("filename-template", { description: "Template used to generate the output filename (see help page of the extension for more info)" })
  73. .string("filename-template")
  74. .options("group-duplicate-images", { description: "Group duplicate images into CSS custom properties" })
  75. .boolean("compress-HTML")
  76. .options("load-deferred-images", { description: "Load deferred (a.k.a. lazy-loaded) images" })
  77. .boolean("load-deferred-images")
  78. .options("load-deferred-images-max-idle-time", { description: "Maximum delay of time to wait for deferred images" })
  79. .number("load-deferred-images")
  80. .options("max-resource-size-enabled", { description: "Enable removal of embedded resources exceeding a given size" })
  81. .boolean("max-resource-size-enabled")
  82. .options("max-resource-size", { description: "Maximum size of embedded resources (i.e. images, stylesheets, scripts and iframes)" })
  83. .number("max-resource-size")
  84. .options("remove-frames", { description: "Remove frames (puppeteer, webdriver-gecko, webdriver-chromium)" })
  85. .boolean("remove-frames")
  86. .options("remove-hidden-elements", { description: "Remove HTML elements which are not displayed" })
  87. .number("remove-hidden-elements")
  88. .options("remove-unused-styles", { description: "Remove unused CSS rules and unneeded declarations" })
  89. .number("remove-unused-styles")
  90. .options("remove-unused-fonts", { description: "Remove unused CSS font rules" })
  91. .number("remove-unused-fonts")
  92. .options("remove-imports", { description: "Remove HTML imports" })
  93. .number("remove-imports")
  94. .options("remove-scripts", { description: "Remove JavaScript scripts" })
  95. .number("remove-scripts")
  96. .options("remove-audio-src", { description: "Remove source of audio elements" })
  97. .number("remove-audio-src")
  98. .options("remove-video-src", { description: "Remove source of video elements" })
  99. .number("remove-video-src")
  100. .options("remove-alternative-fonts", { description: "Remove alternative fonts to the ones displayed" })
  101. .number("remove-alternative-fonts")
  102. .options("remove-alternative-medias", { description: "Remove alternative CSS stylesheets" })
  103. .number("remove-alternative-medias")
  104. .options("remove-alternative-images", { description: "Remove images for alternative sizes of screen" })
  105. .number("remove-alternative-images")
  106. .options("save-raw-page", { description: "Save the original page without interpreting it into the browser" })
  107. .number("save-raw-page")
  108. .options("web-driver-executable-path", { description: "Path to Selenium WebDriver executable" })
  109. .string("web-driver-executable-path")
  110. .argv;
  111. require("./back-ends/webdriver-gecko.js").getPageData(args).then(pageData => {
  112. if (args.output) {
  113. require("fs").writeFileSync(args.output, pageData.content);
  114. } else {
  115. if (args.filenameTemplate) {
  116. require("fs").writeFileSync(pageData.filename, pageData.content);
  117. } else {
  118. console.log(pageData.content); // eslint-disable-line no-console
  119. }
  120. }
  121. });