Security News
Highlights from the 2024 Rails Community Survey
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
@stackbit/sdk
Advanced tools
Stackbit SDK contains set of utilities to work with stackbit.yaml file.
npm install @stackbit/sdk
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 });
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);
});
FAQs
Stackbit SDK
The npm package @stackbit/sdk receives a total of 23,137 weekly downloads. As such, @stackbit/sdk popularity was classified as popular.
We found that @stackbit/sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 16 open source maintainers collaborating on the project.
Did you know?
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.
Security News
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.