Package Exports

ascii-art-coordinate-grid

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ascii-art-coordinate-grid) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ascii-art-coordinate-grid

Read a 2D coordinate grid from an ASCII-art-like string.

When writing tests for modules that take some list of 2d coordinates as input (e.g. a polygon or an embedding of a graph), I often find it hard to make my input human readable. My data mostly looks somewhat like this:

const polygon = [
    [2, 2],
    [0, 0],
    [2, -2],
    [-3, -3],
    [-3, 0],
    [-3, 3]
]

As you can see, it's pretty hard to tell how this polygon looks like, and it gets even more complicated when you have multiple inputs. This is why I created this small module, which allows you to do the following instead:

const readGrid = require('ascii-art-coordinate-grid')
const coordinateGrid = `
. . . . . + . . . . .
. . F . . + . . . . .
. . . . . + . A . . .
. . . . . + . . . . .
+ + E + + B + + + + +
. . . . . + . . . . .
. . . . . + . C . . .
. . D . . + . . . . .
. . . . . + . . . . .
`

const points = readGrid(coordinateGrid)
const polygon = [points.A, points.B, points.C, points.D, points.E, points.F]

See #usage for more details.

Installation

npm install ascii-art-coordinate-grid

Usage

const readGrid = require('ascii-art-coordinate-grid')

const gridString = `
. . # . . . .
. . A . . . .
. . # . . . .
. . # . B . .
C # # # # # #
. . # . . . 🇪🇸
`
const options = {
    axisCellCharacter: '#', // defaults to `+`
    normalCellCharacter: '.', // defaults to `.`
    transformCoordinates: ([x, y]) => [x, y], // defaults to the identity function, is applied to all points
    groups: false // if you set this to true, you can use the same character more than once and the points object will contain Sets of coordinates per character instead of one coordinate pair per character
}

const points = readGrid(gridString, options)
// {
//     A: [0, 3],
//     B: [2, 1],
//     C: [-2, 0],
//     '🇪🇸': [4, -1]
// }

const polygon = [points.A, points.B, points.C, points['🇪🇸']]

Note that point names can be any non-whitespace human perceived characters, so even emoji 🇫🇷 or other combined characters like 나.

Contributing

If you found a bug or want to propose a feature, feel free to visit the issues page.