fix: add TypeScript support and configuration for pnpm scopes (#4544)

* fix: add TypeScript support and configuration for pnpm scopes

* fix: update ESLint configuration to ignore 'dist' directory

* refactor: remove dist directory and its associated files

* fix: ensure TypeScript build outputs are included

---------

Co-authored-by: Mohammad Alsmadi <[email protected]>

Author: alsmadi99

.gitignore

@@ -12,6 +12,7 @@ package.json.lerna_backup
 /*.iml
 tsconfig.tsbuildinfo
 coverage
+dist
 
 docs/.vitepress/dist
 docs/.vitepress/cache

@commitlint/config-pnpm-scopes/package.json

@@ -45,5 +45,12 @@
     "@types/node": "^18.19.17",
     "typescript": "^5.2.2"
   },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "gitHead": "e82f05a737626bb69979d14564f5ff601997f679"
 }

@commitlint/config-pnpm-scopes/tsconfig.json

@@ -1,12 +1,11 @@
 {
+  "extends": "../../tsconfig.shared.json",
   "compilerOptions": {
-    "target": "ES2020",
-    "module": "CommonJS",
-    "declaration": true,
-    "outDir": "dist",
-    "rootDir": "/",
-    "strict": true,
-    "esModuleInterop": true
+    "composite": true,
+    "rootDir": "./",
+    "outDir": "./dist"
   },
-  "include": ["/"]
+  "include": ["*.ts"],
+  "exclude": ["./dist/**/*"],
+  "references": [{ "path": "../types" }]
 }

Dockerfile.ci

@@ -8,6 +8,7 @@ RUN yarn install --frozen-lockfile --network-timeout 100000 && \
     # Commit lint CLI packages
     npm pack @commitlint/cli && \
     npm pack @commitlint/config-validator && \
+    npm pack @commitlint/config-pnpm-scopes && \
     npm pack @commitlint/config-nx-scopes && \
     npm pack @commitlint/ensure && \
     npm pack @commitlint/execute-rule && \

eslint.config.mjs

@@ -1,13 +1,13 @@
 import typescriptEslint from '@typescript-eslint/eslint-plugin';
-import {createTypeScriptImportResolver} from 'eslint-import-resolver-typescript';
+import { createTypeScriptImportResolver } from 'eslint-import-resolver-typescript';
 import jest from 'eslint-plugin-jest';
-import {importX} from 'eslint-plugin-import-x';
+import { importX } from 'eslint-plugin-import-x';
 import globals from 'globals';
 import tsParser from '@typescript-eslint/parser';
 import path from 'node:path';
-import {fileURLToPath} from 'node:url';
+import { fileURLToPath } from 'node:url';
 import js from '@eslint/js';
-import {FlatCompat} from '@eslint/eslintrc';
+import { FlatCompat } from '@eslint/eslintrc';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -19,7 +19,7 @@ const compat = new FlatCompat({
 
 export default [
 	{
-		ignores: ['**/lib/', '**/coverage/', '**/node_modules/', '**/fixtures/'],
+		ignores: ['**/lib/', '**/coverage/', '**/node_modules/', '**/fixtures/', '**/dist/'],
 	},
 	importX.flatConfigs.typescript,
 	...compat.extends('eslint:recommended', 'prettier'),

tsconfig.json

@@ -28,6 +28,7 @@
     { "path": "@commitlint/travis-cli" },
     { "path": "@commitlint/prompt" },
     { "path": "@commitlint/cz-commitlint" },
-    { "path": "@commitlint/config-conventional" }
+    { "path": "@commitlint/config-conventional" },
+    { "path": "@commitlint/config-pnpm-scopes" }
   ]
 }