{"id":20218411,"url":"https://github.com/skyra-project/editable-commands","last_synced_at":"2025-04-10T15:48:34.445Z","repository":{"id":37017784,"uuid":"316841644","full_name":"skyra-project/editable-commands","owner":"skyra-project","description":"A framework agnostic library for editable commands.","archived":false,"fork":false,"pushed_at":"2024-05-19T02:03:01.000Z","size":13831,"stargazers_count":6,"open_issues_count":4,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-05-19T03:20:03.262Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/skyra-project.png","metadata":{"funding":{"github":["kyranet","favna"],"patreon":"kyranet","open_collective":null,"ko_fi":"kyranet","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://donate.skyra.pw/paypal","https://donate.favware.tech/paypal"]},"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-28T23:37:44.000Z","updated_at":"2024-06-01T01:23:10.939Z","dependencies_parsed_at":"2024-01-16T01:12:22.730Z","dependency_job_id":"a7a4dbd5-9819-48e8-ba80-20d79769e96d","html_url":"https://github.com/skyra-project/editable-commands","commit_stats":{"total_commits":265,"total_committers":7,"mean_commits":"37.857142857142854","dds":"0.38113207547169814","last_synced_commit":"ad2d64fd56b1dc096c5f3f942a7e36a567bd7e80"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skyra-project%2Feditable-commands","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skyra-project%2Feditable-commands/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skyra-project%2Feditable-commands/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skyra-project%2Feditable-commands/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/skyra-project","download_url":"https://codeload.github.com/skyra-project/editable-commands/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224580201,"owners_count":17334730,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest"],"created_at":"2024-11-14T06:38:29.418Z","updated_at":"2024-11-14T06:38:30.139Z","avatar_url":"https://github.com/skyra-project.png","language":"TypeScript","funding_links":["https://github.com/sponsors/kyranet","https://github.com/sponsors/favna","https://patreon.com/kyranet","https://ko-fi.com/kyranet","https://donate.skyra.pw/paypal","https://donate.favware.tech/paypal","https://www.patreon.com/kyranet","https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=CET28NRZTDQ8L"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n![Skyra Logo](https://cdn.skyra.pw/gh-assets/skyra_avatar.png)\n\n# @skyra/editable-commands\n\n**A framework agnostic library for editable commands**\n\n[![GitHub](https://img.shields.io/github/license/skyra-project/editable-commands)](https://github.com/skyra-project/editable-commands/blob/main/LICENSE.md)\n\n[![npm](https://img.shields.io/npm/v/@skyra/editable-commands?color=crimson\u0026label=NPM\u0026logo=npm\u0026style=flat-square)](https://www.npmjs.com/package/@skyra/editable-commands)\n\n[![Support Server](https://discord.com/api/guilds/254360814063058944/embed.png?style=banner2)](https://join.skyra.pw)\n\n\u003c/div\u003e\n\n---\n\n## Features\n\n-   @skyra/editable-commands is a framework agnostic implementation of editable commands for discord.js v13.\n-   Supports CommonJS and ES Modules.\n\n## Installation\n\nYou can use the following command to install this package, or replace `npm install` with your package manager of choice.\n\n```sh\nnpm install @skyra/editable-commands\n```\n\n## Usage\n\n### JavaScript\n\n#### Without a framework\n\n```js\nconst { send } = require('@skyra/editable-commands');\n\nclient.on('messageCreate', (message) =\u003e {\n\tsend(message, 'This is my reply!');\n});\n\nclient.on('messageUpdate', (_oldMessage, newMessage) =\u003e {\n\tsend(newMessage, 'This is my new reply!');\n});\n```\n\n#### With [Sapphire Framework][sapphire]\n\n```js\nconst { Command } = require('@sapphire/framework');\nconst { MessageEmbed } = require('discord.js');\nconst { send } = require('@skyra/editable-commands');\n\nmodule.exports = class UserCommand extends Command {\n\tconstructor(context, options) {\n\t\tsuper(context, {\n\t\t\t...options,\n\t\t\tdescription: 'A very cool command',\n\t\t\trequiredClientPermissions: ['EMBED_LINKS']\n\t\t});\n\t}\n\n\trun(message) {\n\t\tconst embed = new MessageEmbed()\n\t\t\t.setURL('https://github.com/skyra-project/editable-commands')\n\t\t\t.setColor('#7586D8')\n\t\t\t.setDescription('Example description')\n\t\t\t.setTimestamp();\n\n\t\treturn send(message, { embeds: [embed] });\n\t}\n};\n```\n\n### TypeScript\n\n#### Without a framework\n\n```ts\nimport { send } from '@skyra/editable-commands';\n\nclient.on('messageCreate', (message) =\u003e {\n\tsend(message, 'This is my reply!');\n});\n\nclient.on('messageUpdate', (_oldMessage, newMessage) =\u003e {\n\tsend(newMessage, 'This is my new reply!');\n});\n```\n\n#### With [Sapphire Framework][sapphire]\n\n```ts\nimport { ApplyOptions } from '@sapphire/decorators';\nimport { Command, CommandOptions } from '@sapphire/framework';\nimport { Message, MessageEmbed } from 'discord.js';\nimport { send } from '@skyra/editable-commands';\n\n@ApplyOptions\u003cCommandOptions\u003e({\n\tdescription: 'A very cool command',\n\trequiredClientPermissions: ['EMBED_LINKS']\n})\nexport class UserCommand extends Command {\n\tpublic run(message: Message) {\n\t\tconst embed = new MessageEmbed()\n\t\t\t.setURL('https://github.com/skyra-project/editable-commands')\n\t\t\t.setColor('#7586D8')\n\t\t\t.setDescription('Example description')\n\t\t\t.setTimestamp();\n\n\t\treturn send(message, { embeds: [embed] });\n\t}\n}\n```\n\n---\n\n## Buy us some doughnuts\n\nSkyra Project is open source and always will be, even if we don't get donations. That said, we know there are amazing people who\nmay still want to donate just to show their appreciation. Thanks you very much in advance!\n\nWe accept donations through Patreon, BitCoin, Ethereum, and Litecoin. You can use the buttons below to donate through your method of choice.\n\n| Donate With |         QR         |                                                                  Address                                                                  |\n| :---------: | :----------------: | :---------------------------------------------------------------------------------------------------------------------------------------: |\n|   Patreon   | ![PatreonImage][]  |                                               [Click Here](https://www.patreon.com/kyranet)                                               |\n|   PayPal    |  ![PayPalImage][]  |                     [Click Here](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=CET28NRZTDQ8L)                      |\n|   BitCoin   | ![BitcoinImage][]  |         [3JNzCHMTFtxYFWBnVtDM9Tt34zFbKvdwco](bitcoin:3JNzCHMTFtxYFWBnVtDM9Tt34zFbKvdwco?amount=0.01\u0026label=Skyra%20Discord%20Bot)          |\n|  Ethereum   | ![EthereumImage][] | [0xcB5EDB76Bc9E389514F905D9680589004C00190c](ethereum:0xcB5EDB76Bc9E389514F905D9680589004C00190c?amount=0.01\u0026label=Skyra%20Discord%20Bot) |\n|  Litecoin   | ![LitecoinImage][] |         [MNVT1keYGMfGp7vWmcYjCS8ntU8LNvjnqM](litecoin:MNVT1keYGMfGp7vWmcYjCS8ntU8LNvjnqM?amount=0.01\u0026label=Skyra%20Discord%20Bot)         |\n\n## Contributors\n\nPlease make sure to read the [Contributing Guide][contributing] before making a pull request.\n\nThank you to all the people who already contributed to Skyra Project!\n\n\u003ca href=\"https://github.com/skyra-project/editable-commands/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=skyra-project/editable-commands\" /\u003e\n\u003c/a\u003e\n\n[contributing]: https://github.com/skyra-project/.github/blob/main/.github/CONTRIBUTING.md\n[patreonimage]: https://cdn.skyra.pw/gh-assets/patreon.png\n[paypalimage]: https://cdn.skyra.pw/gh-assets/paypal.png\n[bitcoinimage]: https://cdn.skyra.pw/gh-assets/bitcoin.png\n[ethereumimage]: https://cdn.skyra.pw/gh-assets/ethereum.png\n[litecoinimage]: https://cdn.skyra.pw/gh-assets/litecoin.png\n[sapphire]: https://github.com/sapphiredev/framework\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskyra-project%2Feditable-commands","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskyra-project%2Feditable-commands","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskyra-project%2Feditable-commands/lists"}