diff --git a/components.d.ts b/components.d.ts index f6cc059e..ee6068d1 100644 --- a/components.d.ts +++ b/components.d.ts @@ -63,6 +63,7 @@ declare module '@vue/runtime-core' { CKeyValueList: typeof import('./src/ui/c-key-value-list/c-key-value-list.vue')['default'] CKeyValueListItem: typeof import('./src/ui/c-key-value-list/c-key-value-list-item.vue')['default'] CLabel: typeof import('./src/ui/c-label/c-label.vue')['default'] + CliCommandEditor: typeof import('./src/tools/cli-command-editor/cli-command-editor.vue')['default'] CLink: typeof import('./src/ui/c-link/c-link.vue')['default'] 'CLink.demo': typeof import('./src/ui/c-link/c-link.demo.vue')['default'] CMarkdown: typeof import('./src/ui/c-markdown/c-markdown.vue')['default'] diff --git a/locales/de.yml b/locales/de.yml index 24a853eb..143de43d 100644 --- a/locales/de.yml +++ b/locales/de.yml @@ -463,3 +463,9 @@ tools: text-to-binary: title: Text zu ASCII-Binär description: Konvertiere Text in seine ASCII-Binärrepräsentation und umgekehrt. + + cli-command-editor: + title: CLI-Befehlseditor + description: Wandeln Sie CLI-Befehle mit Optionen in eine leicht bearbeitbare Form um und generieren Sie den Befehl mit Eingabewerten. + command: Befehl + placeholder: Befehl hier einfügen diff --git a/locales/en.yml b/locales/en.yml index eb2465a5..a96275dd 100644 --- a/locales/en.yml +++ b/locales/en.yml @@ -1198,3 +1198,8 @@ tools: title: XSLT tester description: Allows to test XML transformation using XSLT Stylesheets + cli-command-editor: + title: CLI command editor + description: Convert CLI commands with options into an easily editable form and generate the resulting command with input values. + command: Command + placeholder: Paste command here diff --git a/locales/es.yml b/locales/es.yml index 2882f8a1..613cc458 100644 --- a/locales/es.yml +++ b/locales/es.yml @@ -78,3 +78,9 @@ tools: csv-to-json: title: CSV a JSON description: Convierte CSV a JSON con detección automática de cabeceras. + + cli-command-editor: + title: editor de comandos CLI + description: Convierta comandos CLI con opciones en un formato fácilmente editable y genere el comando resultante con valores de entrada. + command: Dominio + placeholder: Pegar comando aquí diff --git a/locales/fr.yml b/locales/fr.yml index 2f586b7d..95aef56f 100644 --- a/locales/fr.yml +++ b/locales/fr.yml @@ -87,4 +87,10 @@ tools: json-sort-master: title: Maître de tri JSON - description: Triez votre JSON par clés et valeurs. \ No newline at end of file + description: Triez votre JSON par clés et valeurs. + + cli-command-editor: + title: Éditeur de commandes CLI + description: Convertissez les commandes CLI avec des options dans un format facilement modifiable et générez la commande résultante avec des valeurs d'entrée. + command: Commande + placeholder: Coller la commande ici diff --git a/locales/no.yml b/locales/no.yml index 8d603e4e..dda17a97 100644 --- a/locales/no.yml +++ b/locales/no.yml @@ -392,3 +392,9 @@ tools: text-to-binary: title: Tekst til ASCII binært description: Konverter tekst til sin ASCII binære representasjon og visa-versa. + + cli-command-editor: + title: CLI kommando editor + description: Konverter CLI-kommandoer med alternativer til et enkelt redigerbart format og generer den resulterende kommandoen med inndataverdier. + command: Kommando + placeholder: Lim inn kommando her diff --git a/locales/pl.yml b/locales/pl.yml index 71f97697..3408d535 100644 --- a/locales/pl.yml +++ b/locales/pl.yml @@ -85,3 +85,9 @@ tools: description: Odtwórz i wizualizuj dźwięk z Twojego mikrofonu, z dodaną jedną sekundą opóźnienia start-button-text: Odtwarzaj mikrofonu stop-button-text: Zatrzymaj odtwarzanie mikrofonu + + cli-command-editor: + title: Edytor poleceń CLI + description: Konwertuj polecenia CLI z opcjami do postaci, którą można łatwo edytować, i generuj wynikowe polecenia z wartościami wejściowymi. + command: Rozkaz + placeholder: Wklej tutaj polecenie diff --git a/locales/pt.yml b/locales/pt.yml index a3695c49..e08c8ad3 100644 --- a/locales/pt.yml +++ b/locales/pt.yml @@ -78,3 +78,9 @@ tools: json-sort-master: title: 'Mestre de classificação JSON' description: 'Ordene seu JSON por chaves e valores.' + + cli-command-editor: + title: Editor de comando CLI + description: Converta comandos CLI com opções em um formato facilmente editável e gere o comando resultante com valores de entrada. + command: Comando + placeholder: Cole o comando aqui diff --git a/locales/ru.yml b/locales/ru.yml index da0e371e..3c9c0b38 100644 --- a/locales/ru.yml +++ b/locales/ru.yml @@ -1182,5 +1182,8 @@ tools: title: Тестер XSLT description: Тестируйте преобразование XML с использованием XSLT-стилей - - + cli-command-editor: + title: редактор команд CLI + description: Преобразуйте команды CLI с параметрами в легко редактируемую форму и сгенерируйте результирующую команду с входными значениями. + command: Команда + placeholder: Вставьте команду сюда diff --git a/locales/uk.yml b/locales/uk.yml index 9a891d0d..4afbf83f 100644 --- a/locales/uk.yml +++ b/locales/uk.yml @@ -1186,4 +1186,10 @@ tools: xslt-tester: title: Тестер XSLT - description: Тестуйте трансформацію XML за допомогою XSLT стилів \ No newline at end of file + description: Тестуйте трансформацію XML за допомогою XSLT стилів + + cli-command-editor: + title: Редактор команд CLI + description: Перетворіть команди CLI з опціями у форму, яку легко редагувати, та згенеруйте результуючу команду з вхідними значеннями. + command: Команда + placeholder: Вставте команду сюди diff --git a/locales/vi.yml b/locales/vi.yml index 88ca1c1f..1edac7f8 100644 --- a/locales/vi.yml +++ b/locales/vi.yml @@ -393,4 +393,10 @@ tools: unicode-to-java-entities: title: Chuyển đổi ký tự Unicode sang thực thể Java - description: Chuyển đổi ký tự Unicode sang thực thể Java và ngược lại \ No newline at end of file + description: Chuyển đổi ký tự Unicode sang thực thể Java và ngược lại + + cli-command-editor: + title: Trình soạn thảo lệnh CLI + description: Chuyển đổi các lệnh CLI có tùy chọn thành dạng dễ chỉnh sửa và tạo lệnh kết quả với các giá trị đầu vào. + command: Yêu cầu + placeholder: Dán lệnh vào đây diff --git a/locales/zh.yml b/locales/zh.yml index 8108c740..f2378faa 100644 --- a/locales/zh.yml +++ b/locales/zh.yml @@ -414,3 +414,9 @@ tools: result: 检测结果 sucess: 成功 failure: 失败 + + cli-command-editor: + title: CLI 命令编辑器 + description: 将带有选项的 CLI 命令转换为易于编辑的形式,并生成带有输入值的结果命令。 + command: 命令 + placeholder: 将命令粘贴到此处 diff --git a/src/tools/cli-command-editor/cli-command-editor.e2e.spec.ts b/src/tools/cli-command-editor/cli-command-editor.e2e.spec.ts new file mode 100644 index 00000000..b80e444b --- /dev/null +++ b/src/tools/cli-command-editor/cli-command-editor.e2e.spec.ts @@ -0,0 +1,11 @@ +import { expect, test } from '@playwright/test'; + +test.describe('Tool - Cli command editor', () => { + test.beforeEach(async ({ page }) => { + await page.goto('/cli-command-editor'); + }); + + test('Has correct title', async ({ page }) => { + await expect(page).toHaveTitle('Cli command editor - IT Tools'); + }); +}); diff --git a/src/tools/cli-command-editor/cli-command-editor.service.test.ts b/src/tools/cli-command-editor/cli-command-editor.service.test.ts new file mode 100644 index 00000000..9524564a --- /dev/null +++ b/src/tools/cli-command-editor/cli-command-editor.service.test.ts @@ -0,0 +1,140 @@ +import { describe, expect, it } from 'vitest'; +import { buildEditedCommand, buildOptionsObject, extractOptions, isOption, sanitizeOption } from './cli-command-editor.service'; + +describe('cli-command-editor', () => { + describe('extractOptions', () => { + it ('extracts all the options from a command', () => { + expect( + extractOptions('aws elb describe-load-balancers --load-balancer-name my-load-balancer')[0], + ).toContain('--load-balancer-name'); + + expect( + extractOptions('aws elb describe-load-balancers --load-balancer-name my-load-balancer --debug --query my-queryyy')[0], + ).toContain('--load-balancer-name'); + + expect( + extractOptions('aws elb describe-load-balancers --load-balancer-name my-load-balancer --debug --query my-queryyy')[1], + ).toContain('--debug'); + + expect( + extractOptions('aws elb describe-load-balancers --load-balancer-name my-load-balancer --debug --query my-queryyy')[2], + ).toContain('--query'); + }); + + it('extracts all the option from a command with a mix of hyphen and double hyphens', () => { + expect( + extractOptions('npm i lodash -g --legacy-peer-deps')[0], + ).toContain('-g'); + + expect( + extractOptions('npm i lodash -g --legacy-peer-deps')[1], + ).toContain('--legacy-peer-deps'); + }); + + it('shouldn\'t extract any options from a command without options', () => { + expect( + extractOptions('npm i lodash'), + ).toEqual([]); + }); + + it('shouldn\'t return any options if command is not passed', () => { + expect(extractOptions()).toEqual([]); + }); + }); + + describe('buildOptionsObject', () => { + it('returns a valid options object with the given options', () => { + expect( + buildOptionsObject(['--debug', '--load-balancer-names']), + ).toEqual({ + '--debug': '', + '--load-balancer-names': '', + }); + }); + + it('returns an empty obnject with blank options array', () => { + expect( + buildOptionsObject([]), + ).toEqual({}); + }); + }); + + describe('sanitizeOption', () => { + it('returns the sanitized option without `id` suffix', () => { + expect(sanitizeOption('--debug-id-1dfsj')) + .toEqual('--debug'); + }); + + it('returns the blank string', () => { + expect(sanitizeOption('')).toEqual(''); + }); + }); + + describe('isOption', () => { + it('returns true for a valid double hyphen option token', () => { + expect(isOption('--debug')).toBe(true); + }); + + it('returns true for a valid single hyphen option token', () => { + expect(isOption('-i')).toBe(true); + }); + + it('returns false for an non-option token', () => { + expect(isOption('hello-world')).toBe(false); + }); + }); + + describe('buildEditedCommand', () => { + it('returns the edited command', () => { + expect( + buildEditedCommand({ + '--debug-id-1dfsj': 'stdin', + '-p': '', + '-m': 'nahhhh', + }, { + '--debug-id-1dfsj': 'stdin', + '-p': '', + '-m': 'nahhhh', + }, 'aws node --debug stdio -p -m okayyy'), + ).toEqual('aws node --debug stdin -p -m nahhhh'); + + expect( + buildEditedCommand({ + '-d-id-1dfsj': '', + '-p-id-fdsd': '4444:3333', + '-p-id-fddd': '3333:4444', + '--name-id-nnnn': 'clickhouse-server', + '--ulimit-id-uuuu': 'nofile=3333:4444', + }, { + '-d-id-1dfsj': '', + '-p-id-fdsd': '4444:3333', + '-p-id-fddd': '3333:4444', + '--name-id-nnnn': 'clickhouse-server', + '--ulimit-id-uuuu': 'nofile=3333:4444', + }, 'docker run -d -p 18123:8123 -p 19000:9000 --name some-clickhouse-server --ulimit nofile=262144:262144 clickhouse/clickhouse-server'), + ).toEqual('docker run -d -p 4444:3333 -p 3333:4444 --name clickhouse-server --ulimit nofile=3333:4444 clickhouse/clickhouse-server'); + }); + + it('returns the edited command when options object and CLI options order doesn\'t match', () => { + expect( + buildEditedCommand({ + '-d-id-t1dd3': 'true', + '--install-id-only123': 'nodemon', + }, { + '--install-id-only123': 'nodem', + '-d-id-t1dd3': 'false', + }, 'npm --install nodem -d false'), + ).toBe('npm --install nodemon -d true'); + }); + + it('returns the original command', () => { + expect( + buildEditedCommand({}, {}, 'npm install nodemon'), + ).toBe('npm install nodemon'); + + expect( + buildEditedCommand({}, {}, 'aws load-balancer describe-load-balancers all'), + ).toBe('aws load-balancer describe-load-balancers all'); + }); + }); +}); diff --git a/src/tools/cli-command-editor/cli-command-editor.service.ts b/src/tools/cli-command-editor/cli-command-editor.service.ts new file mode 100644 index 00000000..9793ac24 --- /dev/null +++ b/src/tools/cli-command-editor/cli-command-editor.service.ts @@ -0,0 +1,104 @@ +import { generateRandomId } from '@/utils/random'; + +export function isOption(token: string): boolean { + return token?.startsWith('--') || token?.startsWith('-'); +} + +export function extractOptions(command: string = ''): string[] { + /* + in a CLI, the options are either written with a hyphen or double hyphens, however, + script names or package/library sometimes include a hyphen, too, for example 'describe-load-balancers' + */ + + // split into tokens first + const tokens = command.split(' '); + + // map each token of the command to an option + const options = tokens.map((token: string) => { + // every option in a starts with either a hyphen or double hyphens + if (isOption(token)) { + const randomId = generateRandomId(); + return `${token}-${randomId}`; + } + + return ''; + }).filter((option: string): boolean => !!option); + return options; +} + +export function buildOptionsObject(options: string[]): Record { + const optionsObject: Record = {}; + + for (const option of options) { + optionsObject[option] = ''; + } + + return optionsObject; +} + +export function sanitizeOption(option: string): string { + return option.split('-id')?.[0]; +} + +export function buildEditedCommand(options: Record, originalOptions: Record, command: string): string { + if (!Object.keys(options).length) { + return command; + } + + const tokens = command.split(' '); + const editedTokens = []; + + // user may input the option value in any order, from the form + // preserve the original object with options in the correct + // order as they appear in the original command, this is done + // to handle the interpolation of edited option values into the + // command + originalOptions = Object.entries(options) + .reduce((previousValue: Record, currentValue: string[]) => { + previousValue[currentValue[0]] = currentValue[1]; + + return previousValue; + }, originalOptions); + + const defaultValues: Record = {}; + // replacing the options and their values (if any) with formatter ($i) to + // help in interpolation of the command + for (let i = 0, j = 0, n = tokens.length; i < n; ++i) { + const token = tokens[i]; + const nextToken = tokens[i + 1]; + + if (isOption(token)) { + editedTokens.push(`$${j}`); + + if (!isOption(nextToken)) { + ++i; + defaultValues[`$${j}`] = nextToken; + } + + ++j; + continue; + } + + editedTokens.push(token); + } + + let editedCommand = editedTokens.join(' '); + + const originalOptionKeys = Object.keys(originalOptions); + + for (let i = 0, n = originalOptionKeys.length; i < n; ++i) { + const key = originalOptionKeys[i]; + const keyWithoutIdSuffix = key.split('-id-')[0] || key; + + if (originalOptions[key]) { + editedCommand = editedCommand.replace(`$${i}`, `${keyWithoutIdSuffix} ${originalOptions[key]}`); + } + else { + const value = defaultValues[`$${i}`]; + const replaceValue = value ? `${keyWithoutIdSuffix} ${value}` : keyWithoutIdSuffix; + editedCommand = editedCommand.replace(`$${i}`, replaceValue); + } + } + + return editedCommand; +} diff --git a/src/tools/cli-command-editor/cli-command-editor.vue b/src/tools/cli-command-editor/cli-command-editor.vue new file mode 100644 index 00000000..8e7a0f96 --- /dev/null +++ b/src/tools/cli-command-editor/cli-command-editor.vue @@ -0,0 +1,51 @@ + + + diff --git a/src/tools/cli-command-editor/index.ts b/src/tools/cli-command-editor/index.ts new file mode 100644 index 00000000..73d94cfc --- /dev/null +++ b/src/tools/cli-command-editor/index.ts @@ -0,0 +1,13 @@ +import { Terminal2 } from '@vicons/tabler'; +import { defineTool } from '../tool'; + +export const tool = defineTool({ + name: 'Cli command editor', + path: '/cli-command-editor', + description: '', + keywords: ['cli', 'command', 'editor'], + component: () => import('./cli-command-editor.vue'), + icon: Terminal2, + createdAt: new Date('2025-07-05'), + category: 'Development', +});