"Parses" scrapiyard documentation entries to ensure they are properly formatted to follow the specs. Details about the parsing process are outlined here.

This can be ran standalone for quick local validation, or added as an npm dependency when writing documentation-related projects.

Usage

Validating locally

A dump script can be run locally to generate a JSON file with the validated entries, or an error file. It only runs Steps 1 to 4 in the parsing pipeline.

By default, the script will look for an /api/ folder in the current working directory, so the quickest way to use it is installing and running factory directly inside the scrapiyard folder:

• Clone the scrapiyard repo if you don't have a local copy yet.
  • git clone https://github.com/ProjectIgnis/scrapiyard
• Navigate to the scrapiyard folder.
  • cd scrapiyard
• Install factory.
  • npm i @that-hatter/scrapi-factory
• Run the dump script.
  • npx dump
• Check the /dump/ folder for the output (or error).

You can also install factory elsewhere, but you'll need to provide the api path to the dump command using the --api-path option:

• npx dump -- --api-path="path/to/api"

As a Typescript Package

The parser package can be installed with npm.

npm i @that-hatter/scrapi-factory

It provides loader functions that return strictly-typed parsed outputs. A utility module for working with markdown AST is also included.

The most relevant function is loadYard. It is recommended to use fp-ts for the least amount of friction. Parts of the library are also re-exported with conventional acronyms and additional functions, under the /fp export.

import * as sf from '@that-hatter/scrapi-factory';
import { pipe, TE } from '@that-hatter/scrapi-factory/fp';

const program = pipe(
  sy.loadYard(sy.DEFAULT_OPTIONS),
  TE.map(({ api }) => {
    // ...
  })
);

There are also more granular functions that perform specific steps, such as loadAPI, loadRawAPI, and loadSourceRecord. See dump.ts for an example usage.

If not using fp-ts, you will need to call the result returned by loadYard to get a Promise, and manually check if the wrapped value is a Right (meaning successful) value.

import * as sf from '@that-hatter/scrapi-factory';
import { E } from '@that-hatter/scrapi-factory/fp';

const yard = await sf.loadYard(sy.DEFAULT_OPTIONS)();

if (E.isRight(yard)) {
  const { api } = yard.right;
  // ...
} else {
  throw yard.left;
}

You'll also need to handle Option types when they come up. You can use O.toNullable to convert O.Option<T> into T | null.

import { O } from '@that-hatter/scrapi-factory/fp';

const fnDocSummary = O.toNullable(fnDocEntry.summary);