fix(highlight.js): use prebuilt package

custom build is broken

Author: duncdrum

Gulpfile.js

@@ -112,7 +112,7 @@ var svgmin = require('gulp-svgmin')
  */
 
 // Remove pre-existing content from output folders
-var cleanDist = function(done) {
+var cleanDist = function (done) {
   // Make sure this feature is activated before running
   if (!settings.clean) return done()
 
@@ -143,13 +143,13 @@ var jsTasks = lazypipe()
   .pipe(dest, paths.scripts.output)
 
 // Lint, minify, and concatenate scripts
-var buildScripts = function(done) {
+var buildScripts = function (done) {
   // Make sure this feature is activated before running
   if (!settings.scripts) return done()
 
   // Run tasks on script files
   src(paths.scripts.input)
-    .pipe(flatmap(function(stream, file) {
+    .pipe(flatmap(function (stream, file) {
       // If the file is a directory
       if (file.isDirectory()) {
         // Setup a suffix variable
@@ -184,7 +184,7 @@ var buildScripts = function(done) {
 }
 
 // Lint scripts
-var lintScripts = function(done) {
+var lintScripts = function (done) {
   // Make sure this feature is activated before running
   if (!settings.scripts) return done()
 
@@ -201,24 +201,24 @@ var lintScripts = function(done) {
 
 // pretty print all xml listings
 // articles not yet decided
-var prettyXml = function(done) {
+var prettyXml = function (done) {
   src(paths.xml.listings, { base: "./" })
-  .pipe(muxml({
-    stripComments: false,
-    stripCdata: false,
-    stripInstruction: false,
-    saxOptions: {
-      trim: true,
-      normalize: true
-    }
-  }))
+    .pipe(muxml({
+      stripComments: false,
+      stripCdata: false,
+      stripInstruction: false,
+      saxOptions: {
+        trim: true,
+        normalize: true
+      }
+    }))
     .pipe(dest("./"))
-    // Signal completion
-    done()
+  // Signal completion
+  done()
 }
 
 // Process, lint, and minify Sass files
-var buildStyles = function(done) {
+var buildStyles = function (done) {
   // Make sure this feature is activated before running
   if (!settings.styles) return done()
 
@@ -258,7 +258,7 @@ var buildStyles = function(done) {
 }
 
 // Optimize SVG files
-var buildSVGs = function(done) {
+var buildSVGs = function (done) {
   // Make sure this feature is activated before running
   if (!settings.svgs) return done()
 
@@ -272,7 +272,7 @@ var buildSVGs = function(done) {
 }
 
 // Copy third-party dependencies from node_modules into resources
-var vendorFiles = function(done) {
+var vendorFiles = function (done) {
   // Make sure this feature is activated before running
   if (!settings.vendor) return done()
 
@@ -282,11 +282,16 @@ var vendorFiles = function(done) {
 
 
   // copy vendor scripts
-  src(['node_modules/bootstrap/dist/js/bootstrap.min.*', 'node_modules/@popperjs/core/dist/umd/popper.min.*'])
+  src(['node_modules/bootstrap/dist/js/bootstrap.min.*', 'node_modules/@popperjs/core/dist/umd/popper.min.*', 'node_modules/@highlightjs/cdn-assets/highlight.min.js', 'node_modules/@highlightjs/cdn-assets/languages/xquery.min.js', 'node_modules/@highlightjs/cdn-assets/languages/dockerfile.min.js'])
+    .pipe(dest(paths.scripts.output))
+
+  // copy pre-packed lang definitions for code highlighter
+  // CSS Bash Makefile Diff JSON Markdown Perl SQL Shell Properties Less SCSS Puppet'
+  src(['node_modules/@highlightjs/cdn-assets/languages/xquery.min.js', 'node_modules/@highlightjs/cdn-assets/languages/dockerfile.min.js', 'node_modules/@highlightjs/cdn-assets/languages/apache.min.js', 'node_modules/@highlightjs/cdn-assets/languages/http.min.js', 'node_modules/@highlightjs/cdn-assets/languages/nginx.min.js'])
   .pipe(dest(paths.scripts.output))
 
   // copy vendor Styles
-  src(['node_modules/bootstrap/dist/css/bootstrap.min.*', 'node_modules/highlight.js/styles/atom-one-dark.css'])
+  src(['node_modules/bootstrap/dist/css/bootstrap.min.*', 'node_modules/@highlightjs/cdn-assets/styles/atom-one-dark.min.css'])
     .pipe(dest(paths.styles.output))
 
   // copy vendor fonts
@@ -298,7 +303,7 @@ var vendorFiles = function(done) {
 
 
 // Copy static files into output folder
-var copyFiles = function(done) {
+var copyFiles = function (done) {
   // Make sure this feature is activated before running
   if (!settings.copy) return done()
 
@@ -310,32 +315,6 @@ var copyFiles = function(done) {
   done()
 }
 
-// Build and copy highlight.js
-var buildPack = function(done) {
-  // Make sure this feature is activated before running
-  if (!settings.hjs) return done()
-
-  // build highlight pack
-  // see https://highlightjs.readthedocs.io/en/latest/building-testing.html
-  // TODO currently building is bugged when using npm
-  let command = 'cd node_modules/highlight.js'
-                    + ' && npm install'
-                    + ' && node tools/build Apache CSS HTTP JavaScript Bash Makefile PHP Diff JSON Markdown Perl SQL HTML Java Nginx Shell Properties Less SCSS Puppet Dockerfile xquery'
-
-  exec(command, (err, stdout, stderr)=> {
-    console.log(stderr)
-    console.log(stdout)
-
-    callback(err)
-  })
-
-  src('node_modules/highlight.js/build/*pack.js')
-    .pipe(dest(paths.scripts.output))
-
-  // Signal completion
-  done()
-}
-
 /**
  * Export Tasks
  */
@@ -351,7 +330,6 @@ exports.default = series(
     buildStyles,
     buildSVGs,
     copyFiles,
-    buildPack,
     prettyXml
   )
 )

package-lock.json

@@ -53,9 +53,9 @@
     "supertest": "^7.0.0"
   },
   "dependencies": {
+    "@highlightjs/cdn-assets": "^11.11.1",
     "@neos21/bootstrap3-glyphicons": "^1.0.7",
     "@popperjs/core": "^2.11.8",
-    "bootstrap": "^5.3.3",
-    "highlight.js": "^11.11.1"
+    "bootstrap": "^5.3.3"
   }
 }

package.json

@@ -127,7 +127,7 @@
         <code>.xar</code>
         app inside a build folder on the same level as your own
         <literal>Dockerfile</literal>. To get an image of an eXist-db instance with your app installed and running, you would then:</para>
-      <programlisting xlink:href="listings/listing-2.txt"/>
+      <programlisting language="docker" xlink:href="listings/listing-2.txt"/>
       <para>You should see something like this:</para>
       <programlisting xlink:href="listings/listing-3.txt"/>
       <para>The result is a new image of your app installed into eXist-db. Since you didn't provide further instructions it will simply reuse the
@@ -149,7 +149,7 @@
         <code>docker exec …
         </code>style commands from this readme, use
         <code>RUN</code>.</para>
-      <programlisting xlink:href="listings/listing-4.txt"/>
+      <programlisting language="docker" xlink:href="listings/listing-4.txt"/>
       <para>The above demonstrates different kind of operations available to you in a single stage build. You have just executed the
         <link xlink:href="java-admin-client">Java Admin Client</link>
         from inside a Dockerfile, which in turn allows you to run any XQuery code you want when modifying the eXist-db instance that will ship with your images. You can also chain multiple RUN commands.</para>
@@ -173,7 +173,7 @@
         begins a stage) is the simple example again from before. Such a setup ensures that non of your collaborators has to have
         <literal>java, nodeJS, ect</literal>
         installed, and is great for fully automated builds and deployment.</para>
-      <programlisting xlink:href="listings/listing-5.txt"/>
+      <programlisting language="docker" xlink:href="listings/listing-5.txt"/>
       <para>The basic idea behind multi-staging is that everything you need for building your software should be managed by docker, so that all collaborators can rely on one stable environment. In the end, and after how ever many stages you need, only the
         files necessary to run your app should go into the final stage. The possibilities are virtually endless, but with this example and the Dockerfile in this repo you should get a pretty good idea of how you might apply this idea to your own projects.</para>
     </sect2>

src/main/frontend/copy/scripts/highlight.pack.js

@@ -357,7 +357,7 @@
       <para>Here is an example using the above assertion library</para>
       <programlisting language="xquery" xlink:href="listings/assertion-lib.txt"/>
       <para>The output will look like this</para>
-      <programlisting language="xquery" xlink:href="listings/custom-assertion-result.xml"/>
+      <programlisting language="xml" xlink:href="listings/custom-assertion-result.xml"/>
 
       <sect3 xml:id="custom-assertion-fallback">
         <title>Fallback for backwards compatibility</title>

src/main/xar-resources/data/docker/docker.xml

@@ -216,7 +216,7 @@
 
       <xsl:when test="exists(@language)">
         <pre>
-          <code class="{@language}">
+          <code class="{concat('language-', @language)}">
             <xsl:value-of select="$contents"/>
           </code>
         </pre>