@sapphire-sh/utils 1.36.0 → 1.38.0

package/lib/eslint.d.ts

@@ -0,0 +1,24 @@
+declare const config: ({
+    readonly rules: Readonly<import("eslint").Linter.RulesRecord>;
+} | import("typescript-eslint/dist/compatibility-types").CompatibleConfig | {
+    rules: {
+        '@typescript-eslint/no-floating-promises': string;
+        '@typescript-eslint/no-misused-promises': string;
+        '@typescript-eslint/no-unnecessary-condition': string;
+        '@typescript-eslint/switch-exhaustiveness-check': string;
+        '@typescript-eslint/return-await': string[];
+        '@typescript-eslint/prefer-readonly': string;
+        '@typescript-eslint/strict-boolean-expressions': string;
+    };
+    languageOptions: {
+        parserOptions: {
+            project: boolean;
+        };
+    };
+    ignores?: undefined;
+} | {
+    ignores: string[];
+    rules?: undefined;
+    languageOptions?: undefined;
+})[];
+export default config;

package/lib/eslint.js

@@ -0,0 +1,76 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const js_1 = __importDefault(require("@eslint/js"));
+const eslint_config_prettier_1 = __importDefault(require("eslint-config-prettier"));
+const typescript_eslint_1 = __importDefault(require("typescript-eslint"));
+const config = [
+    js_1.default.configs.recommended,
+    ...typescript_eslint_1.default.configs.recommended,
+    eslint_config_prettier_1.default,
+    {
+        rules: {
+            // General
+            'no-console': 'off',
+            'no-constant-condition': ['error', { checkLoops: false }],
+            'no-var': 'error',
+            'no-throw-literal': 'error',
+            'no-param-reassign': 'error',
+            'no-nested-ternary': 'error',
+            'no-unneeded-ternary': 'error',
+            'prefer-const': 'error',
+            'prefer-template': 'error',
+            'prefer-destructuring': 'error',
+            'prefer-arrow-callback': 'error',
+            'eqeqeq': ['error', 'always'],
+            'object-shorthand': 'error',
+            'no-else-return': 'error',
+            'arrow-body-style': ['error', 'as-needed'],
+            'func-style': ['error', 'expression'],
+            'yoda': 'error',
+            // TypeScript
+            '@typescript-eslint/no-unused-vars': ['error', { varsIgnorePattern: '^_', argsIgnorePattern: '^_' }],
+            '@typescript-eslint/naming-convention': [
+                'error',
+                {
+                    selector: 'interface',
+                    format: ['PascalCase'],
+                    custom: { regex: '^I[A-Z]', match: false },
+                },
+            ],
+            '@typescript-eslint/no-namespace': 'off',
+            '@typescript-eslint/no-shadow': 'off',
+            '@typescript-eslint/consistent-type-imports': 'error',
+            '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
+            '@typescript-eslint/no-explicit-any': 'warn',
+            '@typescript-eslint/no-non-null-assertion': 'warn',
+            '@typescript-eslint/no-unnecessary-type-assertion': 'error',
+            '@typescript-eslint/array-type': ['error', { default: 'array' }],
+            '@typescript-eslint/prefer-nullish-coalescing': 'error',
+            '@typescript-eslint/prefer-optional-chain': 'error',
+        },
+    },
+    {
+        // Type-aware rules (requires parserOptions.project in consumer config)
+        rules: {
+            '@typescript-eslint/no-floating-promises': 'error',
+            '@typescript-eslint/no-misused-promises': 'error',
+            '@typescript-eslint/no-unnecessary-condition': 'error',
+            '@typescript-eslint/switch-exhaustiveness-check': 'error',
+            '@typescript-eslint/return-await': ['error', 'in-try-catch'],
+            '@typescript-eslint/prefer-readonly': 'error',
+            '@typescript-eslint/strict-boolean-expressions': 'error',
+        },
+        languageOptions: {
+            parserOptions: {
+                project: true,
+            },
+        },
+    },
+    {
+        ignores: ['**/*.json', 'node_modules/'],
+    },
+];
+exports.default = config;

package/lib/notify.js

@@ -2,7 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.notifySlack = notifySlack;
 exports.notifyMattermost = notifyMattermost;
+const logger_1 = require("./logger");
 async function notifySlack(url, text) {
+    logger_1.logger.debug('[notifySlack] posting to webhook', { textLength: text.length });
     const resp = await fetch(url, {
         method: 'POST',
         headers: {
@@ -10,11 +12,13 @@ async function notifySlack(url, text) {
         },
         body: JSON.stringify({ text }),
     });
+    logger_1.logger.debug('[notifySlack] response received', { status: resp.status });
     if (!resp.ok) {
         throw new Error(`Slack webhook failed: HTTP ${resp.status}`);
     }
 }
 async function notifyMattermost(baseUrl, token, channelId, message) {
+    logger_1.logger.debug('[notifyMattermost] posting to channel', { channelId, messageLength: message.length });
     const resp = await fetch(`${baseUrl}/api/v4/posts`, {
         method: 'POST',
         headers: {
@@ -23,6 +27,7 @@ async function notifyMattermost(baseUrl, token, channelId, message) {
         },
         body: JSON.stringify({ channel_id: channelId, message }),
     });
+    logger_1.logger.debug('[notifyMattermost] response received', { status: resp.status });
     if (!resp.ok) {
         throw new Error(`Mattermost post failed: HTTP ${resp.status}`);
     }

package/lib/prettier.js

@@ -6,6 +6,9 @@ const config = {
     tabWidth: 2,
     useTabs: true,
     printWidth: 120,
+    trailingComma: 'all',
+    arrowParens: 'always',
+    endOfLine: 'lf',
     plugins: ['prettier-plugin-organize-imports'],
 };
 exports.default = config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapphire-sh/utils",
-  "version": "1.36.0",
+  "version": "1.38.0",
   "description": "@sapphire-sh/utils",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -25,14 +25,36 @@
   },
   "homepage": "https://github.com/sapphire-sh/sapphire-utils#readme",
   "peerDependencies": {
+    "@eslint/js": ">=9.0.0",
+    "eslint": ">=9.0.0",
+    "eslint-config-prettier": ">=9.0.0",
     "prettier": ">=3.0.0",
-    "prettier-plugin-organize-imports": ">=4.0.0"
+    "prettier-plugin-organize-imports": ">=4.0.0",
+    "typescript-eslint": ">=8.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@eslint/js": {
+      "optional": true
+    },
+    "eslint": {
+      "optional": true
+    },
+    "eslint-config-prettier": {
+      "optional": true
+    },
+    "typescript-eslint": {
+      "optional": true
+    }
   },
   "devDependencies": {
+    "@eslint/js": "^9.24.0",
     "@vitest/coverage-v8": "^4.1.1",
+    "eslint": "^9.24.0",
+    "eslint-config-prettier": "^10.1.2",
     "prettier": "^3.8.1",
     "prettier-plugin-organize-imports": "^4.3.0",
     "typescript": "^5.9.3",
+    "typescript-eslint": "^8.29.1",
     "vitest": "^4.1.1"
   }
 }