Complete coffee -> JS conversion of docs

Author: blikblum

docs/annotations.coffee.md

@@ -37,29 +37,29 @@ covered by another annotation and the user won't be able to click it.
 
 Here is an example that uses a few of the annotation types.
 
-    # Add the link text
+    // Add the link text
     doc.fontSize(25)
        .fillColor('blue')
-       .text('This is a link!', 20, 0)
+       .text('This is a link!', 20, 0);
 
-    # Measure the text
-    width = doc.widthOfString('This is a link!')
-    height = doc.currentLineHeight()
+    // Measure the text
+    const width = doc.widthOfString('This is a link!');
+    const height = doc.currentLineHeight();
 
-    # Add the underline and link annotations
-    doc.underline(20, 0, width, height, color: 'blue')
-       .link(20, 0, width, height, 'http://google.com/')
+    // Add the underline and link annotations
+    doc.underline(20, 0, width, height, {color: 'blue'})
+       .link(20, 0, width, height, 'http://google.com/');
 
-    # Create the highlighted text
+    // Create the highlighted text
     doc.moveDown()
        .fillColor('black')
        .highlight(20, doc.y, doc.widthOfString('This text is highlighted!'), height)
-       .text('This text is highlighted!')
+       .text('This text is highlighted!');
 
-    # Create the crossed out text
+    // Create the crossed out text
     doc.moveDown()
        .strike(20, doc.y, doc.widthOfString('STRIKE!'), height)
-       .text('STRIKE!')
+       .text('STRIKE!');
 
 The output of this example looks like this.
 
@@ -70,11 +70,13 @@ that is the fault of the PDF spec itself. Calculating a rectangle manually isn't
 fun, but PDFKit makes it easier for a few common annotations applied to text, including
 links, underlines, and strikes.  Here's an example showing two of them:
 
-    doc.fontSize 20
-       .fillColor 'red'
-       .text 'Another link!', 20, 0,
+    doc.fontSize(20)
+       .fillColor('red')
+       .text('Another link!', 20, 0, {
          link: 'http://apple.com/',
          underline: true
+       }
+    );
 
 The output is as you'd expect:
 

docs/generate.js

@@ -9,16 +9,15 @@
 const fs = require('fs');
 const vm = require('vm');
 const md = require('markdown').markdown;
-const coffee = require('coffee-script');
 const CodeMirror = require('codemirror/addon/runmode/runmode.node');
 const PDFDocument = require('../');
 
 process.chdir(__dirname);
 
-// setup code mirror coffeescript mode
-const filename = require.resolve('codemirror/mode/coffeescript/coffeescript');
-const coffeeMode = fs.readFileSync(filename, 'utf8');
-vm.runInNewContext(coffeeMode, {CodeMirror});
+// setup code mirror javascript mode
+const filename = require.resolve('codemirror/mode/javascript/javascript');
+const jsMode = fs.readFileSync(filename, 'utf8');
+vm.runInNewContext(jsMode, {CodeMirror});
 
 // style definitions for markdown
 const styles = {
@@ -142,7 +141,7 @@ class Node {
         // use code mirror to syntax highlight the code block
         var code = this.content[0].text;
         this.content = [];
-        CodeMirror.runMode(code, 'coffeescript', (text, style) => {
+        CodeMirror.runMode(code, 'javascript', (text, style) => {
           const color = colors[style] || colors.default;
           const opts = {
             color,
@@ -158,11 +157,11 @@ class Node {
 
       case 'img':
         // images are used to generate inline example output
-        // compiles the coffeescript to JS so it can be run 
+        // stores the JS so it can be run 
         // in the render method
         this.type = 'example';
         code = codeBlocks[this.attrs.alt];
-        if (code) { this.code = coffee.compile(code); }
+        if (code) { this.code = code; }
         this.height = +this.attrs.title || 0;
         break;
     }
@@ -266,7 +265,7 @@ class Node {
   }
 }
 
-// reads and renders a markdown/literate coffeescript file to the document
+// reads and renders a markdown/literate javascript file to the document
 const render = function(doc, filename) {
   codeBlocks = [];
   const tree = md.parse(fs.readFileSync(filename, 'utf8'));

docs/generate_website.js

@@ -1,15 +1,7 @@
-/*
- * decaffeinate suggestions:
- * DS101: Remove unnecessary use of Array.from
- * DS102: Remove unnecessary code created because of implicit returns
- * DS205: Consider reworking code to avoid use of IIFEs
- * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
- */
 const jade = require('jade');
 const { markdown } = require('markdown');
 const fs = require('fs');
 const vm = require('vm');
-const coffee = require('coffee-script');
 const {exec} = require('child_process');
 const PDFDocument = require('../');
 
@@ -53,68 +45,58 @@ let imageIndex = 0;
 const generateImages = function(tree) {
   // find code blocks
   const codeBlocks = [];
-  for (var node of Array.from(tree)) {
+  for (var node of tree) {
     if (node[0] === 'code_block') {
       codeBlocks.push(node[1]);
     }
   }
 
-  return (() => {
-    const result = [];
-    for (node of Array.from(tree)) {
-      if ((node[0] === 'para') && Array.isArray(node[1]) && (node[1][0] === 'img')) {
-        // compile the code
-        const attrs = node[1][1];
-        let code = codeBlocks[attrs.alt];
-        if (code) { code = coffee.compile(code); }
-        delete attrs.height; // used for pdf generation
-      
-        // create a PDF and run the example
-        const doc = new PDFDocument;
-        const f = `img/${imageIndex++}`;
-        var file = fs.createWriteStream(`${f}.pdf`);
-        doc.pipe(file);
-      
-        doc.translate(doc.x, doc.y);
-        doc.scale(0.8);
-        doc.x = (doc.y = 0);
-        
-        vm.runInNewContext(code, {
-          doc,
-          lorem
-        }
-        );
-      
-        delete attrs.title;
-        delete attrs.alt;
-        attrs.href = `${f}.png`;
+  for (node of tree) {
+    if ((node[0] === 'para') && Array.isArray(node[1]) && (node[1][0] === 'img')) {
+      // compile the code
+      const attrs = node[1][1];
+      let code = codeBlocks[attrs.alt];        
+      delete attrs.height; // used for pdf generation
+    
+      // create a PDF and run the example
+      const doc = new PDFDocument;
+      const f = `img/${imageIndex++}`;
+      var file = fs.createWriteStream(`${f}.pdf`);
+      doc.pipe(file);
+    
+      doc.translate(doc.x, doc.y);
+      doc.scale(0.8);
+      doc.x = (doc.y = 0);
 
-        // write the PDF, convert to PNG using the mac `sips`
-        // command line tool, and trim with graphicsmagick
-        (f =>
-          file.on('finish', () =>
-            exec(`sips -s format png ${f}.pdf --out ${f}.png`, function() {
-              fs.unlink(`${f}.pdf`);
-              return exec(`gm convert ${f}.png -trim ${f}.png`);
-            })
-          )
-        )(f);
-            
-        result.push(doc.end());
-      } else {
-        result.push(undefined);
+      vm.runInNewContext(code, {
+        doc,
+        lorem
       }
+      );
+    
+      delete attrs.title;
+      delete attrs.alt;
+      attrs.href = `${f}.png`;
+    
+      // write the PDF, convert to PNG using the mac `sips`
+      // command line tool, and trim with graphicsmagick
+      
+      file.on('finish', () =>
+        exec(`sips -s format png ${f}.pdf --out ${f}.png`, function() {
+          fs.unlink(`${f}.pdf`);
+          exec(`gm convert ${f}.png -trim ${f}.png`);
+        })
+      )      
     }
-    return result;
-  })();
+  }
 };
 
 const pages = [];
 for (let file of Array.from(files)) {
   let content = fs.readFileSync(file, 'utf8');
 
   // turn github highlighted code blocks into normal markdown code blocks
-  content = content.replace(/^```coffeescript\n((:?.|\n)*?)\n```/mg, (m, $1) => `    ${$1.split('\n').join('\n    ')}`);
+  content = content.replace(/^```javascript\n((:?.|\n)*?)\n```/mg, (m, $1) => `    ${$1.split('\n').join('\n    ')}`);
 
   const tree = markdown.parse(content);
   const headers = extractHeaders(tree);

docs/getting_started.coffee.md

@@ -13,21 +13,21 @@ Creating a PDFKit document is quite simple. Just require the `pdfkit` module
 in your CoffeeScript or JavaScript source file and create an instance of the
 `PDFDocument` class.
 
-    PDFDocument = require 'pdfkit'
-    doc = new PDFDocument
+    const PDFDocument = require('pdfkit');
+    const doc = new PDFDocument;
 
 `PDFDocument` instances are readable Node streams. They don't get saved anywhere automatically,
 but you can call the `pipe` method to send the output of the PDF document to another
 writable Node stream as it is being written. When you're done with your document, call
 the `end` method to finalize it. Here is an example showing how to pipe to a file or an HTTP response.
 
-    doc.pipe fs.createWriteStream('/path/to/file.pdf') # write to PDF
-    doc.pipe res                                       # HTTP response
+    doc.pipe(fs.createWriteStream('/path/to/file.pdf')); // write to PDF
+    doc.pipe(res);                                       // HTTP response
 
-    # add stuff to PDF here using methods described below...
+    // add stuff to PDF here using methods described below...
 
-    # finalize the PDF and end the stream
-    doc.end()
+    // finalize the PDF and end the stream
+    doc.end();
 
 The `write` and `output` methods found in PDFKit before version 0.5 are now deprecated.
 
@@ -48,27 +48,28 @@ To get a Blob from a `PDFDocument`, you should pipe it to a [blob-stream](https:
 which is a module that generates a Blob from any Node-style stream.  The following example uses Browserify to load
 `PDFKit` and `blob-stream`, but if you're not using Browserify, you can load them in whatever way you'd like (e.g. script tags).
 
-    # require dependencies
-    PDFDocument = require 'pdfkit'
-    blobStream  = require 'blob-stream'
+    // require dependencies
+    const PDFDocument = require('pdfkit');
+    const blobStream  = require('blob-stream');
 
-    # create a document the same way as above
-    doc = new PDFDocument
+    // create a document the same way as above
+    const doc = new PDFDocument;
 
-    # pipe the document to a blob
-    stream = doc.pipe(blobStream())
+    // pipe the document to a blob
+    const stream = doc.pipe(blobStream());
 
-    # add your content to the document here, as usual
+    // add your content to the document here, as usual
 
-    # get a blob when you're done
-    doc.end()
-    stream.on 'finish', ->
-      # get a blob you can do whatever you like with
-      blob = stream.toBlob('application/pdf')
+    // get a blob when you're done
+    doc.end();
+    stream.on('finish', function() {
+      // get a blob you can do whatever you like with
+      const blob = stream.toBlob('application/pdf');
 
-      # or get a blob URL for display in the browser
-      url = stream.toBlobURL('application/pdf')
-      iframe.src = url
+      // or get a blob URL for display in the browser
+      const url = stream.toBlobURL('application/pdf');
+      iframe.src = url;
+    });
 
 You can see an interactive in-browser demo of PDFKit [here](http://pdfkit.org/demo/browser.html).
 
@@ -87,8 +88,7 @@ quite simple!
 
 To add some content every time a page is created, either by calling `addPage()` or automatically, you can use the `pageAdded` event.
 
-    doc.on 'pageAdded', ->
-      doc.text "Page Title"
+    doc.on('pageAdded', () => doc.text("Page Title"));
 
 You can also set some options for the page, such as its size and orientation.
 
@@ -110,18 +110,20 @@ on all sides.
 
 For example:
 
-    # Add a 50 point margin on all sides
-    doc.addPage
-      margin: 50
+    // Add a 50 point margin on all sides
+    doc.addPage({
+      margin: 50});
 
 
-    # Add different margins on each side
-    doc.addPage
-      margins:
-        top: 50
-        bottom: 50
-        left: 72
+    // Add different margins on each side
+    doc.addPage({
+      margins: {
+        top: 50,
+        bottom: 50,
+        left: 72,
         right: 72
+      }
+    });
 
 ## Switching to previous pages
 
@@ -142,28 +144,31 @@ never need to call it.  Finally, there is a `bufferedPageRange` method, which re
 of pages that are currently buffered.  Here is a small example that shows how you might add page
 numbers to a document.
 
-    # create a document, and enable bufferPages mode
-    doc = new PDFDocument
-      bufferPages: true
+    // create a document, and enable bufferPages mode
+    let i;
+    let end;
+    const doc = new PDFDocument({
+      bufferPages: true});
 
-    # add some content...
-    doc.addPage()
-    # ...
-    doc.addPage()
+    // add some content...
+    doc.addPage();
+    // ...
+    doc.addPage();
 
-    # see the range of buffered pages
-    range = doc.bufferedPageRange() # => { start: 0, count: 2 }
+    // see the range of buffered pages
+    const range = doc.bufferedPageRange(); // => { start: 0, count: 2 }
 
-    for i in [range.start...range.start + range.count]
-      doc.switchToPage(i)
-      doc.text "Page #{i + 1} of #{range.count}"
+    for (i = range.start, end = range.start + range.count, range.start <= end; i < end; i++;) {
+      doc.switchToPage(i);
+      doc.text(`Page ${i + 1} of ${range.count}`);
+    }
 
-    # manually flush pages that have been buffered
-    doc.flushPages()
+    // manually flush pages that have been buffered
+    doc.flushPages();
 
-    # or, if you are at the end of the document anyway,
-    # doc.end() will call it for you automatically.
-    doc.end()
+    // or, if you are at the end of the document anyway,
+    // doc.end() will call it for you automatically.
+    doc.end();
 
 ## Setting document metadata