Add schema package with initial configuration (#968)

Introduced a dedicated schema package featuring a live editor with
real-time linting for schema definitions. The implementation includes
a new grammar and parser for Yorkie schema definitions, enabling
structured validation capabilities.

Author: hackerwins

.eslintignore

@@ -11,3 +11,6 @@ packages/sdk/lib
 
 # examples
 examples/react-tldraw/src/tldraw.d.ts
+
+# schema
+packages/schema/antlr

.github/workflows/ci.yml

@@ -41,18 +41,31 @@ jobs:
         if: steps.cache.outputs.cache-hit != 'true'
         run: pnpm install
 
-      - run: pnpm lint
-      - run: pnpm sdk build
-      - run: pnpm build:examples
-      - run: docker compose -f docker/docker-compose-ci.yml up --build -d
-      - run: pnpm sdk test:ci
+      - name: Lint
+        run: pnpm lint
 
+      - name: Build and Test SDK
+        run: |
+          pnpm sdk build
+          docker compose -f docker/docker-compose-ci.yml up --build -d
+          pnpm sdk test:ci
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v5
         with:
           files: ./coverage/lcov.info
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
+      - name: Build Examples
+        run: pnpm build:examples
+
+      - name: Build React
+        run: pnpm react build
+
+      - name: Build and Test Schema
+        run: |
+          pnpm schema build
+          pnpm schema test
+
       - name: Run benchmark
         run: pnpm sdk test:bench

.github/workflows/npm-publish.yml

@@ -50,3 +50,10 @@ jobs:
         run: pnpm publish --filter=@yorkie-js/react --no-git-checks --provenance
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Schema Build
+        run: pnpm schema build
+      - name: Schema Publish
+        run: pnpm publish --filter=@yorkie-js/schema --no-git-checks --provenance
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

examples/react-tldraw/package.json

@@ -5,7 +5,7 @@
   "type": "module",
   "scripts": {
     "dev": "vite",
-    "build": "tsc && vite build",
+    "build": "vite build",
     "preview": "vite preview"
   },
   "dependencies": {

examples/vanilla-codemirror6/package.json

@@ -13,12 +13,7 @@
     "vite": "^5.0.12"
   },
   "dependencies": {
-    "@codemirror/commands": "6.1.2",
-    "@codemirror/highlight": "^0.19.8",
-    "@codemirror/lang-markdown": "^6.0.2",
-    "@codemirror/language-data": "^6.1.0",
     "@codemirror/state": "^6.4.1",
-    "@codemirror/view": "6.23.1",
     "codemirror": "^6.0.1",
     "@yorkie-js/sdk": "workspace:*"
   }

examples/vanilla-codemirror6/src/main.ts

@@ -1,13 +1,7 @@
 /* eslint-disable jsdoc/require-jsdoc */
-import yorkie, { DocEventType } from '@yorkie-js/sdk';
 import type { EditOpInfo, OperationInfo } from '@yorkie-js/sdk';
+import yorkie, { DocEventType } from '@yorkie-js/sdk';
 import { basicSetup, EditorView } from 'codemirror';
-import { keymap } from '@codemirror/view';
-import {
-  markdown,
-  markdownKeymap,
-  markdownLanguage,
-} from '@codemirror/lang-markdown';
 import { Transaction, TransactionSpec } from '@codemirror/state';
 import { network } from './network';
 import { displayLog, displayPeers } from './utils';
@@ -144,12 +138,7 @@ async function main() {
   // 03-2. create codemirror instance
   const view = new EditorView({
     doc: '',
-    extensions: [
-      basicSetup,
-      markdown({ base: markdownLanguage }),
-      keymap.of(markdownKeymap),
-      updateListener,
-    ],
+    extensions: [basicSetup, updateListener],
     parent: editorParentElem,
   });
 

package.json

@@ -8,6 +8,7 @@
     "sdk": "pnpm --filter=@yorkie-js/sdk",
     "devtools": "pnpm --filter=@yorkie-js/devtools",
     "react": "pnpm --filter=@yorkie-js/react",
+    "schema": "pnpm --filter=@yorkie-js/schema",
     "nextjs-scheduler": "pnpm --filter=nextjs-scheduler",
     "nextjs-todolist": "pnpm --filter=nextjs-todolist",
     "react-tldraw": "pnpm --filter=react-tldraw",

packages/react/.gitignore

@@ -22,3 +22,6 @@ dist-ssr
 *.njsproj
 *.sln
 *.sw?
+
+# lib
+lib

packages/schema/.gitignore

@@ -0,0 +1,27 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+# Antlr
+*.antlr

packages/schema/README.md

@@ -0,0 +1,15 @@
+# Yorkie Schema
+
+Yorkie Schema is a library that provides a schema definition and validation for Yorkie documents.
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md) for details on submitting patches and the contribution workflow.
+
+## Contributors ✨
+
+Thanks goes to these incredible people:
+
+<a href="https://github.com/yorkie-team/yorkie-js-sdk/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=yorkie-team/yorkie-js-sdk" />
+</a>