Skip to content

Commit c0a9a6d

Browse files
DEVTomatoCakeDEVTomatoCake
committedDec 16, 2023
ESLint + new api url + events + postEvent -> custom
·
v1.0.0v1.0.0-pre1
1 parent 9f1a585 commit c0a9a6d

File tree

8 files changed

+1813
-3268
lines changed

8 files changed

+1813
-3268
lines changed
 

‎.eslintrc.json

+77-10
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
"node": true,
44
"es2022": true
55
},
6-
"ignorePatterns": ["util/temp.js", "befehle/eval.js"],
6+
"plugins": ["unicorn", "sonarjs"],
7+
"ignorePatterns": ["index.test.js"],
78
"rules": {
89
"array-bracket-spacing": 2,
910
"array-callback-return": 2,
@@ -23,12 +24,12 @@
2324
"key-spacing": 2,
2425
"keyword-spacing": 2,
2526
"max-statements-per-line": 2,
26-
"max-len": [2, { "code": 500 }],
27-
"new-cap": 2,
27+
"max-len": [2, { "code": 250 }],
2828
"new-parens": 2,
2929
"no-array-constructor": 2,
3030
"no-compare-neg-zero": 2,
3131
"no-const-assign": 2,
32+
"no-constructor-return": 2,
3233
"no-dupe-args": 2,
3334
"no-dupe-keys": 2,
3435
"no-duplicate-case": 2,
@@ -60,7 +61,7 @@
6061
"no-unreachable": 1,
6162
"no-unreachable-loop": 2,
6263
"no-unsafe-finally": 2,
63-
"no-unused-vars": [2, { "argsIgnorePattern": "args|next", "varsIgnorePattern": "updateSlashcommands" }],
64+
"no-unused-vars": 2,
6465
"no-useless-computed-key": 2,
6566
"no-useless-rename": 2,
6667
"no-useless-escape": 2,
@@ -72,6 +73,7 @@
7273
"no-useless-backreference": 2,
7374
"no-useless-catch": 2,
7475
"no-unneeded-ternary": 2,
76+
"no-undef": [2, { "typeof": true }],
7577
"no-undef-init": 2,
7678
"no-useless-constructor": 2,
7779
"no-redeclare": 2,
@@ -83,9 +85,8 @@
8385
"no-unsafe-optional-chaining": 2,
8486
"no-unmodified-loop-condition": 2,
8587
"no-promise-executor-return": 2,
86-
"no-warning-comments": 2,
87-
"no-new": 2,
88-
"no-var": 1,
88+
"no-warning-comments": 1,
89+
"no-var": 2,
8990
"no-new-func": 2,
9091
"no-new-wrappers": 2,
9192
"no-multi-str": 2,
@@ -97,14 +98,80 @@
9798
"no-irregular-whitespace": [2, { "skipRegExps": true }],
9899
"no-constant-condition": 2,
99100
"no-undefined": 2,
100-
"no-confusing-arrow": 2,
101101
"no-lone-blocks": 2,
102102
"no-whitespace-before-property": 2,
103103
"object-shorthand": 2,
104104
"prefer-arrow-callback": 2,
105-
"prefer-const": 1,
105+
"prefer-const": 2,
106106
"quotes": [2, "double", { "allowTemplateLiterals": false, "avoidEscape": true }],
107107
"use-isnan": 2,
108-
"valid-typeof": 2
108+
"valid-typeof": 2,
109+
110+
"unicorn/empty-brace-spaces": 2,
111+
"unicorn/error-message": 2,
112+
"unicorn/new-for-builtins": 2,
113+
"unicorn/consistent-destructuring": 2,
114+
"unicorn/consistent-function-scoping": 2,
115+
"unicorn/no-array-method-this-argument": 2,
116+
"unicorn/no-lonely-if": 2,
117+
"unicorn/no-instanceof-array": 2,
118+
"unicorn/no-nested-ternary": 2,
119+
"unicorn/no-new-buffer": 2,
120+
"unicorn/no-console-spaces": 2,
121+
"unicorn/no-for-loop": 2,
122+
"unicorn/no-useless-undefined": 2,
123+
"unicorn/no-zero-fractions": 2,
124+
"unicorn/no-unreadable-iife": 2,
125+
"unicorn/no-unnecessary-await": 2,
126+
"unicorn/no-unreadable-array-destructuring": 2,
127+
"unicorn/no-useless-switch-case": 2,
128+
"unicorn/no-typeof-undefined": 2,
129+
"unicorn/no-useless-fallback-in-spread": 2,
130+
"unicorn/no-useless-length-check": 2,
131+
"unicorn/no-useless-spread": 2,
132+
"unicorn/no-useless-promise-resolve-reject": 2,
133+
"unicorn/prefer-array-find": 2,
134+
"unicorn/prefer-array-index-of": 2,
135+
"unicorn/prefer-includes": 2,
136+
"unicorn/prefer-logical-operator-over-ternary": 2,
137+
"unicorn/prefer-date-now": 2,
138+
"unicorn/prefer-default-parameters": 2,
139+
"unicorn/prefer-array-some": 2,
140+
"unicorn/prefer-blob-reading-methods": 2,
141+
"unicorn/prefer-at": 2,
142+
"unicorn/prefer-optional-catch-binding": 2,
143+
"unicorn/prefer-regexp-test": 2,
144+
"unicorn/prefer-set-has": 2,
145+
"unicorn/prefer-set-size": 2,
146+
"unicorn/prefer-negative-index": 2,
147+
"unicorn/prefer-node-protocol": 2,
148+
"unicorn/prefer-prototype-methods": 2,
149+
"unicorn/prefer-string-trim-start-end": 2,
150+
"unicorn/prefer-string-starts-ends-with": 2,
151+
"unicorn/require-array-join-separator": 2,
152+
"unicorn/require-number-to-fixed-digits-argument": 2,
153+
"unicorn/switch-case-braces": [2, "avoid"],
154+
"unicorn/text-encoding-identifier-case": 2,
155+
156+
"sonarjs/no-extra-arguments": 2,
157+
"sonarjs/no-empty-collection": 2,
158+
"sonarjs/no-element-overwrite": 2,
159+
"sonarjs/no-use-of-empty-return-value": 2,
160+
"sonarjs/no-all-duplicated-branches": 2,
161+
"sonarjs/no-ignored-return": 2,
162+
"sonarjs/no-identical-expressions": 2,
163+
"sonarjs/no-one-iteration-loop": 2,
164+
"sonarjs/non-existent-operator": 2,
165+
"sonarjs/no-redundant-boolean": 2,
166+
"sonarjs/no-unused-collection": 2,
167+
"sonarjs/prefer-immediate-return": 2,
168+
"sonarjs/no-inverted-boolean-check": 2,
169+
"sonarjs/no-redundant-jump": 2,
170+
"sonarjs/no-same-line-conditional": 2,
171+
"sonarjs/prefer-object-literal": 2,
172+
"sonarjs/no-collection-size-mischeck": 2,
173+
"sonarjs/prefer-while": 2,
174+
"sonarjs/no-gratuitous-expressions": 2,
175+
"sonarjs/no-duplicated-branches": 2
109176
}
110177
}

‎.github/workflows/eslint.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
name: ESLint
1+
name: Run ESLint
22

33
on:
44
push:
5-
branches: [ master ]
5+
pull_request:
66

77
jobs:
88
lint:
99
name: ESLint
1010
runs-on: ubuntu-latest
1111
steps:
1212
- name: "☁️ checkout repository"
13-
uses: actions/checkout@v3
13+
uses: actions/checkout@v4
1414

1515
- name: "🔧 setup node"
1616
uses: actions/setup-node@v3
1717
with:
18-
node-version: 18
18+
node-version: 20
1919
cache: "npm"
2020

2121
- name: "🔍 lint code"

‎.github/workflows/test.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
name: Run tests
1+
name: Run Jest tests
22

33
on:
44
push:
55
pull_request:
66

77
jobs:
88
test:
9-
name: Run jest
9+
name: Tests
1010
runs-on: ubuntu-latest
1111
steps:
1212
- name: "☁️ checkout repository"
13-
uses: actions/checkout@v3
13+
uses: actions/checkout@v4
1414

1515
- name: "🔧 setup node"
1616
uses: actions/setup-node@v3
1717
with:
18-
node-version: 18
18+
node-version: 20
1919
cache: "npm"
2020

2121
- name: "🔍 run tests"

‎README.md

+32-19
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
# DisStat-npm
2-
The official npm package for [DisStat](https://disstat.numselli.xyz)
2+
The official npm package for [DisStat](https://disstat.pages.dev) -
3+
DisStat itself is [open source](https://github.com/DisStat/DisStat) btw!
34

4-
You can find the public api and example responses on https://disstat.numselli.xyz/docs,
5-
if you dont want to use an api wrapper.
6-
7-
## ⚠️ Warning: This package is still in development and may not work as expected.
8-
DisStat itself is still in development too, so expect breaking changes while we're not fully released.
5+
You can find the public HTTP api docs on https://disstat.pages.dev/docs if you dont want to use an api wrapper.
96

107
# Installation
118
```bash
@@ -17,16 +14,17 @@ npm i disstat
1714
const DisStat = require("disstat")
1815

1916
/*
20-
* @param {string} apiKey - Your api key, found at the bot page
21-
* @param {string} bot - Your bot's user id OR a discord.js based bot client.
22-
* If a client is provided, the package will automatically post server and user count to DisStat.
17+
* @param {string} apiKey - Your api key, found in your dashboard on https://disstat.pages.dev/me
18+
* @param {string|Discord.Client} bot - Your bot's user id OR a discord.js based bot client.
19+
*
20+
* If a client is provided, the package will automatically post server and user count to DisStat ("autoposting").
2321
* Note that the client has to be ready, so if you're using a client there, put this into it's ready event.
2422
*/
2523
const disstat = new DisStat("DS-apikey123", "685166801394335819")
2624
const disstat = new DisStat("DS-apikey123", client)
2725

2826
/*
29-
* Gets data from your bot or someone else's (public) bot.
27+
* Gets data from your bot or someone else public bot.
3028
* @param {string} botId? - The bot's id
3129
* @returns {Promise<Object>} - The bot's data
3230
*/
@@ -35,27 +33,42 @@ console.log(botData)
3533

3634
/*
3735
* Posts your bots data to DisStat.
38-
* @param {Object} data - The data to post
36+
* Warning: You shouldn't use this when autoposting.
37+
*
38+
* @param {Object} data - The data to post:
3939
* @param {number} data.servers - The amount of servers your bot is in, e.g. client.guilds.cache.size
4040
* @param {number} data.users - The amount of users your bot can see, e.g. client.users.cache.size
4141
* @param {number} data.shards - The amount of shards your bot is using, e.g. client.shard.count
42-
* @param {boolean} returnStats? - Whether to return the stats after posting, default false
43-
* @returns {Promise<Object>} - The stats after posting, if returnStats is true
4442
*/
45-
const newBotData = await disstat.postData({ servers: 42, users: 100, shards: 1 }, true)
43+
const newBotData = await disstat.postData({ servers: 42, users: 100, shards: 1 })
4644
console.log(newBotData)
4745

4846
/*
4947
* Posts a command to DisStat.
48+
* You shouldn't post user generated commands like custom commands to protect user privacy.
49+
* You also should exclude the prefix and command arguments from the command.
50+
*
5051
* @param {string} command - The command to post
5152
* @param {string} userId? - The user's id
53+
* @param {string} guildId? - The guild's id
54+
* @param {Boolean} force? - Whether to force the command to be posted instantly IF autoposting is enabled,
55+
* defaults to false, causing a delay from up to 90 seconds.
5256
*/
53-
disstat.postCommand("help", "581146486646243339")
57+
disstat.postCommand("info")
58+
disstat.postCommand("help", "581146486646243339", "1081089799324180490")
5459

5560
/*
56-
* Posts an event to DisStat.
57-
* @param {string} command - The command to post
58-
* @param {string} userId? - The user's id
61+
* Posts data for a custom graph to DisStat.
62+
* Note that using a not used type here creates the custom graph on DisStat if you have enough unused graph slots.
63+
*
64+
* @param {string} type - The type of event to post
65+
* @param {string|Number} value1? - First custom value (e.g. an event name like "interactionCreate")
66+
* @param {string|Number} value2? - Second custom value (e.g. a user ID)
67+
* @param {string|Number} value3? - Third custom value (e.g. a guild ID)
5968
*/
60-
disstat.postEvent("interactionCreate", "581146486646243339")
69+
disstat.postCustom("events", "interactionCreate")
70+
71+
if (message.content.includes("<@" + bot.user.id + ">")) {
72+
disstat.postCustom("ping")
73+
}
6174
```

0 commit comments

Comments
 (0)
Please sign in to comment.