Skip to content

chore: Clean up issues in import order and docs #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PartMan7 merged 12 commits into from
Oct 30, 2025
Merged

chore: Clean up issues in import order and docs #92

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
9c9d166
Fix broken links and update repository references in README
TurboRx Oct 23, 2025
a8de2e1
Fix grammar issues and update Node.js version requirement
TurboRx Oct 23, 2025
ef75375
Fix license field to match LICENSE file (MIT instead of ISC)
TurboRx Oct 23, 2025
66e37cc
Fix import order: move Logger import before it's used
TurboRx Oct 23, 2025
2844748
Fix generic function declaration typo in Array.prototype.sample
TurboRx Oct 23, 2025
b2828ed
Fix web port type issue - ensure number type
TurboRx Oct 23, 2025
79f25fd
Fix line ending: ensure file ends with LF
TurboRx Oct 23, 2025
569faf3
Fix line ending: ensure index.ts ends with LF
TurboRx Oct 23, 2025
64e93c3
Fix line ending: ensure prototypes.ts ends with LF
TurboRx Oct 23, 2025
1dbc3c5
Fix line ending: ensure README.md ends with LF and no accidental dupl…
TurboRx Oct 24, 2025
656953c
Fix line ending: ensure package.json ends with LF
TurboRx Oct 29, 2025
8834ad2
Fix line ending and shorten URL in CONTRIBUTING.md
TurboRx Oct 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ docs.

## System Requirements and Setup

PartBot requires Node.js v16+ (untested on lower versions) to run, and uses `npm` as the package manager.
PartBot requires Node.js v18+ (v16+ may work but v18+ is recommended) to run, and uses `npm` as the package manager.

To install, clone this repository and install dependencies.

Expand All @@ -22,8 +22,8 @@ This will also run the `prepare` script, which installs Husky hooks and patches

## Configuration

Once with setup, please copy the `.env.example` file to `.env` and change the values accordingly. This file populates
the environment variable. The full list of supported env variables is below:
Once setup is complete, please copy the `.env.example` file to `.env` and change the values accordingly. This file populates
the environment variables. The full list of supported env variables is below:

- `PREFIX`: The prefix to use for commands on PS.
- `PS_USERNAME`: The username for the chatbot on PS.
Expand All @@ -44,4 +44,4 @@ automatically run on every pull request.

---

For details about the structure of PartBot (globals, types, layouts, etc.) please refer to the [structure documentation](https://github.com/PartMan7/PartBot/tree/main/docs/STRUCTURE.md).
For details about the structure of PartBot (globals, types, layouts, etc.) please refer to the [structure documentation](docs/STRUCTURE.md).
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ PartBot does a lot of stuff across a wide variety of platforms, with a heavy foc

## Suggestions, Bug Reports, and Feedback

See [Suggestions & Feedback](https://github.com/PartMan7/PartBot/tree/main/docs/SUGGESTIONS.md) for ideas, bugs, and requests. Contributions are always welcome!
See [Suggestions & Feedback](docs/SUGGESTIONS.md) for ideas, bugs, and requests. Contributions are always welcome!

## Getting Started

Expand All @@ -20,7 +20,7 @@ See [Suggestions & Feedback](https://github.com/PartMan7/PartBot/tree/main/docs/

### Installation & Setup

See the [setup docs](/SETUP.md) for the setup process.
See the [setup docs](SETUP.md) for the setup process.

## Translations

Expand All @@ -33,7 +33,7 @@ Currently, PartBot supports the following languages on Showdown:
- Portuguese (PoC [@Seyhura](https://github.com/Seyhura))
- French (PoC [@Distrib](https://github.com/Distrib-ps))

Feel free to refer to the [source code](https://github.com/PartMan7/PartBot/tree/main/src/i18n/languages) for the actual translations.
Feel free to refer to the [source code](src/i18n/languages) for the actual translations.

## Credits

Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
},
"keywords": [],
"author": "PartMan7",
"license": "ISC",
"license": "MIT",
"dependencies": {
"@js-temporal/polyfill": "^0.5.1",
"@swc/core": "^1.7.40",
Expand Down
2 changes: 1 addition & 1 deletion src/config/web.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export const port = process.env.WEB_PORT ?? 8080;
export const port = parseInt(process.env.WEB_PORT ?? '8080', 10);
2 changes: 1 addition & 1 deletion src/globals/prototypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ Object.defineProperties(Array.prototype, {
enumerable: false,
writable: false,
configurable: false,
value: function T<T>(this: T[], amount: number, rng?: RNGSource): T[] {
value: function <T>(this: T[], amount: number, rng?: RNGSource): T[] {
const RNG = useRNG(rng);
const sample = Array.from(this),
out: T[] = [];
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import 'dotenv/config';
import '@/globals';
import { Logger } from '@/utils/logger';

Logger.log('PartBot is starting up...');

Expand All @@ -8,4 +9,3 @@ import '@/ps';
import '@/web';

import '@/sentinel';
import { Logger } from '@/utils/logger';