百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
S

scrollsdk

> 编程语言
开源

Scroll 所基于的粒子和解析器代码。

387 stars0 点赞1 次浏览
访问官网GitHub

工具介绍

Scroll 所基于的粒子和解析器代码。

ScrollSDK

A powerful SDK for building and extending Scroll with Particles and Parsers.

Quick Links

  • Scroll Homepage
  • The World Wide Scroll
  • Particles Homepage
  • Particles FAQ
  • WWS Subreddit

️ Tools

  • Parser Designer - Web IDE for writing Parsers
  • Particles Sandbox - Interactive environment for exploring Particles

Documentation

  • SDK Release Notes
  • Particles FAQ

Tests

  • ScrollSDK Node Tests
  • ScrollSDK Browser Unit Tests
  • ScrollSDK Browser Performance Tests

❓ FAQ

What is this repo?

This repository contains the code for Particle Syntax and the Parsers Programming Language. These are the core layers upon which Scroll is built.

Who is this for?

This repo is for advanced Scroll developers.

How do I write Parsers?

You can try the Parsers tutorial.

Writing Parsers

The ScrollSDK contains two implementations of Parsers: one in TypeScript and one in Parsers.

You write Parsers to extend Scroll. By creating Parsers with the SDK you get:

  • A parser
  • A type checker
  • Syntax highlighting
  • Autocomplete
  • A compiler
  • A virtual machine for executing your version of Scroll

The ScrollSDK also includes a simple web IDE for writing Parsers called Parser Designer.

At this point in time, to make your Parsers do very useful things, you also need to use another language that you know. The ScrollSDK lets you create new languages using just Scroll or Scroll + Javascript. Parsers can include code from any programming language, not just Javascript. Though at the moment only Scroll + Javascript is supported.

Using the ScrollSDK

Basic Particles library for npm projects:

javascript
const {Particle} = require("scrollsdk/products/Particle.js")
const particle = new Particle("hello world")
console.log(particle.asString)

Running the Particles Sandbox locally:

bash
npm install .
npm run local
open http://localhost:3333/

Running the Parser Designer locally:

bash
npm install .
npm run local
open http://localhost:3333/designer

Building all tools and running tests:

bash
npm run build
npm test

Monorepo Structure

The ScrollSDK is a monorepo. With on average over 1 major version released each month for the past 2.5 years, it would take a lot of overhead to constantly be updating 10+ different repositories and modules every month. Once we're more confident in the theory and best practices, it might make sense to break this repo into independent modules.

That being said, we despise unnecessary dependencies as much as anyone. If anyone wants to create some automated submodules built from the projects in this monorepo, to allow for consuming of a smaller subset of the code and dependencies in this module, feel free to do so.

Codebase Visualization

Development Status

All breaking changes are mentioned in the release notes. We follow semantic versioning, so breaking changes should not happen if you stay on the same major version.

Particles Libraries in Other Languages

If you build a Particles library/SDK in another language, let us know and we'll add a link.

If you are working on a Particles library in a new host language, feel free to post an issue or ask for help in the WWS subreddit.

Development Notes

How to bump versions:

bash
npm run updateVersion NEW_NUMBER

Historical Note

Particles was originally called Tree Notation. Parsers was originally called Grammar.

Editing in Sublime Text

It is helpful to set "goto_anything_exclude_gitignore": true to ignore files in gitignore. Read more here.

⚡ Alternatives Considered

This is the first Particles and Parsers libraries in existence, so there were no alternative implementations. Note and Space were predecessors to Particles. If a better alternative low level syntax to Particles is possible, it has yet to be discovered.

All that said, the important part of this repo is not the code but the design patterns. Particles is very simple, and you can implement the patterns contained here in your own code without using this library. In fact, that is often the best way to use Particles!

Public Domain

ScrollSDK is published to the Public Domain.

Issues· 0 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

JavaScriptscroll

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月17日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言