@dotrino/terminal-agent 0.19.2 → 0.20.0
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 +7 -0
- package/bin/terminal.js +32 -0
- package/editors.js +113 -0
- package/package.json +3 -1
package/README.md
CHANGED
|
@@ -30,6 +30,7 @@ dotrino-terminal kill <id>
|
|
|
30
30
|
dotrino-terminal profiles [--json] # los perfiles (agentes con nombre) de esta máquina
|
|
31
31
|
dotrino-terminal link [--name <n>] # enlazar un perfil con tu bóveda
|
|
32
32
|
dotrino-terminal rename <perfil> [nuevo] # renombrarlo (mueve su carpeta y para su agente; mismo aparato)
|
|
33
|
+
dotrino-terminal vscode [--name <n>] # la terminal embebida de VS Code abre consolas de aquí (--off lo deshace)
|
|
33
34
|
```
|
|
34
35
|
|
|
35
36
|
Cerrar la ventana cierra su consola, como cualquier terminal; **Ctrl+] y luego d** la suelta
|
|
@@ -40,6 +41,12 @@ título. Sin enlace el agente atiende solo a las ventanas locales; al enlazarlo
|
|
|
40
41
|
(`dotrino-terminal link`) enciende la parte remota sin reiniciarse. La app de escritorio
|
|
41
42
|
(`desktop/` del repo) es una ventana nativa que corre este mismo cliente.
|
|
42
43
|
|
|
44
|
+
`dotrino-terminal vscode` escribe el perfil de terminal «Dotrino» en el `settings.json` de VS Code,
|
|
45
|
+
VS Code Insiders, VSCodium y Cursor (los que haya, Linux y macOS) y lo deja por defecto; conserva
|
|
46
|
+
los comentarios y el resto del archivo (`editors.js`, con `jsonc-parser`). El perfil apunta a Node
|
|
47
|
+
y al script por su ruta, porque un editor lanzado desde el escritorio no hereda el PATH de la shell:
|
|
48
|
+
al cambiar de Node se vuelve a correr.
|
|
49
|
+
|
|
43
50
|
Enlazar pide una terminal interactiva: se pega la invitación de `dotrino-vault pair` y
|
|
44
51
|
se aprueba con `dotrino-vault approve <código>`. Después puede correr como servicio
|
|
45
52
|
(systemd, pm2). Una vez al día avisa si hay versión nueva; no se actualiza solo.
|
package/bin/terminal.js
CHANGED
|
@@ -11,6 +11,8 @@
|
|
|
11
11
|
* dotrino-terminal rename <perfil> [nuevo] renombra un perfil (para su agente si corre)
|
|
12
12
|
* dotrino-terminal lock [--name <n>] pone o cambia la clave que piden los otros aparatos
|
|
13
13
|
* dotrino-terminal lock --off [--name <n>] la quita
|
|
14
|
+
* dotrino-terminal vscode [--name <n>] la terminal embebida de VS Code abre consolas de aquí
|
|
15
|
+
* dotrino-terminal vscode --off lo deshace
|
|
14
16
|
*
|
|
15
17
|
* Un PERFIL es un agente con nombre (`~/.dotrino/agent/terminal-agent/<nombre>/`), enlazado a
|
|
16
18
|
* una bóveda o solo local. Cada consola vive en el agente de un perfil.
|
|
@@ -35,6 +37,7 @@ import readline from 'node:readline'
|
|
|
35
37
|
import { connectLocal } from '../local.js'
|
|
36
38
|
import { titleFilter } from '../title.js'
|
|
37
39
|
import { hasAccessCode, setAccessCode, clearAccessCode, MIN_LENGTH } from '../access.js'
|
|
40
|
+
import { configureEditors, terminalProfile } from '../editors.js'
|
|
38
41
|
|
|
39
42
|
const { version: VERSION } = createRequire(import.meta.url)('../package.json')
|
|
40
43
|
const args = process.argv.slice(2)
|
|
@@ -59,6 +62,9 @@ if (args.includes('-h') || args.includes('--help')) {
|
|
|
59
62
|
aparatos tienen que escribir para abrir consolas aquí
|
|
60
63
|
dotrino-terminal lock --off [--name <n>] quita la clave
|
|
61
64
|
dotrino-terminal lock --status [--name <n>] dice si hay clave
|
|
65
|
+
dotrino-terminal vscode [--name <n>] hace que la terminal embebida de VS Code (y de
|
|
66
|
+
VS Code Insiders, VSCodium y Cursor) abra consolas de aquí
|
|
67
|
+
dotrino-terminal vscode --off lo deshace
|
|
62
68
|
|
|
63
69
|
Dentro de una consola: Ctrl+] y luego d la suelta sin cerrarla; Ctrl+] n abre otra
|
|
64
70
|
(y suelta la actual); Ctrl+] a <id> Enter pasa a esa consola; Ctrl+] p fija el tamaño de la
|
|
@@ -75,6 +81,9 @@ Cerrar la ventana cierra la consola que abrió.`, `usage:
|
|
|
75
81
|
devices must type to open consoles here
|
|
76
82
|
dotrino-terminal lock --off [--name <n>] remove the code
|
|
77
83
|
dotrino-terminal lock --status [--name <n>] say whether there is a code
|
|
84
|
+
dotrino-terminal vscode [--name <n>] make the integrated terminal of VS Code (and VS Code
|
|
85
|
+
Insiders, VSCodium and Cursor) open consoles from here
|
|
86
|
+
dotrino-terminal vscode --off undo it
|
|
78
87
|
|
|
79
88
|
Inside a console: Ctrl+] then d detaches without closing it; Ctrl+] n opens another
|
|
80
89
|
(detaching the current one); Ctrl+] a <id> Enter switches to that console; Ctrl+] p pins the
|
|
@@ -161,6 +170,28 @@ async function profiles () {
|
|
|
161
170
|
}
|
|
162
171
|
}
|
|
163
172
|
|
|
173
|
+
/** Pone (o quita, con `--off`) el perfil de terminal «Dotrino» en los editores instalados. */
|
|
174
|
+
function vscode () {
|
|
175
|
+
const off = args.includes('--off')
|
|
176
|
+
const name = opt('--name')
|
|
177
|
+
if (name !== undefined && !isValidName(name)) die(t(`nombre de perfil no válido: ${name}`, `invalid profile name: ${name}`))
|
|
178
|
+
const profile = off ? null : terminalProfile({ node: process.execPath, script: fs.realpathSync(fileURLToPath(import.meta.url)), name })
|
|
179
|
+
let done
|
|
180
|
+
try { done = configureEditors({ profile }) } catch (e) {
|
|
181
|
+
if (e.code === 'no-editor') die(t('no encontré VS Code, VS Code Insiders, VSCodium ni Cursor en esta cuenta.', 'could not find VS Code, VS Code Insiders, VSCodium or Cursor in this account.'))
|
|
182
|
+
if (e.code === 'bad-settings') die(t(`no se pudo leer la configuración y no se tocó nada: ${e.message}`, `could not read the settings and nothing was changed: ${e.message}`))
|
|
183
|
+
if (e.code === 'unsupported-platform') die(t('esto solo está para Linux y macOS.', 'this is only available on Linux and macOS.'))
|
|
184
|
+
throw e
|
|
185
|
+
}
|
|
186
|
+
for (const d of done) {
|
|
187
|
+
const what = off
|
|
188
|
+
? (d.changed ? t('quitado', 'removed') : t('no estaba', 'was not set'))
|
|
189
|
+
: (d.changed ? t('configurado', 'configured') : t('ya estaba', 'already set'))
|
|
190
|
+
console.log(` ${d.name.padEnd(18)} ${what} ${d.settings}`)
|
|
191
|
+
}
|
|
192
|
+
if (!off) console.log(t('\nLas terminales nuevas del editor ya abren aquí. Si actualizas o cambias de Node, vuelve a correr esta orden.', '\nNew terminals in the editor now open here. If you update or switch Node, run this command again.'))
|
|
193
|
+
}
|
|
194
|
+
|
|
164
195
|
/** Enlaza un perfil. Sin `--name`, lo pregunta. Uno ya enlazado no se pisa: eso es `enroll`. */
|
|
165
196
|
async function link () {
|
|
166
197
|
let name = opt('--name')
|
|
@@ -504,6 +535,7 @@ try {
|
|
|
504
535
|
if (cmd === 'link') { await link(); process.exit(0) }
|
|
505
536
|
if (cmd === 'rename') { await rename(); process.exit(0) }
|
|
506
537
|
if (cmd === 'lock') { await lock(); process.exit(0) }
|
|
538
|
+
if (cmd === 'vscode') { vscode(); process.exit(0) }
|
|
507
539
|
const dir = opt('--dir') || dataDir(opt('--name'))
|
|
508
540
|
if (cmd === 'open' || cmd === 'attach') captureEarly()
|
|
509
541
|
const conn = await agent(dir)
|
package/editors.js
ADDED
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* La terminal EMBEBIDA de VS Code (y sus variantes) como ventana de Dotrino Terminal.
|
|
3
|
+
*
|
|
4
|
+
* `dotrino-terminal vscode` escribe en el `settings.json` del usuario un perfil de terminal
|
|
5
|
+
* «Dotrino» que corre este mismo cliente, y lo deja por defecto: cada pestaña del panel pasa a
|
|
6
|
+
* ser una consola del agente, que se puede retomar desde los otros aparatos de la cuenta.
|
|
7
|
+
*
|
|
8
|
+
* El perfil apunta a Node y al script por su ruta, no al `dotrino-terminal` del PATH: un editor
|
|
9
|
+
* lanzado desde el escritorio no hereda el PATH de la shell (nvm), y ahí el `#!/usr/bin/env node`
|
|
10
|
+
* no encuentra con qué correr.
|
|
11
|
+
*
|
|
12
|
+
* `settings.json` es JSON con comentarios: se edita con `jsonc-parser` (el del propio VS Code),
|
|
13
|
+
* que toca solo las claves que cambian y deja lo demás, comentarios incluidos, como estaba.
|
|
14
|
+
*/
|
|
15
|
+
import fs from 'node:fs'
|
|
16
|
+
import os from 'node:os'
|
|
17
|
+
import path from 'node:path'
|
|
18
|
+
import { parse, modify, applyEdits, printParseErrorCode } from 'jsonc-parser'
|
|
19
|
+
|
|
20
|
+
export const PROFILE = 'Dotrino'
|
|
21
|
+
|
|
22
|
+
/** Las carpetas de configuración que se buscan, por nombre del editor. */
|
|
23
|
+
export const EDITORS = [
|
|
24
|
+
{ name: 'VS Code', dir: 'Code' },
|
|
25
|
+
{ name: 'VS Code Insiders', dir: 'Code - Insiders' },
|
|
26
|
+
{ name: 'VSCodium', dir: 'VSCodium' },
|
|
27
|
+
{ name: 'Cursor', dir: 'Cursor' },
|
|
28
|
+
]
|
|
29
|
+
|
|
30
|
+
/** Un error con `code`: quien lo recibe decide por el código, no por la frase. */
|
|
31
|
+
const fail = (code, message) => Object.assign(new Error(message), { code })
|
|
32
|
+
|
|
33
|
+
/** `linux` u `osx`: el sufijo de las claves de terminal de VS Code. Otro sistema no se atiende. */
|
|
34
|
+
export function platformKey (platform = process.platform) {
|
|
35
|
+
if (platform === 'linux') return 'linux'
|
|
36
|
+
if (platform === 'darwin') return 'osx'
|
|
37
|
+
throw fail('unsupported-platform', `unsupported platform: ${platform}`)
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
/** Donde los editores guardan lo del usuario. */
|
|
41
|
+
export function configBase ({ platform = process.platform, home = os.homedir(), env = process.env } = {}) {
|
|
42
|
+
if (platform === 'darwin') return path.join(home, 'Library', 'Application Support')
|
|
43
|
+
return env.XDG_CONFIG_HOME || path.join(home, '.config')
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
/** Los editores instalados: los que tienen su carpeta `User`. */
|
|
47
|
+
export function findEditors (base = configBase()) {
|
|
48
|
+
return EDITORS
|
|
49
|
+
.map((e) => ({ ...e, settings: path.join(base, e.dir, 'User', 'settings.json') }))
|
|
50
|
+
.filter((e) => fs.existsSync(path.dirname(e.settings)))
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
/** El perfil de terminal: Node, el script del cliente y, si se pidió, el perfil de Dotrino. */
|
|
54
|
+
export function terminalProfile ({ node, script, name }) {
|
|
55
|
+
return { path: node, args: name ? [script, '--name', name] : [script] }
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
function check (text, file) {
|
|
59
|
+
const errors = []
|
|
60
|
+
const value = parse(text, errors, { allowTrailingComma: true })
|
|
61
|
+
if (errors.length || (text.trim() && (typeof value !== 'object' || value === null || Array.isArray(value)))) {
|
|
62
|
+
const why = errors.length ? `${printParseErrorCode(errors[0].error)} at offset ${errors[0].offset}` : 'not an object'
|
|
63
|
+
throw fail('bad-settings', `${file}: ${why}`)
|
|
64
|
+
}
|
|
65
|
+
return value || {}
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
const formatting = (text) => ({ formattingOptions: /\n\t/.test(text) ? { insertSpaces: false, tabSize: 1 } : { insertSpaces: true, tabSize: 2 } })
|
|
69
|
+
|
|
70
|
+
function set (text, keyPath, value) {
|
|
71
|
+
return applyEdits(text, modify(text, keyPath, value, formatting(text)))
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
/**
|
|
75
|
+
* El texto de `settings.json` con el perfil puesto (`profile`) o quitado (`profile: null`).
|
|
76
|
+
* Al quitar, el perfil por defecto solo se toca si era el nuestro.
|
|
77
|
+
*/
|
|
78
|
+
export function applyToSettings (text, { profile, platform = platformKey(), file = 'settings.json' }) {
|
|
79
|
+
const src = text.trim() ? text : '{}\n'
|
|
80
|
+
const current = check(src, file)
|
|
81
|
+
const profilesKey = `terminal.integrated.profiles.${platform}`
|
|
82
|
+
const defaultKey = `terminal.integrated.defaultProfile.${platform}`
|
|
83
|
+
if (profile) {
|
|
84
|
+
return set(set(src, [profilesKey, PROFILE], profile), [defaultKey], PROFILE)
|
|
85
|
+
}
|
|
86
|
+
let out = src
|
|
87
|
+
const profiles = current[profilesKey]
|
|
88
|
+
if (profiles && typeof profiles === 'object' && PROFILE in profiles) {
|
|
89
|
+
// Si era el único, se va la clave entera: no se deja un objeto vacío.
|
|
90
|
+
out = Object.keys(profiles).length === 1 ? set(out, [profilesKey], undefined) : set(out, [profilesKey, PROFILE], undefined)
|
|
91
|
+
}
|
|
92
|
+
if (current[defaultKey] === PROFILE) out = set(out, [defaultKey], undefined)
|
|
93
|
+
return out
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* Lo aplica a cada editor instalado. Devuelve `[{ name, settings, changed }]`. Sin ninguno,
|
|
98
|
+
* lanza `no-editor`; un `settings.json` que no se puede leer lanza `bad-settings` y no se toca.
|
|
99
|
+
*/
|
|
100
|
+
export function configureEditors ({ profile, base = configBase(), platform = platformKey() }) {
|
|
101
|
+
const editors = findEditors(base)
|
|
102
|
+
if (!editors.length) throw fail('no-editor', `no editor found under ${base}`)
|
|
103
|
+
// Primero se calcula todo: si uno falla, no se deja a medias a los demás.
|
|
104
|
+
const plan = editors.map((ed) => {
|
|
105
|
+
const before = fs.existsSync(ed.settings) ? fs.readFileSync(ed.settings, 'utf8') : ''
|
|
106
|
+
return { ...ed, before, after: applyToSettings(before, { profile, platform, file: ed.settings }) }
|
|
107
|
+
})
|
|
108
|
+
return plan.map(({ name, settings, before, after }) => {
|
|
109
|
+
const changed = after !== before && !(profile === null && !before.trim())
|
|
110
|
+
if (changed) fs.writeFileSync(settings, after)
|
|
111
|
+
return { name, settings, changed }
|
|
112
|
+
})
|
|
113
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dotrino/terminal-agent",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.20.0",
|
|
4
4
|
"description": "Dotrino Terminal: las ventanas de esta máquina (dotrino-terminal) y su agente, que deja abrir esas mismas consolas desde los otros aparatos de tu cuenta, cifrado punto a punto.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
"files": [
|
|
14
14
|
"index.js",
|
|
15
15
|
"access.js",
|
|
16
|
+
"editors.js",
|
|
16
17
|
"consoles.js",
|
|
17
18
|
"link.js",
|
|
18
19
|
"local.js",
|
|
@@ -32,6 +33,7 @@
|
|
|
32
33
|
"@dotrino/vault": "0.79.0",
|
|
33
34
|
"@xterm/addon-serialize": "0.13.0",
|
|
34
35
|
"@xterm/headless": "5.5.0",
|
|
36
|
+
"jsonc-parser": "3.3.1",
|
|
35
37
|
"node-pty": "1.2.0-beta.15"
|
|
36
38
|
},
|
|
37
39
|
"engines": {
|