feat(utilities): add possibility to import single functions by append…

…ing them to the import path. (#454)

Co-authored-by: Jeroen Claassens <support@favware.tech>

.eslintignore

@@ -2,3 +2,4 @@ node_modules/
 **/dist/
 **/docs/
 **/*.d.ts
+**/coverage/

.github/workflows/continuous-integration.yml

@@ -113,3 +113,20 @@ jobs:
           token: ${{ secrets.CODECOV_TOKEN }}
           directory: coverage/
           fail_ci_if_error: true
+
+  Check_SubPath:
+    name: Check SubPath
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Project
+        uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3
+      - name: Use Node.js v16
+        uses: actions/setup-node@2fddd8803e2f5c9604345a0b591c3020ee971a93 # tag=v3
+        with:
+          node-version: 16
+          cache: yarn
+          registry-url: https://registry.yarnpkg.org/
+      - name: Install Dependencies
+        run: yarn --immutable
+      - name: Run Script
+        run: yarn check-subpath -- --check

package.json

@@ -14,7 +14,8 @@
 		"docs": "turbo run docs",
 		"update": "yarn upgrade-interactive",
 		"postinstall": "husky install .github/husky",
-		"check-update": "turbo run check-update"
+		"check-update": "turbo run check-update",
+		"check-subpath": "turbo run check-subpath"
 	},
 	"devDependencies": {
 		"@actions/core": "^1.10.0",

packages/cron/src/lib/Cron.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/restrict-plus-operands */
 import { range } from '@sapphire/utilities';
 import { allowedNum, cronTokens, partRegex, predefined, Time, tokensRegex, wildcardRegex } from './constants';
 
@@ -105,7 +104,6 @@ export class Cron {
 			return [...new Set(res)].sort((a, b) => a - b);
 		}
 
-		// eslint-disable-next-line prefer-const
 		const [, wild, minStr, maxStr, step] = partRegex.exec(cronPart)!;
 		let [min, max] = [parseInt(minStr, 10), parseInt(maxStr, 10)];
 

packages/decorators/src/utils.ts

@@ -89,7 +89,6 @@ export function createFunctionPrecondition(precondition: FunctionPrecondition, f
  * @param handler The handler function to modify the constructor behavior for the target
  * @hidden
  */
-// eslint-disable-next-line @typescript-eslint/ban-types
 export function createProxy<T extends object>(target: T, handler: Omit<ProxyHandler<T>, 'get'>): T {
 	return new Proxy(target, {
 		...handler,

packages/discord.js-utilities/src/lib/MessagePrompter/strategies/MessagePrompterBaseStrategy.ts

@@ -1,4 +1,4 @@
-import { Awaitable, isNullish } from '@sapphire/utilities';
+import { isNullish, type Awaitable } from '@sapphire/utilities';
 import type { CollectorFilter, CollectorOptions, EmojiIdentifierResolvable, Message, MessageReaction, User } from 'discord.js';
 import { isTextBasedChannel } from '../../type-guards';
 import type { MessagePrompterChannelTypes, MessagePrompterMessage } from '../constants';

packages/discord.js-utilities/src/lib/type-guards.ts

@@ -1,4 +1,4 @@
-import { isNullish, Nullish } from '@sapphire/utilities';
+import { isNullish, type Nullish } from '@sapphire/utilities';
 import type { APIGuildMember, APIInteractionDataResolvedGuildMember, APIInteractionGuildMember, APIMessage } from 'discord-api-types/v9';
 import {
 	GuildMember,

packages/discord.js-utilities/src/lib/utilities.ts

@@ -1,4 +1,4 @@
-import { isNullish, Nullish } from '@sapphire/utilities';
+import { isNullish, type Nullish } from '@sapphire/utilities';
 import { Permissions, type VoiceBasedChannel } from 'discord.js';
 import { isDMChannel, isGuildBasedChannel, isVoiceBasedChannel } from './type-guards';
 import type { ChannelTypes } from './utility-types';

packages/duration/src/lib/Duration.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/restrict-plus-operands */
 const tokens = new Map([
 	['nanosecond', 1 / 1e6],
 	['nanoseconds', 1 / 1e6],

packages/duration/src/lib/DurationFormatter.ts

@@ -66,7 +66,6 @@ export interface DurationFormatSeparators {
 }
 
 export interface DurationFormatAssetsUnit extends Record<number, string> {
-	// eslint-disable-next-line @typescript-eslint/naming-convention
 	DEFAULT: string;
 }
 

packages/duration/tests/lib/DurationFormatter.test.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/restrict-plus-operands, @typescript-eslint/naming-convention */
 import { DurationFormatter } from '../../src';
 
 enum Time {

packages/event-iterator/tests/index.test.ts

@@ -80,7 +80,6 @@ describe('EventIterator', () => {
 
 		const iter = emitter.createPeopleIterator({ idle: 500 });
 
-		// eslint-disable-next-line @typescript-eslint/no-unused-vars
 		for await (const {} of iter) {
 			// Give always false expectation to make this always throw
 			expect(false).toBe(true);

packages/event-iterator/tests/lib/MockEmitter.ts

@@ -20,11 +20,9 @@ export class PeopleEmitter extends EventEmitter {
 			if (this.#emitted === this.#people.length) {
 				clearInterval(this.#timeout!);
 				this.#timeout = null;
-				// eslint-disable-next-line no-unused-expressions
 				this.#iterator?.end();
 				this.#iterator = null;
 			} else {
-				// eslint-disable-next-line no-unused-expressions
 				this.emit('testEvent', this.#people[this.#emitted++]);
 			}
 		}, 1000);

packages/snowflake/src/lib/Snowflake.ts

@@ -30,7 +30,7 @@ export class Snowflake {
 	/**
 	 * Alias for {@link deconstruct}
 	 */
-	// eslint-disable-next-line @typescript-eslint/unbound-method, @typescript-eslint/no-invalid-this
+	// eslint-disable-next-line @typescript-eslint/unbound-method
 	public decode = this.deconstruct;
 
 	/**

packages/ts-config/tests/tsconfig.test.ts

@@ -1,4 +1,4 @@
-import { testBuild } from '.';
+import { testBuild } from './fixture';
 
 describe('TSConfig Test Build', () => {
 	test('should return param if instanceof string', () => {

packages/utilities/README.md

@@ -34,6 +34,20 @@ npm install @sapphire/utilities
 
 ---
 
+## Usage
+
+You can import individual utility function from subpath like: @sapphire/utility/isFunction or the entire library.
+
+```ts
+import { isFunction } from '@sapphire/utilities/isFunction';
+// or
+import { isFunction } from '@sapphire/utilities';
+```
+
+**Note:** For typescript users, subpath import are only supported in `--moduleResolution node16` and `--moduleResolution nodenext`. More information can be found [in this issue on the microsoft/TypeScript repository](https://github.com/microsoft/TypeScript/issues/50794).
+
+---
+
 ## Buy us some doughnuts
 
 Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!