Skip to content

Commit dffdb55

Browse files
authored
chore: Clean up issues in import order and docs (#92)
* Fix broken links and update repository references in README * Fix grammar issues and update Node.js version requirement * Fix license field to match LICENSE file (MIT instead of ISC) * Fix import order: move Logger import before it's used * Fix generic function declaration typo in Array.prototype.sample * Fix web port type issue - ensure number type * Fix line ending: ensure file ends with LF * Fix line ending: ensure index.ts ends with LF * Fix line ending: ensure prototypes.ts ends with LF * Fix line ending: ensure README.md ends with LF and no accidental duplicate changes * Fix line ending: ensure package.json ends with LF * Fix line ending and shorten URL in CONTRIBUTING.md
1 parent f4aebec commit dffdb55

6 files changed

Lines changed: 11 additions & 11 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ docs.
88

99
## System Requirements and Setup
1010

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

1313
To install, clone this repository and install dependencies.
1414

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

2323
## Configuration
2424

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

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

4545
---
4646

47-
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).
47+
For details about the structure of PartBot (globals, types, layouts, etc.) please refer to the [structure documentation](docs/STRUCTURE.md).

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ PartBot does a lot of stuff across a wide variety of platforms, with a heavy foc
1010

1111
## Suggestions, Bug Reports, and Feedback
1212

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

1515
## Getting Started
1616

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

2121
### Installation & Setup
2222

23-
See the [setup docs](/SETUP.md) for the setup process.
23+
See the [setup docs](SETUP.md) for the setup process.
2424

2525
## Translations
2626

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

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

3838
## Credits
3939

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
},
2121
"keywords": [],
2222
"author": "PartMan7",
23-
"license": "ISC",
23+
"license": "MIT",
2424
"dependencies": {
2525
"@js-temporal/polyfill": "^0.5.1",
2626
"@swc/core": "^1.7.40",

src/config/web.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
export const port = process.env.WEB_PORT ?? 8080;
1+
export const port = parseInt(process.env.WEB_PORT ?? '8080', 10);

src/globals/prototypes.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ Object.defineProperties(Array.prototype, {
190190
enumerable: false,
191191
writable: false,
192192
configurable: false,
193-
value: function T<T>(this: T[], amount: number, rng?: RNGSource): T[] {
193+
value: function <T>(this: T[], amount: number, rng?: RNGSource): T[] {
194194
const RNG = useRNG(rng);
195195
const sample = Array.from(this),
196196
out: T[] = [];

src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import 'dotenv/config';
22
import '@/globals';
3+
import { Logger } from '@/utils/logger';
34

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

@@ -8,4 +9,3 @@ import '@/ps';
89
import '@/web';
910

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

0 commit comments

Comments
 (0)