cbs-block 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +55 -0
- package/package.json +6 -2
package/README.md
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# cbs-block SDK 🚀
|
|
2
|
+
|
|
3
|
+
The official toolkit for building **CodeBlock Studio** extensions. Create, package, and share powerful visual blocks with ease.
|
|
4
|
+
|
|
5
|
+
## 📦 Installation
|
|
6
|
+
|
|
7
|
+
Install the CLI globally to use the `cbs-block` command anywhere:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install cbs-block -g
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## 🚀 Quick Start
|
|
14
|
+
|
|
15
|
+
### 1. Initialize a Project
|
|
16
|
+
Create a new workspace for your block library:
|
|
17
|
+
```bash
|
|
18
|
+
cbs-block init MyAwesomeBlocks
|
|
19
|
+
cd MyAwesomeBlocks
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### 2. Create your First Block
|
|
23
|
+
Generate a template for a new block. Choose a category like `Math`, `Logic`, or `Control`:
|
|
24
|
+
```bash
|
|
25
|
+
cbs-block create SimpleAdd Math
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### 3. Build & Package
|
|
29
|
+
When you're ready to share, bundle your blocks into a `.cbspak` file:
|
|
30
|
+
```bash
|
|
31
|
+
cbs-block build
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## 🛠️ Command Reference
|
|
35
|
+
|
|
36
|
+
| Command | Description |
|
|
37
|
+
| --- | --- |
|
|
38
|
+
| `init <Name>` | Creates a new block development workspace. |
|
|
39
|
+
| `create <Name> [Category]` | Generates a new `.cbsblock` template. |
|
|
40
|
+
| `list` | Lists all blocks in the current directory. |
|
|
41
|
+
| `lint` | Validates your blocks against the Studio schema. |
|
|
42
|
+
| `build` | Packages your project into a `.cbspak` for the marketplace. |
|
|
43
|
+
| `serve` | Starts a local hot-reload server for real-time testing. |
|
|
44
|
+
| `publish` | Deploys your package to the CBS Marketplace. |
|
|
45
|
+
|
|
46
|
+
## 🧩 What is a .cbsblock?
|
|
47
|
+
A block is a JSON file that defines its visuals and its logic.
|
|
48
|
+
- **Visuals**: Ports (Input/Output/Flow) and interactive fields.
|
|
49
|
+
- **Logic**: A sandboxed JavaScript function that executes within the Studio.
|
|
50
|
+
|
|
51
|
+
## 🔒 The CBS Ecosystem
|
|
52
|
+
Note: `.cbspak` and `.cbsblock` files are proprietary formats optimized for **CodeBlock Studio**. They cannot be opened in standard text editors or other IDEs without the CBS engine.
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
**Build the future of visual coding with CodeBlock Studio.**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "cbs-block",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "SDK for creating CodeBlock Studio blocks",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"bin": {
|
|
@@ -9,7 +9,11 @@
|
|
|
9
9
|
"scripts": {
|
|
10
10
|
"test": "echo \"Error: no test specified\" && exit 1"
|
|
11
11
|
},
|
|
12
|
-
"keywords": [
|
|
12
|
+
"keywords": [
|
|
13
|
+
"cbs",
|
|
14
|
+
"codeblock",
|
|
15
|
+
"visual-programming"
|
|
16
|
+
],
|
|
13
17
|
"author": "CBS Team",
|
|
14
18
|
"license": "MIT"
|
|
15
19
|
}
|