platform-bible-utils
    Preparing search index...

    platform-bible-utils

    Platform.Bible Utils

    A set of utility functions, types, and classes for use inside Platform.Bible and extensions.

    Inspired by https://github.com/jasonsturges/vite-typescript-npm-package

    When we publish this npm package, then in the root package.json, a version can be given to platform-bible-utils instead of the existing file link. At that time we will likely need to use npm link and npm unlink to develop the components (see here).

    TODO:

    • [ ] Decide if this package will be public, if not it will probably need an NPM organization setup to publish it to privately.
    • [ ] What NPM user login will we use to publish it (each developer or an app-wide user)?

    To set up the dev environment to build, you must run the following from paranext-core:

    npm i
    

    Once you have set up your environment, you can run the build command in this folder to build platform-bible-utils:

    npm run build
    

    Or you can build from paranext-core:

    npm run build:platform-bible-utils
    

    If you want a quick build that doesn't lint, run the following:

    npm run build:basic
    

    Do not commit changes after running this basic build. Before committing, always run a full build.