feat(scripts): Add max-warnings arg for ESLint

Author: TheCodeDestroyer

.changeset/salty-pianos-write.md

@@ -0,0 +1,5 @@
+---
+'@tcd-devkit/scripts': patch
+---
+
+Add max-warnings arg for ESLint

packages/scripts/README.md

@@ -64,11 +64,12 @@ Runs ESLint, Prettier (check mode), and TypeScript type checking.
 - `--refresh-cache`: Force refresh of the cache.
 - `--ignore-path <path>`: Path to a custom ignore file (e.g., `.myignore`).
 - `--project <path>`: Path to your `tsconfig.json` or equivalent TypeScript project file. (e.g., `tcd-scripts lint --project ./tsconfig.build.json`)
+- `--max-warnings <number>`: Maximum number of warnings allowed before failing. (Default: 0)
 
 **Example:**
 
 ```bash
-tcd-scripts lint ./src ./tests --only eslint --project ./tsconfig.lint.json
+tcd-scripts lint ./src ./tests --only eslint --project ./tsconfig.lint.json --max-warnings 10
 ```
 
 #### `tcd-scripts format [files...]` (alias: `tcd-scripts f`)

packages/scripts/src/commands/format.command.ts

@@ -26,7 +26,6 @@ export const registerFormatCommand = (program: Command) => {
     .addOption(noCacheOption)
     .addOption(refreshCacheOption)
     .addOption(ignorePathOption)
-
     .action(async (files: string[], options: FormatCommandOptions) => {
       const toolsToRun = getToolsToRun(FORMAT_TOOLS, options);
       let overallSuccess = true;

packages/scripts/src/commands/lint.command.ts

@@ -5,6 +5,7 @@ import {
   ignorePathOption,
   lintOnlyOption,
   lintSkipOption,
+  maxWarningsOption,
   noCacheOption,
   projectOption,
   refreshCacheOption,
@@ -31,6 +32,7 @@ export const registerLintCommand = (program: Command) => {
     .addOption(refreshCacheOption)
     .addOption(ignorePathOption)
     .addOption(projectOption)
+    .addOption(maxWarningsOption)
     .action(async (files, options: LintCommandOptions) => {
       const toolsToRun = getToolsToRun(LINT_TOOLS, options);
       let overallSuccess = true;

packages/scripts/src/constants/option.constants.ts

@@ -54,6 +54,11 @@ export const ignorePathOption = new Option(
   'Path to ignore file for Prettier',
 );
 
+export const maxWarningsOption = new Option(
+  '--max-warnings <number>',
+  'Maximum number of warnings allowed before failing',
+).default('0');
+
 export const projectOption = new Option(
   '--project <path>',
   'Path to TS config for TSC',

packages/scripts/src/types/option.types.ts

@@ -9,6 +9,7 @@ interface BaseCommandOptions {
   refreshCache?: boolean;
   cacheLocation?: string;
   ignorePath?: string;
+  maxWarnings?: string;
 }
 
 export interface ToolSelectionOptions<TTool extends string> {

packages/scripts/src/utils/cli.utils.ts

@@ -157,6 +157,9 @@ export const runEslint = async (
   const eslintArgs = [];
 
   if (isFix) eslintArgs.push('--fix');
+  if (options.maxWarnings !== undefined) {
+    eslintArgs.push('--max-warnings', options.maxWarnings.toString());
+  }
 
   await handleCache(options, eslintArgs, './.eslintcache');