From 91fc753f47b46eac6426c1346abf63c2314b6c41 Mon Sep 17 00:00:00 2001 From: Aniket-Engg Date: Wed, 13 Jul 2022 18:55:29 +0530 Subject: [PATCH] added description for all plugins --- apps/remix-ide/src/app/components/hidden-panel.tsx | 2 +- apps/remix-ide/src/app/components/main-panel.tsx | 2 +- apps/remix-ide/src/app/components/side-panel.tsx | 2 +- apps/remix-ide/src/app/components/vertical-icons.tsx | 2 +- apps/remix-ide/src/app/files/dgitProvider.js | 2 +- apps/remix-ide/src/app/panels/file-panel.js | 2 +- apps/remix-ide/src/app/panels/terminal.js | 2 +- apps/remix-ide/src/app/plugins/permission-handler-plugin.tsx | 2 +- apps/remix-ide/src/app/tabs/compile-and-run.ts | 2 +- apps/remix-ide/src/app/tabs/external-http-provider.tsx | 2 +- apps/remix-ide/src/app/tabs/foundry-provider.tsx | 2 +- apps/remix-ide/src/app/tabs/ganache-provider.tsx | 2 +- apps/remix-ide/src/app/tabs/runTab/model/recorder.js | 2 +- apps/remix-ide/src/app/tabs/search.tsx | 2 +- apps/remix-ide/src/app/tabs/test-tab.js | 2 +- apps/remix-ide/src/app/udapp/run-tab.js | 2 +- apps/remix-ide/src/app/ui/landing-page/landing-page.js | 2 +- apps/remix-ide/src/walkthroughService.js | 2 +- 18 files changed, 18 insertions(+), 18 deletions(-) diff --git a/apps/remix-ide/src/app/components/hidden-panel.tsx b/apps/remix-ide/src/app/components/hidden-panel.tsx index 31c7a0cb0b..6aa78a4052 100644 --- a/apps/remix-ide/src/app/components/hidden-panel.tsx +++ b/apps/remix-ide/src/app/components/hidden-panel.tsx @@ -8,7 +8,7 @@ import { PluginViewWrapper } from '@remix-ui/helper' const profile = { name: 'hiddenPanel', displayName: 'Hidden Panel', - description: '', + description: 'Remix IDE hidden panel', version: packageJson.version, methods: ['addView', 'removeView'] } diff --git a/apps/remix-ide/src/app/components/main-panel.tsx b/apps/remix-ide/src/app/components/main-panel.tsx index 615e03690d..d6dee613fd 100644 --- a/apps/remix-ide/src/app/components/main-panel.tsx +++ b/apps/remix-ide/src/app/components/main-panel.tsx @@ -7,7 +7,7 @@ import { PluginViewWrapper } from '@remix-ui/helper' const profile = { name: 'mainPanel', displayName: 'Main Panel', - description: '', + description: 'Remix IDE main panel', version: packageJson.version, methods: ['addView', 'removeView', 'showContent'] } diff --git a/apps/remix-ide/src/app/components/side-panel.tsx b/apps/remix-ide/src/app/components/side-panel.tsx index bf82defe55..54e56dd210 100644 --- a/apps/remix-ide/src/app/components/side-panel.tsx +++ b/apps/remix-ide/src/app/components/side-panel.tsx @@ -10,7 +10,7 @@ import { PluginViewWrapper } from '@remix-ui/helper' const sidePanel = { name: 'sidePanel', displayName: 'Side Panel', - description: '', + description: 'Remix IDE side panel', version: packageJson.version, methods: ['addView', 'removeView'] } diff --git a/apps/remix-ide/src/app/components/vertical-icons.tsx b/apps/remix-ide/src/app/components/vertical-icons.tsx index d8fe5706f8..24d5b93b2b 100644 --- a/apps/remix-ide/src/app/components/vertical-icons.tsx +++ b/apps/remix-ide/src/app/components/vertical-icons.tsx @@ -10,7 +10,7 @@ import { PluginViewWrapper } from '@remix-ui/helper' const profile = { name: 'menuicons', displayName: 'Vertical Icons', - description: '', + description: 'Remix IDE vertical icons', version: packageJson.version, methods: ['select', 'unlinkContent', 'linkContent'], events: ['toggleContent', 'showContent'] diff --git a/apps/remix-ide/src/app/files/dgitProvider.js b/apps/remix-ide/src/app/files/dgitProvider.js index 8b5ce925c5..aa5b98dfa1 100644 --- a/apps/remix-ide/src/app/files/dgitProvider.js +++ b/apps/remix-ide/src/app/files/dgitProvider.js @@ -18,7 +18,7 @@ const axios = require('axios') const profile = { name: 'dGitProvider', displayName: 'Decentralized git', - description: '', + description: 'Decentralized git provider', icon: 'assets/img/fileManager.webp', version: '0.0.1', methods: ['init', 'localStorageUsed', 'addremote', 'delremote', 'remotes', 'fetch', 'clone', 'export', 'import', 'status', 'log', 'commit', 'add', 'remove', 'rm', 'lsfiles', 'readblob', 'resolveref', 'branches', 'branch', 'checkout', 'currentbranch', 'push', 'pin', 'pull', 'pinList', 'unPin', 'setIpfsConfig', 'zip', 'setItem', 'getItem'], diff --git a/apps/remix-ide/src/app/panels/file-panel.js b/apps/remix-ide/src/app/panels/file-panel.js index a0d4e5dff3..983a54af70 100644 --- a/apps/remix-ide/src/app/panels/file-panel.js +++ b/apps/remix-ide/src/app/panels/file-panel.js @@ -33,7 +33,7 @@ const profile = { methods: ['createNewFile', 'uploadFile', 'getCurrentWorkspace', 'getWorkspaces', 'createWorkspace', 'setWorkspace', 'registerContextMenuItem', 'renameWorkspace', 'deleteWorkspace'], events: ['setWorkspace', 'workspaceRenamed', 'workspaceDeleted', 'workspaceCreated'], icon: 'assets/img/fileManager.webp', - description: ' - ', + description: 'Remix IDE file explorer', kind: 'fileexplorer', location: 'sidePanel', documentation: 'https://remix-ide.readthedocs.io/en/latest/file_explorer.html', diff --git a/apps/remix-ide/src/app/panels/terminal.js b/apps/remix-ide/src/app/panels/terminal.js index 6eaa65f6e9..bd89f2d7ce 100644 --- a/apps/remix-ide/src/app/panels/terminal.js +++ b/apps/remix-ide/src/app/panels/terminal.js @@ -20,7 +20,7 @@ const profile = { name: 'terminal', methods: ['log', 'logHtml'], events: [], - description: ' - ', + description: 'Remix IDE terminal', version: packageJson.version } diff --git a/apps/remix-ide/src/app/plugins/permission-handler-plugin.tsx b/apps/remix-ide/src/app/plugins/permission-handler-plugin.tsx index 29f7535066..3bec429d25 100644 --- a/apps/remix-ide/src/app/plugins/permission-handler-plugin.tsx +++ b/apps/remix-ide/src/app/plugins/permission-handler-plugin.tsx @@ -7,7 +7,7 @@ import { Profile } from '@remixproject/plugin-utils' const profile = { name: 'permissionhandler', displayName: 'permissionhandler', - description: 'permissionhandler', + description: 'Plugin to handle permissions', methods: ['askPermission'] } diff --git a/apps/remix-ide/src/app/tabs/compile-and-run.ts b/apps/remix-ide/src/app/tabs/compile-and-run.ts index d5b298e966..e90d9f5844 100644 --- a/apps/remix-ide/src/app/tabs/compile-and-run.ts +++ b/apps/remix-ide/src/app/tabs/compile-and-run.ts @@ -10,7 +10,7 @@ const _paq = window._paq = window._paq || [] export const profile = { name: 'compileAndRun', displayName: 'Compile and Run', - description: 'after each compilation, run the script defined in Natspec.', + description: 'After each compilation, run the script defined in Natspec.', methods: ['runScriptAfterCompilation'], version: packageJson.version, kind: 'none' diff --git a/apps/remix-ide/src/app/tabs/external-http-provider.tsx b/apps/remix-ide/src/app/tabs/external-http-provider.tsx index 71c7c249c0..9483989843 100644 --- a/apps/remix-ide/src/app/tabs/external-http-provider.tsx +++ b/apps/remix-ide/src/app/tabs/external-http-provider.tsx @@ -6,7 +6,7 @@ const profile = { name: 'basic-http-provider', displayName: 'External Http Provider', kind: 'provider', - description: '', + description: 'External Http Provider', methods: ['sendAsync'], version: packageJson.version } diff --git a/apps/remix-ide/src/app/tabs/foundry-provider.tsx b/apps/remix-ide/src/app/tabs/foundry-provider.tsx index 47e899865a..3c1fbb6256 100644 --- a/apps/remix-ide/src/app/tabs/foundry-provider.tsx +++ b/apps/remix-ide/src/app/tabs/foundry-provider.tsx @@ -10,7 +10,7 @@ const profile = { name: 'foundry-provider', displayName: 'Foundry Provider', kind: 'provider', - description: 'Anvil', + description: 'Foundry Anvil provider', methods: ['sendAsync'], version: packageJson.version } diff --git a/apps/remix-ide/src/app/tabs/ganache-provider.tsx b/apps/remix-ide/src/app/tabs/ganache-provider.tsx index 002e31a3a2..97adac1574 100644 --- a/apps/remix-ide/src/app/tabs/ganache-provider.tsx +++ b/apps/remix-ide/src/app/tabs/ganache-provider.tsx @@ -10,7 +10,7 @@ const profile = { name: 'ganache-provider', displayName: 'Ganache Provider', kind: 'provider', - description: 'Ganache', + description: 'Truffle Ganache provider', methods: ['sendAsync'], version: packageJson.version } diff --git a/apps/remix-ide/src/app/tabs/runTab/model/recorder.js b/apps/remix-ide/src/app/tabs/runTab/model/recorder.js index ea41368448..244d61690f 100644 --- a/apps/remix-ide/src/app/tabs/runTab/model/recorder.js +++ b/apps/remix-ide/src/app/tabs/runTab/model/recorder.js @@ -13,7 +13,7 @@ const _paq = window._paq = window._paq || [] //eslint-disable-line const profile = { name: 'recorder', displayName: 'Recorder', - description: '', + description: 'Records transactions to save and run', version: packageJson.version, methods: [ ] } diff --git a/apps/remix-ide/src/app/tabs/search.tsx b/apps/remix-ide/src/app/tabs/search.tsx index 29e6c6abe7..3e0df1a893 100644 --- a/apps/remix-ide/src/app/tabs/search.tsx +++ b/apps/remix-ide/src/app/tabs/search.tsx @@ -8,7 +8,7 @@ const profile = { methods: [''], events: [], icon: 'assets/img/search_icon.webp', - description: '', + description: 'Find and replace in file explorer', kind: '', location: 'sidePanel', documentation: '', diff --git a/apps/remix-ide/src/app/tabs/test-tab.js b/apps/remix-ide/src/app/tabs/test-tab.js index 960e2a93ce..3c6e1a4b4c 100644 --- a/apps/remix-ide/src/app/tabs/test-tab.js +++ b/apps/remix-ide/src/app/tabs/test-tab.js @@ -16,7 +16,7 @@ const profile = { methods: ['testFromPath', 'testFromSource', 'setTestFolderPath', 'getTestlibs', 'createTestLibs'], events: [], icon: 'assets/img/unitTesting.webp', - description: 'Fast tool to generate unit tests for your contracts', + description: 'Write and run unit tests for your contracts in Solidity', location: 'sidePanel', documentation: 'https://remix-ide.readthedocs.io/en/latest/unittesting.html' } diff --git a/apps/remix-ide/src/app/udapp/run-tab.js b/apps/remix-ide/src/app/udapp/run-tab.js index c9912ecb4c..02087b671f 100644 --- a/apps/remix-ide/src/app/udapp/run-tab.js +++ b/apps/remix-ide/src/app/udapp/run-tab.js @@ -12,7 +12,7 @@ const profile = { name: 'udapp', displayName: 'Deploy & run transactions', icon: 'assets/img/deployAndRun.webp', - description: 'execute and save transactions', + description: 'Execute, save and replay transactions', kind: 'udapp', location: 'sidePanel', documentation: 'https://remix-ide.readthedocs.io/en/latest/run.html', diff --git a/apps/remix-ide/src/app/ui/landing-page/landing-page.js b/apps/remix-ide/src/app/ui/landing-page/landing-page.js index 2f8819fc5f..978c4fdb1c 100644 --- a/apps/remix-ide/src/app/ui/landing-page/landing-page.js +++ b/apps/remix-ide/src/app/ui/landing-page/landing-page.js @@ -9,7 +9,7 @@ const profile = { displayName: 'Home', methods: [], events: [], - description: ' - ', + description: 'Remix home tab ', icon: 'assets/img/remixLogo.webp', location: 'mainPanel', version: packageJson.version diff --git a/apps/remix-ide/src/walkthroughService.js b/apps/remix-ide/src/walkthroughService.js index 8f088c443c..d0d466555f 100644 --- a/apps/remix-ide/src/walkthroughService.js +++ b/apps/remix-ide/src/walkthroughService.js @@ -5,7 +5,7 @@ const introJs = require('intro.js') const profile = { name: 'walkthrough', displayName: 'Walkthrough', - description: '', + description: 'Remix walkthrough for beginner', version: packageJson.version, methods: ['start'] }