You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP
Socket
Book a DemoInstallSign in
Socket

@stackbit/sdk

Package Overview
Dependencies
Maintainers
16
Versions
440
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@stackbit/sdk

Stackbit SDK

0.2.16
Source
npm
Version published
Weekly downloads
107K
-9.27%
Maintainers
16
Weekly downloads
 
Created
Source

Stackbit SDK

Stackbit SDK contains set of utilities to work with stackbit.yaml file.

Add to your project

npm install @stackbit/sdk

Generate stackbit.yaml

Create a FileBrowser with FileSystemFileBrowserAdapter or GitHubFileBrowserAdapter:

  • Analyzing a local project:

    import { FileSystemFileBrowserAdapter, FileBrowser } from '@stackbit/sdk';
    
    const fileBrowserAdapter = new FileSystemFileBrowserAdapter({ dirPath: inputDir });
    const fileBrowser = new FileBrowser({ fileBrowserAdapter });
    
  • Analyzing a remote GitHub project:

    import { GitHubFileBrowserAdapter, FileBrowser } from '@stackbit/sdk';
    
    const fileBrowserAdapter = new GitHubFileBrowserAdapter({
        owner: 'stackbit',
        repo: 'theme',
        branch: 'master',
        auth: GITHUB_PERSONAL_ACCESS_TOKEN
    });
    const fileBrowser = new FileBrowser({ fileBrowserAdapter });
    

Then, pass the fileBrowser to the analyzeSite() method, get the result and save the config as stackbit.yaml:

import { writeConfig, analyzeSite } from '@stackbit/sdk';

const analyzeResult = await analyzeSite({ fileBrowser });
await writeConfig({ dirPath: inputDir, config: analyzeResult.config });

Validate stackbit.yaml

Load and validate stackbit.yaml. Any errors will be returned within the errors array.

import { loadConfig } from '@stackbit/sdk';

const configResult = await loadConfig({ dirPath: inputDir });

configResult.errors.forEach((error) => {
    console.log(error.message);
});

If configResult.config is not null, pass it to load and validate web-site's content. Any errors will be returned within the errors array, and loaded content within the contentItems:

import { loadContent } from '@stackbit/sdk';

if (configResult.config) {
    return;
}

const contentResult = await loadContent({ dirPath: inputDir, config: configResult.config });

contentResult.contentItems.forEach((contentItem) => {
    console.log(contentItem.__metadata.filePath);
});

contentResult.errors.forEach((error) => {
    console.log(error.message);
});

Keywords

stackbit

FAQs

Package last updated on 07 Nov 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts