Skip to content

Commit

Permalink
Merge
Browse files Browse the repository at this point in the history
  • Loading branch information
Smaug6739 committed Dec 15, 2021
2 parents 09c9e58 + a839eaa commit f9243b3
Show file tree
Hide file tree
Showing 78 changed files with 629 additions and 831 deletions.
15 changes: 10 additions & 5 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,13 @@

version: 2
updates:
- package-ecosystem: "npm" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "daily"
target-branch: "dev"
# Fetch and update latest `npm` packages
- package-ecosystem: npm
directory: '/'
target-branch: "dev"
schedule:
interval: daily
reviewers:
- Smaug6739
assignees:
- Smaug6739
32 changes: 32 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Changelog

**All notable changes to this project will be documented in this file.**

# [[2.0.1]](https://github.com/Sheweny/cli/compare/2.0.0...2.0.1) December 15, 2021

### Changed

- CLI Structure: The CLI is now pure ESM module ([300385b](https://github.com/Sheweny/cli/commit/300385b66441735cd30d0cc6c7e68a132feb2ccd)).
- Github: Improve README.md style ([5eb2eb1](https://github.com/Sheweny/cli/commit/5eb2eb1b57c8c2b40e1824c3ada20b771dc63c7e)).

### Fixed

- Use: Chalk version 5.0.0 ([91afd40](https://github.com/Sheweny/cli/commit/91afd40dd7a8ed237681abfad38893357cd332c4))
- Use: Execa version 6.0.0 ([a4c8794](https://github.com/Sheweny/cli/commit/a4c87940d2ac3985e7bf3b1900f5081f5a6a4069))

# [[2.0.0]](https://github.com/Sheweny/cli/compare/2.1.0...3.0.0) - November 21, 2021

### Added

- Templates: Add version 3 templates ([ecfedd1](https://github.com/Sheweny/cli/commit/ecfedd193c334e3718467def10fc6f679c6b935b))
- Init: Add `init` command for use the cli with an existing project ([4579be5](https://github.com/Sheweny/cli/commit/4579be59ef16ab68a53175e7286e7ee38fb53624))

### Changed

- Help: Changed the style of help command ([081e988](https://github.com/Sheweny/cli/commit/081e988de1e02b196e73c1ec3cef2e568b4a9e45))

### Fixed

- Templates: Fix typescript V2 template ([028feb9](https://github.com/Sheweny/cli/commit/028feb9bb536966c577a3454d7b4ac8b50312d95))
- Templates: Fix javascript V2 template ([dc99d79](https://github.com/Sheweny/cli/commit/dc99d794fd0cdd7e1624e15026d6f3b7f0410d60))
- Create: Fix package.json ([da7f799](https://github.com/Sheweny/cli/commit/da7f799fa05ada1634e94f96f8e560358250f137))
117 changes: 99 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sheweny CLI

![sheweny](https://cdn.discordapp.com/attachments/881988260925153322/882027519753224244/sheweny_baniere.png)
![sheweny_baniere (5)](https://user-images.githubusercontent.com/59796136/146163807-a14768d5-c8c9-4968-a55f-a19157cf6ead.png)

[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/Sheweny/cli)
[![made-with-Markdown](https://img.shields.io/badge/Made%20with-Typescript-1f425f.svg)](http://commonmark.org)
Expand All @@ -10,42 +10,123 @@

This module is a CLI (Command Line Interface) for create discord bots with Sheweny framework.

[GUIDE](https://sheweny.js.org/guide/cli/Usage.html)
**Guide : [Click here](https://sheweny.js.org/guide/cli/Usage.html)**

## Getting started
- [Sheweny](#sheweny-cli)
- [Getting started](#getting-started-)
- [Prerequisites](#prerequisites-)
- [Installation](#installation-)
- [Usage](#usage-)
- [Informations](#informations-)
- [Create command](#create-command-)
- [Add command](#add-command-)
- [Init command](#init-command-)
- [Version command](#version-command-)
- [Common errors](#common-errors-%EF%B8%8F)
- [Contributions/Licence](#contributionslicence-)
- [Help](#need-help-)

Prerequisites
## Getting started ✨

### Prerequisites 👀

Node.js 16.6.0 or newer is required.

### Instalation
### Installation 🎈

For creating a discord bot project with the Sheweny framework, sheweny's command line interface will make your life easier.
To use it is very simple, you just need to have npm (or yarn), and to install the module.

Install with npm

```sh
npm install -g @sheweny/cli
```

Install with yarn

```sh
yarn global add @sheweny/cli
```

Once the command line interface is installed, you can go to the next section to learn more about the different commands.

## Usage 💡

With npm :
### Informations 📖

```sh-session
npm install @sheweny/cli
The command line interface has several prefixes which are `sheweny` and `shw`, so for the following commands, you can use one of the 2 prefixes.
The help command is also at your disposal if you are too lazy to come to the guide.

```sh
sheweny --help
```

With yarn :
### Create command ⛏️

To create a project, you just need to run the following command.

```sh-session
yarn add @sheweny/cli
```sh
sheweny create [project_name]
```

## Commands
Then you will have a series of questions that will allow you to refine the result of your project creation and to have a bot start that meets your expectations.
Depending on what you have answered, you will have access from the start, the creation of the project has commands, events, or interactions.

### sheweny create
For more information, you can run the help command: `sheweny --help create`

### Add command 🔥

To add a template in your project with the sheweny framework, you just need to run the following command.

```sh
sheweny add
```

Create a new bot from the options you choose
You have several types of template addition depending on what you want to add

### sheweny add
- command
- event
- button
- selectmenu
- inhibitor

Add a component to your bot (command, event, inhibitor, button, select-menu...)
After choosing the type of addition, you can answer the questions that are offered to once again refine the result of adding a template.

For more information, you can run the help command: `sheweny --help add`.

### Init command 🏁

This command is used to initialize the Command Line Interface (CLI) with **an existing project** .

### Version command 📈

This command return the version of the CLI (not the framework).

---

After having done all this, you can of course edit the project code as you wish with an editor, using the rest of the Guide or with the Documentation.

## Common errors ☢️

### Execution Policy 🔴

If you have an error :

```sh
File cannot be loaded because the execution of scripts is disabled on this system. Please see "get-help about_signing" for more details
```

Changed script execution parameter. On an administrator powershell, you can do this by running the following command:

```sh
Set-ExecutionPolicy Unrestricted
```

## Contributions/Licence
## Contributions/Licence 🌍

This project has an MIT license. And you are welcome to contribute.

## Need help
## Need help 👍

If you have question or need help, open issue or join [support server](https://discord.gg/qgd85nEf5a).
4 changes: 0 additions & 4 deletions bin/sheweny

This file was deleted.

3 changes: 3 additions & 0 deletions bin/sheweny.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#!/usr/bin/env node

import("../lib/cli.js").then((i) => i.cli(process.argv));
Loading

0 comments on commit f9243b3

Please sign in to comment.