@curvenote/cli-plugin/dist/directives/collections.js

MyST Plugins for Curvenote

import { validateStringOptions, makePlaceholder } from '../utils.js';
export const collectionsDirective = {
    name: 'cn:collections',
    doc: 'Create a listing of all collections available in the venue.',
    options: {
        venue: {
            type: String,
            doc: 'The venue to list collections from.',
            required: true,
        },
        filter: {
            type: String,
            doc: 'The status of collections to list (open | closed | all).',
            required: false,
        },
        exclude: {
            type: String,
            doc: 'Collections to ignore, by name and comma separated.',
            required: false,
        },
        'show-count': {
            type: Boolean,
            doc: 'If set to true, the number of items in the collection will be shown.',
            required: false,
        },
    },
    validate(data, vfile) {
        if (!data.options?.venue) {
            vfile.message('A venue must be supplied.');
        }
        if (data.options?.exclude && typeof data.options?.exclude !== 'string') {
            vfile.message('exclude list should be a string of comma separated collection names.');
        }
        validateStringOptions(vfile, 'show', data.options?.show, ['open', 'closed', 'all']);
        return data;
    },
    run(data) {
        return [
            {
                type: 'curvenoteCollections',
                ...data.options,
                show: data.options?.show ?? 'all',
                children: makePlaceholder(data, `a live listing of collectons from ${data.options?.venue}`),
            },
        ];
    },
};