schematic-comment v1.0.2

schematic-comment-js

Write comments with diagram detail for source code.

Capabilities

• Generate simple drawings using alphanumeric characters.
• Support for comments used in programming languages for pasting into source files.

Objectives

• To simplify the usability of the library so that developers can use it without much calculation.
• To help document code using diagrams within the source file.

Example

Here is an example using v1.0.2.

// An example in typescript
import { Box, Text, SchematicCommentBuilder, Line } from 'schematic-comment'

// conditionally include escape characters according
// to preferred language.
// SchematicCommentBuilder.setIncludeCommentEscapes(false)
// Build the schematic.
// Box.hBorderChar='-'
let characters = new SchematicCommentBuilder()
    // box to contain text 'Schematic comment'
    .draw(new Box(20, 10, { x: 3, y: 0 }))
    .draw(new Text('Schematic comment', { x: 5, y: 3 }))
    // Horizontal line going 'right'
    .draw(new Line(6, 'r', true, { x: 23, y: 2 }))
    // Box containing text 'says "Hello world!"'
    .draw(new Box(21, 5, { x: 30, y: 0 }))
    .draw(new Text('says "Hello world!"', { x: 31, y: 2 }))
    // Horizontal line going 'right'
    .draw(new Line(27, 'r', true, { x: 23, y: 5 }))
    // Box containing text 's coming soon!'
    .draw(new Box(21, 3, { x: 51, y: 4 }))
    .draw(new Text('Is coming soon!', { x: 54, y: 5 }))
    // finally 'compile' the characters
    .comment(SchematicCommentBuilder.C_MULTI_LINE)
// `characters` now contains the string of characters formatted
// with the desired figures
console.log(characters)

Output:

/**
   ********************       *********************
   *                  *       *                   *
   *                  *       *                   *
   *                  *       *                   *
   *                  *-----> *says "Hello world!"*
   *                  *       *                   *
   * Schematic comment*       *                   *
   *                  *       *********************
   *                  *                            *********************
   *                  *                            *                   *
   *                  *--------------------------> *  Is coming soon!  *
   *                  *                            *                   *
   ********************                            *                   *
                                                   *********************
*/

Versioning

The guidelines are as described by semver.

Contribute

You can make a pull request on our repository contribute.