Refactor package names to include scope

.github/workflows/npm-publish.yml

@@ -38,6 +38,6 @@ jobs:
         run: pnpm install
 
       - run: pnpm sdk build
-      - run: pnpm publish --filter=yorkie-js-sdk --no-git-checks --provenance
+      - run: pnpm publish --filter=@yorkie-js/sdk --no-git-checks --provenance
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

examples/nextjs-scheduler/app/page.tsx

@@ -9,7 +9,7 @@ import React, { useEffect, useState } from 'react';
 import { ContentTypes, ENVtypes } from './utils/types';
 import { displayPeers, createRandomPeers } from './utils/handlePeers';
 import { parseDate } from './utils/parseDate';
-import yorkie, { Document, JSONArray, DocEventType } from 'yorkie-js-sdk';
+import yorkie, { Document, JSONArray, DocEventType } from '@yorkie-js/sdk';
 import Scheduler from './Scheduler';
 
 // parseDate() value's format = "DD-MM-YYYY"

examples/nextjs-scheduler/app/utils/handlePeers.ts

@@ -1,4 +1,4 @@
-import { Indexable } from 'yorkie-js-sdk';
+import { Indexable } from '@yorkie-js/sdk';
 
 const randomPeers = [
   'Alice',

examples/nextjs-scheduler/package.json

@@ -13,7 +13,7 @@
     "react": "18.2.0",
     "react-calendar": "^4.6.0",
     "react-dom": "18.2.0",
-    "yorkie-js-sdk": "workspace:*"
+    "@yorkie-js/sdk": "workspace:*"
   },
   "devDependencies": {
     "@types/node": "20.4.2",

examples/nextjs-scheduler/tsconfig.json

@@ -21,8 +21,8 @@
     ],
     "paths": {
       "@/*": ["./*"],
-      "@yorkie-js-sdk/src/*": ["../../packages/sdk/src/*"],
-      "react": ["./node_modules/@types/react"]
+      "react": ["./node_modules/@types/react"],
+      "@yorkie-js-sdk/src/*": ["../../packages/sdk/src/*"]
     }
   },
   "include": [

examples/profile-stack/main.js

@@ -1,4 +1,4 @@
-import yorkie, { DocEventType } from 'yorkie-js-sdk';
+import yorkie, { DocEventType } from '@yorkie-js/sdk';
 import { getRandomName, getRandomColor } from './util.js';
 
 async function main() {

examples/profile-stack/package.json

@@ -12,6 +12,6 @@
     "vite": "^5.0.12"
   },
   "dependencies": {
-    "yorkie-js-sdk": "workspace:*"
+    "@yorkie-js/sdk": "workspace:*"
   }
 }

examples/react-tldraw/package.json

@@ -17,7 +17,7 @@
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "unique-names-generator": "^4.7.1",
-    "yorkie-js-sdk": "workspace:*"
+    "@yorkie-js/sdk": "workspace:*"
   },
   "devDependencies": {
     "@types/lodash": "^4.14.198",

examples/react-tldraw/src/hooks/types.ts

@@ -1,6 +1,6 @@
 // Yorkie type for typescript
 import type { TDAsset, TDBinding, TDShape, TDUser } from '@tldraw/tldraw';
-import type { JSONObject } from 'yorkie-js-sdk';
+import type { JSONObject } from '@yorkie-js/sdk';
 export type Options = {
   apiKey?: string;
   syncLoopDuration: number;

examples/react-tldraw/src/hooks/useMultiplayerState.ts

@@ -9,7 +9,7 @@ import {
   TldrawApp,
 } from '@tldraw/tldraw';
 import { useThrottleCallback } from '@react-hook/throttle';
-import * as yorkie from 'yorkie-js-sdk';
+import * as yorkie from '@yorkie-js/sdk';
 import randomColor from 'randomcolor';
 import { uniqueNamesGenerator, names } from 'unique-names-generator';
 import _ from 'lodash';

examples/react-todomvc/package.json

@@ -13,7 +13,7 @@
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "todomvc-app-css": "^2.4.2",
-    "yorkie-js-sdk": "workspace:*"
+    "@yorkie-js/sdk": "workspace:*"
   },
   "devDependencies": {
     "@types/react": "^18.2.0",

examples/react-todomvc/src/App.tsx

@@ -1,5 +1,5 @@
 import React, { useState, useEffect } from 'react';
-import yorkie, { Document, JSONArray } from 'yorkie-js-sdk';
+import yorkie, { Document, JSONArray } from '@yorkie-js/sdk';
 import 'todomvc-app-css/index.css';
 
 import Header from './Header';

examples/simultaneous-cursors/package.json

@@ -11,7 +11,7 @@
   "dependencies": {
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "yorkie-js-sdk": "workspace:*"
+    "@yorkie-js/sdk": "workspace:*"
   },
   "devDependencies": {
     "@types/react": "^18.2.0",

examples/simultaneous-cursors/src/App.jsx

@@ -1,5 +1,5 @@
 import { useEffect, useState } from 'react';
-import yorkie from 'yorkie-js-sdk';
+import yorkie from '@yorkie-js/sdk';
 import Cursor from './components/Cursor';
 import CursorSelections from './components/CursorSelections';
 import './App.css';

examples/vanilla-codemirror6/package.json

@@ -20,6 +20,6 @@
     "@codemirror/state": "^6.4.1",
     "@codemirror/view": "6.23.1",
     "codemirror": "^6.0.1",
-    "yorkie-js-sdk": "workspace:*"
+    "@yorkie-js/sdk": "workspace:*"
   }
 }

examples/vanilla-codemirror6/src/main.ts

@@ -1,6 +1,6 @@
 /* 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 type { EditOpInfo, OperationInfo } from '@yorkie-js/sdk';
 import { basicSetup, EditorView } from 'codemirror';
 import { keymap } from '@codemirror/view';
 import {

examples/vanilla-codemirror6/src/network.ts

@@ -1,4 +1,4 @@
-import { DocEvent, StreamConnectionStatus } from 'yorkie-js-sdk';
+import { DocEvent, StreamConnectionStatus } from '@yorkie-js/sdk';
 export const network = {
   isOnline: false,
   showOffline: (elem: HTMLElement) => {

examples/vanilla-codemirror6/src/type.ts

@@ -1,4 +1,4 @@
-import { TextPosStructRange, type Text } from 'yorkie-js-sdk';
+import { TextPosStructRange, type Text } from '@yorkie-js/sdk';
 
 export type YorkieDoc = {
   content: Text;

examples/vanilla-codemirror6/src/utils.ts

@@ -1,5 +1,5 @@
 /* eslint-disable jsdoc/require-jsdoc */
-import { Document, Indexable } from 'yorkie-js-sdk';
+import { Document, Indexable } from '@yorkie-js/sdk';
 import { YorkieDoc } from './type';
 
 // function to display peers

examples/vanilla-quill/package.json

@@ -19,6 +19,6 @@
     "quill": "^1.3.7",
     "quill-cursors": "^4.0.0",
     "quill-delta": "^5.0.0",
-    "yorkie-js-sdk": "workspace:*"
+    "@yorkie-js/sdk": "workspace:*"
   }
 }

examples/vanilla-quill/src/main.ts

@@ -1,5 +1,5 @@
 /* eslint-disable jsdoc/require-jsdoc */
-import yorkie, { DocEventType, Indexable, OperationInfo } from 'yorkie-js-sdk';
+import yorkie, { DocEventType, Indexable, OperationInfo } from '@yorkie-js/sdk';
 import Quill, { type DeltaOperation, type DeltaStatic } from 'quill';
 import QuillCursors from 'quill-cursors';
 import ColorHash from 'color-hash';

examples/vanilla-quill/src/network.ts

@@ -1,4 +1,4 @@
-import { DocEvent, StreamConnectionStatus } from 'yorkie-js-sdk';
+import { DocEvent, StreamConnectionStatus } from '@yorkie-js/sdk';
 export const network = {
   isOnline: false,
   showOffline: (elem: HTMLElement) => {

examples/vanilla-quill/src/type.ts

@@ -1,4 +1,4 @@
-import { type Text, TextPosStructRange } from 'yorkie-js-sdk';
+import { type Text, TextPosStructRange } from '@yorkie-js/sdk';
 
 export type YorkieDoc = {
   content: Text;

examples/vanilla-quill/src/utils.ts

@@ -1,5 +1,5 @@
 /* eslint-disable jsdoc/require-jsdoc */
-import { Document, Indexable } from 'yorkie-js-sdk';
+import { Document, Indexable } from '@yorkie-js/sdk';
 import { YorkieDoc, YorkiePresence } from './type';
 
 // function to display peers

examples/vuejs-kanban/package.json

@@ -8,7 +8,7 @@
   },
   "dependencies": {
     "vue": "^3.2.41",
-    "yorkie-js-sdk": "workspace:*"
+    "@yorkie-js/sdk": "workspace:*"
   },
   "devDependencies": {
     "@vitejs/plugin-vue": "^5.0.3",

examples/vuejs-kanban/src/App.vue

@@ -1,5 +1,5 @@
 <script>
-import yorkie from 'yorkie-js-sdk';
+import yorkie from '@yorkie-js/sdk';
 
 const defaultLists = [
   {

package.json

@@ -5,9 +5,9 @@
   "description": "A collection of tools and examples for Yorkie",
   "scripts": {
     "preinstall": "npx only-allow pnpm",
-    "sdk": "pnpm --filter=yorkie-js-sdk",
-    "create-yorkie-app": "pnpm --filter=create-yorkie-app",
-    "devtools": "pnpm --filter=yorkie-devtools",
+    "sdk": "pnpm --filter=@yorkie-js/sdk",
+    "create-yorkie-app": "pnpm --filter=@yorkie-js/create-yorkie-app",
+    "devtools": "pnpm --filter=@yorkie-js/devtools",
     "nextjs-scheduler": "pnpm --filter=nextjs-scheduler",
     "react-tldraw": "pnpm --filter=react-tldraw",
     "profile-stack": "pnpm --filter=profile-stack",
@@ -27,11 +27,11 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "eslint": "^8.19.0",
-    "husky": "^9.1.5",
-    "lint-staged": "^15.2.9",
-    "only-allow": "^1.2.1",
-    "eslint-plugin-jsdoc": "^39.3.3",
-    "eslint-plugin-prettier": "^5.0.0"
+    "eslint": "^8.57.1",
+    "eslint-plugin-jsdoc": "^39.9.1",
+    "eslint-plugin-prettier": "^5.2.3",
+    "husky": "^9.1.7",
+    "lint-staged": "^15.4.3",
+    "only-allow": "^1.2.1"
   }
 }

packages/create-yorkie-app/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "create-yorkie-app",
+  "name": "@yorkie-js/create-yorkie-app",
   "version": "0.4.7-fix.1",
   "bin": {
     "create-yorkie-app": "dist/create-yorkie-app.mjs"

packages/devtools/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "yorkie-devtools",
+  "name": "@yorkie-js/devtools",
   "displayName": "Yorkie Devtools",
   "version": "0.4.28",
   "description": "A browser extension that helps you debug Yorkie.",
@@ -20,7 +20,7 @@
     "react-dom": "18.2.0",
     "react-resizable-layout": "^0.7.2",
     "use-resize-observer": "^9.1.0",
-    "yorkie-js-sdk": "workspace:*"
+    "@yorkie-js/sdk": "workspace:*"
   },
   "devDependencies": {
     "@types/chrome": "0.0.251",

packages/devtools/src/content.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import type { FullSDKToPanelMessage } from 'yorkie-js-sdk';
-import { EventSourceDevPanel, EventSourceSDK } from 'yorkie-js-sdk';
+import type { FullSDKToPanelMessage } from '@yorkie-js/sdk';
+import { EventSourceDevPanel, EventSourceSDK } from '@yorkie-js/sdk';
 
 let panelPort = null;
 

packages/devtools/src/devtools/components/Detail.tsx

@@ -20,7 +20,7 @@ import { useState, useCallback } from 'react';
 import { Code } from './Code';
 import type { RootTreeNode } from './Tree';
 import { CodeIcon, GraphIcon } from '../icons';
-import type { Devtools, CRDTTreeNodeIDStruct } from 'yorkie-js-sdk';
+import type { Devtools, CRDTTreeNodeIDStruct } from '@yorkie-js/sdk';
 
 type FlatTreeNodeInfo = Devtools.TreeNodeInfo & {
   depth: number;

packages/devtools/src/devtools/components/Tree.tsx

@@ -22,7 +22,7 @@ import useResizeObserver from 'use-resize-observer';
 
 import { useSelectedNode } from '../contexts/SelectedNode';
 import { useSelectedPresence } from '../contexts/SelectedPresence';
-import type { Devtools, Json } from 'yorkie-js-sdk';
+import type { Devtools, Json } from '@yorkie-js/sdk';
 
 import {
   ArrayIcon,

packages/devtools/src/devtools/contexts/YorkieSource.tsx

@@ -24,7 +24,7 @@ import {
   useState,
 } from 'react';
 
-import { DocEventType, Devtools, type SDKToPanelMessage } from 'yorkie-js-sdk';
+import { DocEventType, Devtools, type SDKToPanelMessage } from '@yorkie-js/sdk';
 import { connectPort, sendToSDK } from '../../port';
 import { Code, YorkieError } from '@yorkie-js-sdk/src/util/error';
 

packages/devtools/src/devtools/panel/index.tsx

@@ -16,7 +16,7 @@
 
 import { createRoot } from 'react-dom/client';
 import { useEffect, useState } from 'react';
-import yorkie from 'yorkie-js-sdk';
+import yorkie from '@yorkie-js/sdk';
 import { useResizable } from 'react-resizable-layout';
 import { SelectedNodeProvider } from '../contexts/SelectedNode';
 import { SelectedPresenceProvider } from '../contexts/SelectedPresence';

packages/devtools/src/devtools/tabs/Document.tsx

@@ -16,7 +16,7 @@
 
 import { useEffect, useState } from 'react';
 import classNames from 'classnames';
-import { Primitive } from 'yorkie-js-sdk';
+import { Primitive } from '@yorkie-js/sdk';
 import { RootTree } from '../components/Tree';
 import { JSONDetail, TreeDetail } from '../components/Detail';
 import { useSelectedNode } from '../contexts/SelectedNode';

packages/devtools/src/devtools/tabs/History.tsx

@@ -15,7 +15,7 @@
  */
 
 import { useEffect, useState, useRef } from 'react';
-import { DocEventType, Change, Devtools } from 'yorkie-js-sdk';
+import { DocEventType, Change, Devtools } from '@yorkie-js/sdk';
 import Slider from 'rc-slider';
 import { JSONView } from '../components/JsonView';
 import { CursorIcon, DocumentIcon } from '../icons';

packages/devtools/src/port.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import { EventSourceDevPanel } from 'yorkie-js-sdk';
-import type { PanelToSDKMessage } from 'yorkie-js-sdk';
+import { EventSourceDevPanel } from '@yorkie-js/sdk';
+import type { PanelToSDKMessage } from '@yorkie-js/sdk';
 
 const tabID = chrome.devtools.inspectedWindow.tabId;
 

packages/sdk/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "yorkie-js-sdk",
+  "name": "@yorkie-js/sdk",
   "version": "0.6.0",
   "description": "Yorkie JS SDK",
   "main": "./src/yorkie.ts",

packages/sdk/public/prosemirror.html

@@ -47,7 +47,7 @@ <h2>Yorkie.Tree</h2>
           "prosemirror-keymap": "https://cdn.jsdelivr.net/npm/[email protected]/+esm",
           "prosemirror-example-setup": "https://cdn.jsdelivr.net/npm/[email protected]/+esm",
           "prosemirror-commands": "https://cdn.jsdelivr.net/npm/[email protected]/+esm",
-          "yorkie-js-sdk": "./yorkie.js"
+          "@yorkie-js/sdk": "./yorkie.js"
         }
       }
     </script>