Skip to content

Commit

Permalink
chore(release): 1.0.15-dev
Browse files Browse the repository at this point in the history
  • Loading branch information
sinkaroid committed Jun 29, 2022
1 parent fa5ff3e commit 09053c2
Show file tree
Hide file tree
Showing 10 changed files with 42 additions and 42 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Test disgrowth
name: Test disgrow

on:
push:
Expand All @@ -24,5 +24,5 @@ jobs:
- name: Install dependencies
run: npm install

- name: Test disgrowth
- name: Test disgrow
run: npm run test:dry
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ email, or any other method with the owners before making a change.
Please note we have a code of conduct, follow it in all your interactions with the project.

## Making minor changes
@sinkaroid are not the best coder, so there are sure some problematic coding decision, every slightest of changes will helps a lot. I'm always happy to receive Pull requests to improve things.
@sinkaroid are not the best coder, so there are sure some problematic coding decision, every slight of changes will helps. I'm always happy to receive Pull requests to improve things.
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
<div align="center">
<a href="https://sinkaroid.github.io/disgrowth"><img width="470" src="https://cdn.discordapp.com/attachments/952117487166705747/990438129242628196/DISGROWTH_.png" alt="disgrowth"></a>
<a href="https://sinkaroid.github.io/disgrow"><img width="470" src="https://cdn.discordapp.com/attachments/952117487166705747/991492289262268427/disgrow.png" alt="disgrow"></a>


<h4 align="center">A growth increments for your Discord bots</h4>

<p align="center">
<a href="https://github.com/sinkaroid/disgrowth/actions/workflows/disgrowth.yml"><img src="https://github.com/sinkaroid/disgrowth/workflows/Test%20disgrowth/badge.svg"></a>
<a href="https://codeclimate.com/github/sinkaroid/disgrowth/maintainability"><img src="https://api.codeclimate.com/v1/badges/726d1d6eb057432f9432/maintainability" /></a>
<a href="https://github.com/sinkaroid/disgrow/actions/workflows/disgrow.yml"><img src="https://github.com/sinkaroid/disgrow/workflows/Test%20disgrow/badge.svg"></a>
<a href="https://codeclimate.com/github/sinkaroid/disgrow/maintainability"><img src="https://api.codeclimate.com/v1/badges/7a377c18fa1edbefbf29/maintainability" /></a>
</p>

Disgrowth is a module for Discord bots. It allows you to check your bot's growth statistics,
disgrow is a module for Discord bots. It allows you to check your bot's growth statistics,
Update hourly, and the hope that it will be reusable for every bot developers.
[The prerequisites](#Prerequisites) should be met before using this library.

<a href="https://github.com/sinkaroid/disgrowth/blob/master/CONTRIBUTING.md">Contributing</a> •
<a href="https://sinkaroid.github.io/disgrowth">Documentation</a> •
<a href="https://github.com/sinkaroid/disgrowth/issues/new/choose">Report Issues</a>
<a href="https://github.com/sinkaroid/disgrow/blob/master/CONTRIBUTING.md">Contributing</a> •
<a href="https://sinkaroid.github.io/disgrow">Documentation</a> •
<a href="https://github.com/sinkaroid/disgrow/issues/new/choose">Report Issues</a>
</div>

---

- [Disgrowth](#)
- [disgrow](#)
- [Subprojects](#Subprojects)
- [`disgrowth/tree/api`](https://github.com/sinkaroid/disgrowth/tree/api)
- [`disgrowth/tree/master`](#)
- [`disgrow/tree/api`](https://github.com/sinkaroid/disgrow/tree/api)
- [`disgrow/tree/master`](#)
- [The problem](#the-problem)
- [The solution](#the-solution)
- [Features](#features)
Expand All @@ -34,17 +34,17 @@ Update hourly, and the hope that it will be reusable for every bot developers.
- [Example](#Example)
- [The returns](#The-returns)
- [Limitations](#limitations)
- [Acknowledgements](https://github.com/sinkaroid/disgrowth/blob/master/ACKNOWLEDGEMENTS.md)
- [Acknowledgements](https://github.com/sinkaroid/disgrow/blob/master/ACKNOWLEDGEMENTS.md)
- [Legal](#legal)
- [For non JavaScript libraries](https://github.com/sinkaroid/disgrowth/tree/api)
- [For non JavaScript libraries](https://github.com/sinkaroid/disgrow/tree/api)

## The problem
There is a plenty monitoring and observability service for cloud-scale application, such as StatsD, DataDog, Prometheus, and etc. Those services are great for monitoring, but require a lot of effort to posts every parts and setup properly, many people probably still confused how to extends their discord bots with those services. Apart from complexity, the services is running, means It will consume extra Memory than usual, especially DataDog.

## The solution
There is a simple way to monitor your bot's growth. This library allows you to check your bot's growth statistics, no need posts any data, no need to extends or change your bot constructor, out of the box and less of pain.

For non JavaScript libraries, [there is an API for it](https://github.com/sinkaroid/disgrowth/tree/api)!
For non JavaScript libraries, [there is an API for it](https://github.com/sinkaroid/disgrow/tree/api)!


## Features
Expand All @@ -61,7 +61,7 @@ Don't expect more with zero configuration, the point is it can give you actionab
</table>

## 🚀Installation
`yarn add disgrowth` / `npm i disgrowth`
`yarn add disgrow` / `npm i disgrow`

## Prerequisites
<table>
Expand All @@ -71,15 +71,15 @@ Don't expect more with zero configuration, the point is it can give you actionab
> Your bot must be listed on [top.gg](https://top.gg), because this module consume top.gg data, and You must **Posting bot stats** at least once per hour, there is a `stats_hourly` property in this module, otherwise null as it misleading.
## Documentation
The documentation can be found [https://sinkaroid.github.io/disgrowth](https://sinkaroid.github.io/disgrowth)
The documentation can be found [https://sinkaroid.github.io/disgrow](https://sinkaroid.github.io/disgrow)
### Example
```js
import Disgrowth from "disgrowth";
import Disgrow from "disgrow";

const bot = new Disgrowth("724047481561809007");
const bot = new Disgrow("724047481561809007");
bot.myStats().then((res) => { console.log("myStats", res); });
```
> CommonJS should do with `const Disgrowth = require("disgrowth");`
> CommonJS should do with `const Disgrow = require("disgrow");`
### The returns
- `res.data`: object
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Disgrowth Security
# Disgrow Security

## Reporting vulnerabilities

Expand Down
12 changes: 6 additions & 6 deletions index.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import c from "./src/const";
import get from "axios";

class Disgrowth {
class Disgrow {

private base: string
private bot: string

static default: typeof Disgrowth;
static default: typeof Disgrow;

constructor(bot: string) {
if (!bot) throw new Error(c.error.missingBotId);
Expand All @@ -18,9 +18,9 @@ class Disgrowth {
* Get the summary stats increments of a bots
* @example
* ```js
* Disgrowth.myStats().then((res) => { console.log("myStats", res); });
* Disgrow.myStats().then((res) => { console.log("myStats", res); });
* ```
* https://disgrowth.mod.land/stats/get?id=724047481561809007
* https://disgrow.mod.land/stats/get?id=724047481561809007
*/
async myStats() {
const endpoint = `${this.base}/stats/get?id=${this.bot}`;
Expand All @@ -31,5 +31,5 @@ class Disgrowth {

}

Disgrowth.default = Disgrowth;
export = Disgrowth;
Disgrow.default = Disgrow;
export = Disgrow;
12 changes: 6 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"name": "disgrowth",
"version": "1.0.14",
"name": "disgrow",
"version": "1.0.15",
"description": "A growth increments for your Discord bots",
"main": "build/index.js",
"types": "index.d.ts",
"scripts": {
"build": "rm -rf build/ && tsc",
"docs": "npx typedoc --cname disgrowth.js.org --entryPointStrategy expand src/ index.ts",
"docs": "npx typedoc --cname disgrow.js.org --entryPointStrategy expand src/ index.ts",
"lint": "npx eslint . --ext .ts",
"lint:fix": "npx eslint . --fix",
"test:dry": "npx ts-node test/disgrowth.test.ts",
"test:dry": "npx ts-node test/disgrow.test.ts",
"test:mocha": "npx mocha --timeout 15000 -r ts-node/register 'test/mocha.test.ts'"
},
"keywords": [
Expand All @@ -22,9 +22,9 @@
"author": "sinkaroid",
"license": "MIT",
"bugs": {
"url": "https://github.com/sinkaroid/disgrowth/issues"
"url": "https://github.com/sinkaroid/disgrow/issues"
},
"homepage": "https://github.com/sinkaroid/disgrowth#readme",
"homepage": "https://github.com/sinkaroid/disgrow#readme",
"dependencies": {
"axios": "^0.27.2"
},
Expand Down
2 changes: 1 addition & 1 deletion src/const.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
export default {
endpoint: {
baseurl: "https://disgrowth-production.up.railway.app"
baseurl: "https://disgrow-production.up.railway.app"
},
error: {
missingBotId: "Missing bot id"
Expand Down
4 changes: 4 additions & 0 deletions test/disgrow.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import Disgrow from "../index";

const bot = new Disgrow("724047481561809007");
bot.myStats().then((res) => { console.log("myStats", res); });
4 changes: 0 additions & 4 deletions test/disgrowth.test.ts

This file was deleted.

6 changes: 3 additions & 3 deletions test/mocha.test.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import Disgrowth from "../index";
import Disgrow from "../index";
import chai from "chai";
import { Data } from "../src/interfaces";
const expect = chai.expect;
const bot = new Disgrowth("724047481561809007");
const bot = new Disgrow("724047481561809007");


describe("Disgrowth testing", () => {
describe("Disgrow testing", () => {
describe("gets the bot increments", () => {
let data: Data;
before(async () => {
Expand Down

0 comments on commit 09053c2

Please sign in to comment.