Natural Pacifist Manatees

    sourcebit-sample-plugin

    0.3.1 • Public • Published

    sourcebit-sample-plugin

    npm version

    A sample plugin for Sourcebit

    👩‍🏫 Introduction

    This is a simple Sourcebit plugin for development and educational purposes. It retrieves entries from a remote API located at https://jsonplaceholder.typicode.com/. If the watch option is supplied, one of the entries will be randomly picked every 3 seconds and a string containing "(updated)" will be appended to the body field.

    For details on how Sourcebit plugins work and the requirements for creating a new plugin, please check out contribution guidelines.

    For a step-by-step walkthrough on building a Sourcebit plugin, check out our tutorial at: https://www.stackbit.com/blog/sourcebit-plugin/

    🏗 Installation

    To install the plugin and add it to your project, run:

    npm install sourcebit-sample-plugin --save
    

    💡 You don't need to run this command if you start Sourcebit using the interactive setup process, as the CLI will install the plugin for you and add it as a dependency to your project.

    ⚙️ Configuration

    The plugin accepts the following configuration parameters. They can be supplied in any of the following ways:

    • In the options object of the plugin configuration block inside sourcebit.js, with the value of the Property column as a key;
    • As an environment variable named after the Env variable column, when running the sourcebit fetch command;
    • As part of a .env file, with the value of the Env variable column separated by the value with an equals sign (e.g. MY_VARIABLE=my-value);
    • As a CLI parameter, when running the sourcebit fetch command, using the value of the Parameter column as the name of the parameter (e.g. sourcebit fetch --my-parameter).
    Property Type Visibility Default value Env variable Parameter Description
    mySecret String Private MY_SECRET A secret value. Not actually used by the plugin, purely for demonstration purposes.
    watch Boolean Public false watch Whether to update entries on a regular interval.
    titleCase Boolean Public false Whether to convert the value of the title field to title-case

    👀 Example configuration

    sourcebit.js

    module.exports = {
        plugins: [
            {
                module: require('sourcebit-sample-plugin'),
                options: {
                    titleCase: true
                }
            }
        ]
    };

    🧞‍♂️ Interactive setup process

    This plugin offers an interactive setup process via the npx create-sourcebit command.

    📥 Input

    N/A

    📤 Output

    This plugin adds normalized entries to the objects data bucket and normalized model objects to the models data bucket.

    👷🏻‍♀️ Development

    The example directory contains a basic installation of Sourcebit with this sample plugin installed and configured. It's a good way to develop a plugin locally.

    To run it, run:

    cd example
    npm install
    
    # Run Sourcebit in the command-line
    npm run sourcebit-cli
    
    # Run Sourcebit in a Node.js application
    npm run sourcebit-node

    Install

    npm i sourcebit-sample-plugin

    DownloadsWeekly Downloads

    2

    Version

    0.3.1

    License

    MIT

    Unpacked Size

    27.5 kB

    Total Files

    9

    Last publish

    Collaborators

    • drkstr101
    • stackbitjoe
    • arseny.gurevich
    • eladroz
    • smnh
    • weissrami
    • tomasb
    • ohadpr
    • rodikh
    • berdav
    • stackbit-admin
    • vitaliyr
    • denar90
    • youvalv
    • ievgenii