chore(workspace, docs): update readme, update workspace configs

0x77dev · 0x77dev · commit 6da4daa05bd8 · 2022-01-29T15:46:20.000+02:00
diff --git a/.eslintrc b/.eslintrc
@@ -1,10 +1,13 @@
 {
   "extends": [
     "oclif",
-    "oclif-typescript"
+    "oclif-typescript",
+    "standard"
   ],
   "root": true,
   "rules": {
-    "node/no-missing-import": 1
+    "node/no-missing-import": "off",
+    "unicorn/no-process-exit": "off",
+    "no-process-exit": "off"
   }
 }
diff --git a/.gitignore b/.gitignore
@@ -1,8 +1,6 @@
-*-debug.log
-*-error.log
-/.nyc_output
+*.log
 /dist
 /lib
-/package-lock.json
 /tmp
 node_modules
+.DS_Store
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,6 @@
+{
+  "recommendations": [
+    "editorconfig.editorconfig",
+    "dbaeumer.vscode-eslint"
+  ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,12 @@
+{
+  "cSpell.words": [
+    "dstack",
+    "ipfs",
+    "libp2p"
+  ],
+  "editor.codeActionsOnSave": {
+    "source.fixAll": true
+  },
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "dbaeumer.vscode-eslint",
+}
diff --git a/README.md b/README.md
@@ -1,15 +1,12 @@
-peerchat
+Peerchat
 ===============
 
-Peer-to-peer terminal chat based on [DStack](https://github.com/dstack-js/dstack)
+Zero configuration peer-to-peer terminal chat with built-in end-to-end encryption working on [DStack](https://github.com/dstack-js/dstack)
 
-Checkout [DStack blog post](https://dstack.0x77.dev/blog/peerchat) to learn more
+[Checkout blog post for more info](https://dstack.0x77.dev/blog/peerchat)
 
 [![asciicast](https://asciinema.org/a/465056.svg)](https://asciinema.org/a/465056)
-
-_Recording looks ugly, but in terminal it seems to be fine_
-
-[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![dstack](https://dstack.0x77.dev/img/badge.svg)](https://dstack.0x77.dev)
 [![Version](https://img.shields.io/npm/v/peerchat.svg)](https://npmjs.org/package/peerchat)
 [![Downloads/week](https://img.shields.io/npm/dw/peerchat.svg)](https://npmjs.org/package/peerchat)
 [![License](https://img.shields.io/npm/l/peerchat.svg)](https://github.com/dstack-js/chat/blob/master/package.json)
diff --git a/docs/demo.svg b/docs/demo.svg
diff --git a/package.json b/package.json
@@ -13,19 +13,24 @@
     "@dstack-js/lib": "^0.2.23",
     "@oclif/command": "^1",
     "@oclif/config": "^1",
-    "@oclif/plugin-help": "^5.1.10",
     "blessed": "^0.1.81",
     "discord.js": "^13.6.0",
     "tslib": "^1",
     "wrtc": "^0.4.7"
   },
   "devDependencies": {
     "@oclif/dev-cli": "^1",
+    "@oclif/plugin-help": "^5.1.10",
+    "@oclif/plugin-not-found": "^2.3.1",
+    "@oclif/plugin-warn-if-update-available": "^2.0.4",
     "@types/blessed": "^0.1.19",
     "@types/node": "^17.0.13",
     "eslint": "^7.32.0",
     "eslint-config-oclif": "^3.1.2",
     "eslint-config-oclif-typescript": "^0.2.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-promise": "^6.0.0",
     "ts-node": "^8",
     "typescript": "^4.5.5"
   },
@@ -39,20 +44,30 @@
   ],
   "homepage": "https://github.com/dstack-js/chat",
   "keywords": [
-    "oclif"
+    "oclif",
+    "blessed",
+    "dstack",
+    "ipfs",
+    "libp2p",
+    "peer-to-peer",
+    "chat",
+    "zero-configuration"
   ],
   "license": "GPL-3.0",
   "main": "lib/index.js",
   "oclif": {
     "commands": "./lib/commands",
     "bin": "peerchat",
     "plugins": [
-      "@oclif/plugin-help"
+      "@oclif/plugin-help",
+      "@oclif/plugin-not-found",
+      "@oclif/plugin-warn-if-update-available"
     ]
   },
   "repository": "dstack-js/chat",
   "scripts": {
-    "posttest": "eslint . --ext .ts --config .eslintrc",
+    "lint": "eslint . --ext .ts --config .eslintrc",
+    "posttest": "yarn lint",
     "prepack": "rm -rf lib && tsc -b && oclif-dev readme",
     "test": "echo NO TESTS",
     "version": "oclif-dev readme && git add README.md"
diff --git a/src/commands/discord/index.ts b/src/commands/discord/index.ts
@@ -1,38 +1,38 @@
-import {Command, flags} from '@oclif/command'
+import { Command, flags } from '@oclif/command'
 import PeerChat from '..'
-import {getStack} from '../../services/stack'
-import Discord, {Intents} from 'discord.js'
+import { getStack } from '../../services/stack'
+import Discord, { Intents } from 'discord.js'
 
 class DiscordRelay extends Command {
-  static description = 'Peerchat <-> Discord'
+  static description = 'Peerchat/Discord relay'
 
   static flags = {
-    version: flags.version({char: 'v'}),
+    version: flags.version({ char: 'v' })
   }
 
   static examples = [
-    '$ peerchat discord',
-    '$ peerchat discord [ROOM]',
-    '$ peerchat discord dstack',
+    '$ CHANNEL_ID="<discord channel id>" DISCORD_KEY="<discord bot token>" peerchat discord',
+    '$ CHANNEL_ID="<discord channel id>" DISCORD_KEY="<discord bot token>" peerchat discord [ROOM]',
+    '$ CHANNEL_ID="<discord channel id>" DISCORD_KEY="<discord bot token>" peerchat discord dstack'
   ]
 
-  static args = [{name: 'room', default: PeerChat.args[0].default, description: 'chat room'}]
+  static args = [{ name: 'room', default: PeerChat.args[0].default, description: 'chat room' }]
 
   async run() {
-    const {args} = this.parse(DiscordRelay)
+    const { args } = this.parse(DiscordRelay)
 
     if (!process.env.DISCORD_KEY) {
       throw new Error('DISCORD_KEY env is missing')
     }
 
-    const {pubsub} = await getStack()
-    const client = new Discord.Client({intents: [Intents.FLAGS.GUILD_MESSAGES, Intents.FLAGS.GUILDS, Intents.FLAGS.DIRECT_MESSAGES]})
+    const { pubsub } = await getStack()
+    const client = new Discord.Client({ intents: [Intents.FLAGS.GUILD_MESSAGES, Intents.FLAGS.GUILDS, Intents.FLAGS.DIRECT_MESSAGES] })
     await client.login(process.env.DISCORD_KEY)
 
     client.on('message', async msg => {
       if (msg.author.bot) return
 
-      await pubsub.publish(args.room, {nickname: msg.author.tag, message: msg.content})
+      await pubsub.publish(args.room, { nickname: msg.author.tag, message: msg.content })
     })
 
     await pubsub.subscribe(args.room, async event => {
diff --git a/src/commands/index.ts b/src/commands/index.ts
@@ -1,23 +1,26 @@
-import {Command, flags} from '@oclif/command'
-import {run} from '../services/chat'
+import { Command, flags } from '@oclif/command'
+import { run } from '../services/chat'
 
 export default class PeerChat extends Command {
   static description = 'Peer-to-peer terminal chat running on DStack'
 
   static flags = {
-    version: flags.version({char: 'v'}),
+    version: flags.version({ char: 'v' })
   }
 
   static examples = [
     '$ peerchat',
     '$ peerchat [ROOM] [NICKNAME]',
-    '$ peerchat dstack myCoolNickname',
+    '$ peerchat dstack myCoolNickname'
   ]
 
-  static args = [{name: 'room', default: 'dstack', description: 'chat room'}, {name: 'nickname', description: 'your nickname'}]
+  static args = [
+    { name: 'room', default: 'dstack', description: 'chat room' },
+    { name: 'nickname', description: 'your nickname' }
+  ]
 
   async run() {
-    const {args} = this.parse(PeerChat)
+    const { args } = this.parse(PeerChat)
     await run(args.room, args.nickname)
   }
 }
diff --git a/src/index.ts b/src/index.ts
@@ -1 +1 @@
-export {run} from '@oclif/command'
+export { run } from '@oclif/command'
diff --git a/src/services/chat.ts b/src/services/chat.ts
@@ -1,14 +1,12 @@
-/* eslint-disable no-process-exit */
-/* eslint-disable unicorn/no-process-exit */
 import * as blessed from 'blessed'
-import {getStack} from './stack'
+import { getStack } from './stack'
 
 export const run = async (room: string, nickname?: string) => {
-  const {ipfs, stack, pubsub} = await getStack()
+  const { ipfs, stack, pubsub } = await getStack()
 
   const screen = blessed.screen({
     smartCSR: true,
-    title: `#${room}`,
+    title: `#${room}`
   })
 
   const messageList = blessed.list({
@@ -23,8 +21,8 @@ export const run = async (room: string, nickname?: string) => {
     items: [
       'dstack: connected',
       `dstack: your id is ${stack.id.slice(-5)}`,
-      'dstack: use /help to see commands',
-    ],
+      'dstack: use /help to see commands'
+    ]
   })
 
   // Append our box to the screen.
@@ -36,17 +34,17 @@ export const run = async (room: string, nickname?: string) => {
     label: ` ID: ${stack.id.slice(-5)} `,
     padding: {
       top: 1,
-      left: 2,
+      left: 2
     },
     style: {
       fg: '#787878',
       bg: '#454545',
 
       focus: {
         fg: '#f6f6f6',
-        bg: '#353535',
-      },
-    },
+        bg: '#353535'
+      }
+    }
   })
 
   input.key('enter', async function () {
@@ -61,7 +59,7 @@ export const run = async (room: string, nickname?: string) => {
     }
 
     if (message.startsWith('/addr')) {
-      const {addresses} = await ipfs.id()
+      const { addresses } = await ipfs.id()
 
       for (const addr of addresses) {
         messageList.addItem(`dstack: ${addr.toString()}`)
@@ -94,7 +92,7 @@ export const run = async (room: string, nickname?: string) => {
     }
 
     try {
-      await pubsub.publish(room, {nickname, message})
+      await pubsub.publish(room, { nickname, message })
     } catch {
       // error handling
     } finally {
diff --git a/src/services/stack.ts b/src/services/stack.ts
@@ -1,6 +1,6 @@
-import {create} from '@dstack-js/ipfs'
-import {Stack} from '@dstack-js/lib'
-import {PubSub} from '@dstack-js/lib/src/pubsub'
+import { create } from '@dstack-js/ipfs'
+import { Stack } from '@dstack-js/lib'
+import type { PubSub } from '@dstack-js/lib/src/pubsub'
 const wrtc = require('wrtc')
 
 interface Message {
@@ -12,33 +12,33 @@ export const getStack = async () => {
   const ipfs = await create({
     repo: process.env.IPFS_REPO,
     init: {
-      privateKey: process.env.PEERCHAT_PRIVATE_KEY,
+      privateKey: process.env.PEERCHAT_PRIVATE_KEY
     },
     relay: {
       enabled: true,
       hop: {
-        enabled: true,
-      },
+        enabled: true
+      }
     },
     config: {
       Addresses: {
-        Swarm: ['/ip4/0.0.0.0/tcp/0', '/dns4/dstack-relay.herokuapp.com/tcp/443/wss/p2p-webrtc-star'],
+        Swarm: ['/ip4/0.0.0.0/tcp/0', '/dns4/dstack-relay.herokuapp.com/tcp/443/wss/p2p-webrtc-star']
       },
       Discovery: {
         MDNS: {
           Enabled: true,
-          Interval: 1,
+          Interval: 1
         },
         webRTCStar: {
-          Enabled: true,
-        },
+          Enabled: true
+        }
       },
-      Bootstrap: ['/dns4/dstack-relay.herokuapp.com/tcp/443/wss/p2p-webrtc-star/p2p/QmV2uXBKbii29iJKHKVy8sx5m49qdDTBYNybVoa5uLJtrf'],
-    },
+      Bootstrap: ['/dns4/dstack-relay.herokuapp.com/tcp/443/wss/p2p-webrtc-star/p2p/QmV2uXBKbii29iJKHKVy8sx5m49qdDTBYNybVoa5uLJtrf']
+    }
   }, wrtc)
 
   const stack = await Stack.create('dstack-chat', ipfs)
   const pubsub = stack.pubsub as PubSub<Message>
 
-  return {pubsub, stack, ipfs}
+  return { pubsub, stack, ipfs }
 }
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,13 @@`
`1`	`1`	`{`
`2`	`2`	`"extends": [`
`3`	`3`	`"oclif",`
`4`		`- "oclif-typescript"`
	`4`	`+ "oclif-typescript",`
	`5`	`+ "standard"`
`5`	`6`	`],`
`6`	`7`	`"root": true,`
`7`	`8`	`"rules": {`
`8`		`- "node/no-missing-import": 1`
	`9`	`+ "node/no-missing-import": "off",`
	`10`	`+ "unicorn/no-process-exit": "off",`
	`11`	`+ "no-process-exit": "off"`
`9`	`12`	`}`
`10`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-export {run} from '@oclif/command'`
	`1`	`+export { run } from '@oclif/command'`