Francis Stokes: Blog

Programming ❤️ Math

Arcsecond: Parsing in JavaScript Made Easy

images

I recently starting making a serious attempt at learning Haskell (anyone who has tried before will probably sympathise that it usually takes a couple of tries to crack it). Amongst the many cool things Haskell has to offer is an amazing parsing library that comes with the standard set of packages called Parsec, which lets you describe how to parse complex grammars in what essentially looks like natural language.

Here is how a CSV parser is implemented using Parsec. Don’t worry if you don’t understand all the syntax, the point is that the whole parser is specified in just four lines.

1
2
3
4
5
6
7
8
9
10
11

-- Taken from http://book.realworldhaskell.org/read/using-parsec.html

import Text.ParserCombinators.Parsec

csvFile = endBy line eol
line = sepBy cell (char ',')
cell = many (noneOf ",\n")
eol = char '\n'

parseCSV :: String -> Either ParseError [[String]]
parseCSV input = parse csvFile "(unknown)" input

If you want to read more checkout http://book.realworldhaskell.org

This post is not about Haskell however, but rather a library I wrote called arcsecond which is based on Parsec, with the goal of bringing that same expressivity to JavaScript.

Parser combinators

arcsecond is a parser combinator library, in which complex parsers can be built by composing simple parsers. The simplest parsers just match specific strings or characters:

1
2
3
4
5
6
7
8
9
10
11

const { digit, letter, char, str, regex } = require('arcsecond');

// digit will parse any number 0-9
// letter will parse any letter a-z or A-Z

// char and str will parse specific sequences
const getA = char ('a');
const getHello = str ('hello');

// regex will parse any given regular expression
const getLowNumbers = regex (/^[0-4]+/);

These can then be combined together with the combinators in the library.

1
2
3
4
5
6
7
8
9
10
11
12
13

const { char, str, sequenceOf, choice } = require('arcsecond');

const worldOrMarsOrVenus = choice ([
  str ('world'),
  str ('mars'),
  str ('venus')
]);

const combinedParser = sequenceOf ([
  str ('hello'),
  char (' '),
  worldOrMarsOrVenus
]);

Then the new parsers can be used with text:

1
2
3
4
5
6
7
8
9

const { parse, char, str, sequenceOf, choice } = require('arcsecond');

// parse creates a function we can use for parsing text
const parseText = parse (combinedParser);

console.log(
  parseText ('hello world')
)
// -> [ 'hello', ' ', 'world' ]

Combinators

The combinators are where it gets cool. In arcsecond a combinator is a higher order parser, which takes one or more parsers as its input and gives back a new parser that combines those in some way. If you’ve used higher order components in react like connect, withRouter, or withStyles, then you’re already familiar with the idea.

As shown above, sequenceOf is a combinator that will parse text using each of the parsers in order, collecting their results into an array.

choice, on the other hand, will try each of its parsers in order and use the first one that matches. The library contains more, like many, which takes a parser as an argument and matches as much as it can using that parser, collecting up the results in an array:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

const { parse, many, choice, str } = require('arcsecond');

const animal = choice ([
  str ('dog'),
  str ('whale'),
  str ('bear'),
  str ('ant')
]);

const manyAnimals = many (animal);

// parse creates a function we can use for parsing text
const parseText = parse (manyAnimals);

console.log(
  parseText ('dogantwhaledogbear')
)
// -> [ 'dog', 'ant', 'whale', 'dog', 'bear' ]

You can use sepBy to create a parser that matches items separated by something matched by another parser.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

const { parse, sepBy, choice, str, char } = require('arcsecond');

const animal = choice ([
  str ('dog'),
  str ('whale'),
  str ('bear'),
  str ('ant')
]);

const commaSeparated = sepBy (char (','));

const commaSeparatedAnimals = commaSeparated (animal);

// parse creates a function we can use for parsing text
const parseText = parse (commaSeparatedAnimals);

console.log(
  parseText ('dog,ant,whale,dog,bear')
)
// -> [ 'dog', 'ant', 'whale', 'dog', 'bear' ]

between will let you match items that occur between two other parsers.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

const { parse, between, sepBy, choice, str, char } = require('arcsecond');

const animal = choice ([
  str ('dog'),
  str ('whale'),
  str ('bear'),
  str ('ant')
]);

const betweenBrackets = between (char ('[')) (char (']'));
const commaSeparated = sepBy (char (','));

const commaSeparatedAnimals = commaSeparated (animal);
const arrayOfAnimals = betweenBrackets (commaSeparatedAnimals);

// parse creates a function we can use for parsing text
const parseText = parse (arrayOfAnimals);

console.log(
  parseText ('[dog,ant,whale,dog,bear]')
)
// -> [ 'dog', 'ant', 'whale', 'dog', 'bear' ]

Curried Functions

arcsecond makes use of curried functions. If you don’t know what a curried function is, give my article “Making Functional Programming Click” a read. If you really can’t be bothered right now, open that in another tab and read this executive summary.

A curried function is one that, if it takes more than one argument, it instead returns a new function that takes the next argument. It’s easier to see with some code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

// Normal function, just a single function taking both arguments and returning a result
function normalAdd(a, b) {
  return a + b;
}

normalAdd(1, 2);
// -> 3


// Curried function, a function that takes the first argument and then returns
// *another function*, which takes the next argument.
function curriedAdd(a) {
  return function(b) {
    return a + b;
  }
}

curriedAdd(1)(2);
// -> 3

// We can use curried functions to easily make new, more specific functions
const addOne = curriedAdd(1);

addOne(2);
// -> 3

As you can see above, curriedAdd is first called with 1. Since it then returns a function, we can go ahead and call that with 2, which finally returns the actual result.

We can use curriedAdd to create a new function by calling it with just one argument and then assigning the result to a variable. As a language, JavaScript treats functions as a first class citizen, meaning they can be passed around and assigned to variables.

This principle lies at the heart of arcsecond, and every function in the library is defined this way. sepBy take two parsers — first a separator parser, and second a value parser. Because it is curried, it is easy to create a more specific combinator like commaSeparated by only supplying the first argument.

If you’re not used to it, it will probably seem strange. But a good lesson to learn as a software developer is not to have knee-jerk bad reactions to things that you don’t immediately understand. There is usually a reason, and you’ll find a lot more value by discovering that reason rather than dismissing it.

Error Handling

If you try to parse a string which is not correctly formatted you would expect to get some kind of error message. arcsecond uses a special data type called an Either, which is either a value or an error. It’s like a Promise, which can be either Rejected or Resolved, but without the implication of being asynchronous. In an Either however, the “resolved” type is called a Right, and the “rejected” type is called a Left.

The return type of parse is an Either. You can get at the value or error like this:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

const { parse, sequenceOf, str, char } = require('arcsecond');

const parser = sequenceOf ([
  str ('hello'),
  char (' '),
  str ('world')
]);

const parseResult = parse(parser)('hello world');

// We can use the cata method, which is basically a switch/case but for types
parseResult.cata({
  Left: err => {
    // do something here with the error
  },
  Right: result => {
    // result -> [ 'hello', ' ', 'world' ] 
  }
});

However this might not fit well into your codebase if you don’t have more functional code. For that reason there are two other options. The first is to convert the Either into a Promise:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

const { parse, sequenceOf, str, char, toPromise } = require('arcsecond');

const parser = sequenceOf ([
  str ('hello'),
  char (' '),
  str ('world')
]);

const parseResult = parse(parser)('hello world');

toPromise(parseResult)
  .catch(err => {
    // do something here with the error
  })
  .then(result => {
    // result -> [ 'hello', ' ', 'world' ] 
  });

Or you can use toValue, which must be wrapped in a try/catch block:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

const { parse, sequenceOf, str, char, toValue } = require('arcsecond');

const parser = sequenceOf ([
  str ('hello'),
  char (' '),
  str ('world')
]);

const parseResult = parse(parser)('hello world');

try {
  const result = toValue(parseResult);
  // -> [ 'hello', ' ', 'world' ] 
} catch (err) {
  // do something with err
}

Something more complex: JSON

Let’s put arcsecond through its paces by using it to create a parser for JSON.

Click here to skip ahead and see the full JSON parser in one file

Values

JSON only has 7 possible values:

  • String
  • Number
  • true
  • false
  • null
  • Array
  • Object

So to write a JSON parser, we just need to write parsers for all these values.

Types

In order for our parser to be useful we need to be able to identify what we’ve parsed, and the best way to do that is to put the results into a data type, which will provide a common interface for us to interact with the JSON tree. Every type has a type name, a value, and a toString function to pretty print the structure.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

// Function to create a single-valued "type constructor"
const makeBasicType = typeName => value => ({
  type: typeName,
  value,
  toString: () => `${typeName}(${value})`
});

// Function to create a multi-valued "type constructor"
const makeMultiType = typeName => values => ({
  type: typeName,
  value: values,
  toString: () => `${typeName}(${values.map(v => v.toString()).join(', ')})`
});



const stringType = makeBasicType('String');
const numberType = makeBasicType('Number');
const booleanType = makeBasicType('Boolean');

const arrayType = makeMultiType('Array');
const objectType = makeMultiType('Object');

// For the object, we can store the key/value pairs in their own type
const keyValuePair = (key, value) => ({
  type: 'KeyValuePair',
  value: [key, value],
  toString: () => `KeyValuePair(${key.toString()}, ${value.toString()})`
});

const nullType = () => ({
  type: 'Null',
  value: null,
  toString: () => 'Null'
});



arrayType([
  stringType("hello"),
  numberType(42),
  stringType("world"),
  numberType(84),
]).toString();
// -> Array(String(hello), Number(42), String(world), Number(84))

With our types in hand let’s start with the absolute simplest of parsers: true, false and null. These are just literal strings:

1
2
3
4
5
6
7
8
9
10
11

const { parse, str, choice } = require('arcsecond');

const nullParser = str ('null') .map(nullType);
const trueParser = str ('true') .map(booleanType);
const falseParser = str ('false') .map(booleanType);

const jsonParser = choice ([
  nullParser,
  trueParser,
  falseParser
]);

The parsers in arcsecond have a map method — just like arrays —which allows you to transform the value the parser matched. With map we can put the values matched into the data types defined above.

Numbers are a bit more complex. The JSON specification has this railroad diagram showing how a number can be parsed:

images

The forks in the railroads show optionality, so the simplest number that can be matched is just 0.

Basically a numbers like:

  • 1
  • -0.2
  • 3.42e2
  • -0.4352E-235

Are all valid in JSON, while something like 03.46 is not, because no path in the railroad would allow for that.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

const {
  choice,
  sequenceOf,
  char,
  digits,
  regex,
  possibly,
  anyOfString
} = require('arcsecond');

// The possibly parser either returns what it matches or null
// We can use the possibly parser to make one that returns empty string
// instead of null, which is more useful in this case
const orEmptyString = parser => possibly (parser) .map(x => (x) ? x : '');

// We also want to get sequences of matches, but then join them back
// together afterwards, instead of being in an array
const joinedSequence = parsers => sequenceOf (parsers) .map(x => x.join(''));

const numberParser = joinedSequence ([
  orEmptyString (char ('-')),
  choice ([
    char ('0'),
    regex (/^[1-9][0-9]*/)
  ]),
  orEmptyString (joinedSequence ([
    char ('.'),
    digits
  ])),
  orEmptyString (joinedSequence([
    anyOfString ('eE'),
    orEmptyString (anyOfString ('-+')),
    digits
  ]))
]) .map (x => numberType(Number(x)));


// Now we can add the numberParser to the jsonParser
const jsonParser = choice ([
  nullParser,
  trueParser,
  falseParser,
  numberParser
]);

If you take the time to read through the numberParser, you’ll see it lines up pretty much 1:1 with the diagram above.

Let’s try strings next. A string is anything between double quotes, but it can also contain escaped quotes.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

const {
  between,
  many,
  choice,
  sequenceOf,
  char,
  anythingExcept
} = require('arcsecond');

// Like joinedSequence, we want to get many of the same matches and then join them
const joinedMany = parser => many (parser) .map(x => x.join(''));

const betweenQuotes = between (char ('"')) (char ('"'));

const stringParser = betweenQuotes (joinedMany (choice ([
  joinedSequence ([
    char ('\\'),
    char ('"')
  ]),
  anythingExcept (char ('"'))
]))) .map(stringType);

// Adding the stringParser to the jsonParser
const jsonParser = choice ([
  nullParser,
  trueParser,
  falseParser,
  numberParser,
  stringParser
]);

The anythingExcept parser comes in very handy here, and is especially expressive when compared with the image on the JSON spec website.

images

That only leaves Array and Object, which can both be pitfalls because they are basically just containers of jsonValue. To illustrate how this might go wrong, we can write the Array parser the “wrong” way first and then see how to address it.

We can use the whitespace parser — which matches zero or more whitespace characters — to ensure the the array brackets and comma operator allow for any (optional) whitespace that might be there.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

const {
  between,
  char,
  choice,
  sepBy,
  whitespace
} = require('arcsecond');

const whitespaceSurrounded = between (whitespace) (whitespace)
const betweenSquareBrackets = between (whitespaceSurrounded (char ('['))) (whitespaceSurrounded(char (']')));
const commaSeparated = sepBy (whitespaceSurrounded (char (',')));

const arrayParser = betweenSquareBrackets (commaSeparated (jsonParser)) .map(arrayType);

const jsonParser = choice ([
  nullParser,
  trueParser,
  falseParser,
  numberParser,
  stringParser,
  arrayParser
]);

// ReferenceError: jsonParser is not defined

Because arrayParser is defined in terms of jsonParser, and jsonParser is defined in terms of arrayParser, we run into a ReferenceError. If we moved the definition of arrayParser below jsonParser, we’d still have the same problem. We can fix this by wrapping the jsonParser in a special parser, aptly named recursiveParser. The argument to recursiveParser is a thunk, which will allow us to reference variables that are not yet in scope.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

const {
  between,
  char,
  choice,
  sepBy,
  whitespace,
  recursiveParser
} = require('arcsecond');

const whitespaceSurrounded = between (whitespace) (whitespace)
const betweenSquareBrackets = between (whitespaceSurrounded (char ('['))) (whitespaceSurrounded(char (']')));
const commaSeparated = sepBy (whitespaceSurrounded (char (',')));

// Move this parser to the top, and wrap it in a recursiveParser,
// which takes a function that returns a parser
const jsonParser = recursiveParser (() => choice ([
  nullParser,
  trueParser,
  falseParser,
  numberParser,
  stringParser,
  arrayParser
]));

const arrayParser = betweenSquareBrackets (commaSeparated (jsonParser)) .map(arrayType);

Implementing the arrayParser is actually quite trivial — as simple as JSON values, separated by commas, in square brackets.

Object is only marginally more complex. The values in an object are pairs of strings some other JSON value, with a colon as a separator.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

const {
  between,
  char,
  choice,
  sepBy,
  whitespace,
  recursiveParser
} = require('arcsecond');

const betweenCurlyBrackets = between (whitespaceSurrounded (char ('{'))) (whitespaceSurrounded(char ('}')));

const jsonParser = recursiveParser (() => choice ([
  nullParser,
  trueParser,
  falseParser,
  numberParser,
  stringParser,
  arrayParser,
  objectParser
]));

const keyValuePairParser = sequenceOf ([
  stringParser,
  whitespaceSurrounded (char (':')),
  jsonParser
]) .map(([key, _, value]) => keyValuePair(key, value));

const objectParser = betweenCurlyBrackets (commaSeparated (keyValuePairParser)) .map(objectType);

And that’s it. The jsonValue can be used to parse a JSON document in it’s entirety. The full parser can be found here as a gist.

Bonus Parser: CSV

Since I opened up with a CSV parser in Haskell, let’s see how that would look in arcsecond. I’ll keep it minimal and forgo creating data types to hold the values, and some extra strengthening that the Parsec version also doesn’t have.

The result should be an array of arrays — the outer array holds “lines” and the inner arrays contain the elements of the line.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

const {
  parse,
  char,
  many,
  regex,
  anythingExcept,
  sepBy
} = require('arcsecond');

const joinedMany = parser => many (parser) .map(x => x.join(''));

const cell = joinedMany (anythingExcept (regex (/^[,\n]/)));
const cells = sepBy (char (',')) (cell);
const parser = sepBy (char ('\n')) (cells);

const data = `
1,React JS,"A declarative efficient and flexible JavaScript library for building user interfaces"
2,Vue.js,"Vue.js is a progressive incrementally-adoptable JavaScript framework for building UI on the web."
3,Angular,"One framework. Mobile & desktop."
4,ember.js,"Ember.js - A JavaScript framework for creating ambitious web applications"`;

console.log(
  parse (parser) (data)
);
// -> [
//   [ '' ],
//   [ '1', 'React JS', '"A declarative efficient and flexible JavaScript library for building user interfaces"' ],
//   [ '2', 'Vue.js', '"Vue.js is a progressive incrementally-adoptable JavaScript framework for building UI on the web."' ],
//   [ '3', 'Angular', '"One framework. Mobile & desktop."' ],
//   [ '4', 'ember.js', '"Ember.js - A JavaScript framework for creating ambitious web applications"' ],
// ]

Conclusion

There are quite a few key features of arcsecond that didn’t get a mention in this article, including the fact it can parse context sensitive languages, and the parsing model is based on a Fantasy Land -compliant Monad. My main goal with this project was to bring the same level of expressivity that Parsec has to JavaScript, and I hope I’ve been able to do that.

Please check out the project on github along with all the API docs and examples, and think of arcsecond the next time you find yourself writing an incomprehensible spaghetti regex — you might be using the wrong tool for the job! You can install the latest version with:

npm i arcsecond