feat: added type declarations

/spend 10m

Author: Nico Ismaili

commitlint.config.ts

@@ -1,10 +1,12 @@
 import { type UserConfig } from '@commitlint/types';
 import spendPlugin from './index';
 
-export default {
+const config: UserConfig = {
   extends: [`@commitlint/config-conventional`],
   rules: {
     spend: [2, `always`],
   },
   plugins: [spendPlugin],
-} satisfies UserConfig;
+};
+
+export default config;

index.ts

@@ -1,8 +1,10 @@
 import type { Plugin } from '@commitlint/types';
 import { validateCommitMsg } from './src/utils/validateCommitMsg/validateCommitMsg';
 
-export default {
+const spendPlugin: Plugin = {
   rules: {
     spend: validateCommitMsg,
   },
-} satisfies Plugin;
+};
+
+export default spendPlugin;

package.json

@@ -34,7 +34,7 @@
     "url": "https://github.com/nico-i/commitlint-plugin-spend/issues"
   },
   "scripts": {
-    "build": "bun build ./index.ts --outdir ./out --minify",
+    "build": "bun build ./index.ts --outdir ./out --minify && bunx tsc",
     "lint": "eslint . --ext .ts && prettier . --check",
     "lint:fix": "eslint . --ext .ts --fix && prettier . --write",
     "prepare": "husky || true"

src/types/SpendCommand/SpendCommand.ts

@@ -8,7 +8,7 @@ export type SpendCommand = (typeof spendingCommands)[number];
 
 export const spendCommandPattern = new RegExp(
   `^(${spendingCommands.join(`|`)})$`,
-);
+) as RegExp;
 
 export function isSpendCommand(value: string): value is SpendCommand {
   return spendingCommands.includes(value as SpendCommand);

src/types/TimeValue/TimeValue.ts

@@ -21,7 +21,7 @@ export type TimeValue = `${number}${TimeUnit}`;
  */
 export const timeValuePattern = new RegExp(
   `^(\\d{1,2})(${orderedTimeUnits.join(`|`)})$`,
-);
+) as RegExp;
 
 export function isTimeValue(value: string): value is TimeValue {
   return timeValuePattern.test(value);

tsconfig.json

@@ -1,18 +1,18 @@
 {
+  "include": ["src/**/*", "index.ts"],
   "compilerOptions": {
     // Environment setup & latest features
     "lib": ["ESNext"],
     "target": "ESNext",
     "module": "Preserve",
     "moduleDetection": "force",
     "jsx": "react-jsx",
-    "allowJs": true,
 
     // Bundler mode
     "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
     "verbatimModuleSyntax": true,
-    "noEmit": true,
+    "emitDeclarationOnly": true,
+    "isolatedDeclarations": true,
 
     // Best practices
     "strict": true,
@@ -24,6 +24,9 @@
     // Some stricter flags (disabled by default)
     "noUnusedLocals": false,
     "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false
+    "noPropertyAccessFromIndexSignature": false,
+
+    "declaration": true,
+    "outDir": "out"
   }
 }