fbschema

A simple library to generate TypeScript definition files as well as Firestore rules based on a JSON Schema definition.

WARNING

This is a WIP library and currently only generates TypeScript interfaces, as well as may be buggy. Use at your own risk and feel free to contribute!

Table of Contents

• Downloading
• Documentation
• Contributing

Downloading

You can install fbschema via npm:

npm install fbschema

Documentation

This library expects a JSON Schema for each Firestore collection in the root of your porject in a folder called fbschema. From there it will generate TypeScript definition files into the a types/fbschema folder as well as (one day soon) creating a new firestore.rules file.

You can do this from the command line:

# If you're in the root of your project
npx fbschema

# Or you can pass in a path to your project's root
npx fbschema ~/workspace/my-cool-firebase-project

You can also use this library in your code:

import fbschema from 'fbschema';

// If you're running this code from your project's root
fbschema();


// You can also provide a path to your project's root
fbschema('../');

Contributing

All code should pass tests, as well as be well documented. Please also see the Commit Message Guidelines for how commit messages should be structured.