chore: add TypeScript + Jest test setup and update README #1153

[Ananya-vastare]

This PR updates the tsconfig.json to include the test directory in the TypeScript compilation and fixes related linting issues, ensuring all source and test files are correctly recognized.

Changes

• Updated tsconfig.json to include "test/**/*.ts" in the include array.
• Fixed TypeScript errors caused by files outside the original rootDir.
• Ensured the linter rules are properly applied to both src and test directories.

Flags

• No breaking changes; this affects TypeScript compilation and linting only.
• Ensure your editor/IDE reloads the TypeScript project after this change.

Screenshots or Video

• Not applicable.

Related Issues

• N/A

Author Checklist

• Ensure you provide a DCO sign-off for your commits using the --signoff option of git commit.
• Vital features and changes captured in unit and/or integration tests.
• Commit messages follow AP format.
• Documentation updated, if necessary.
• Merging to main from fork:branchname is okay.

[divyansh-cyber]

Nice progress on this PR, and the TypeScript + Jest setup direction looks good overall.
One suggestion before merge, the new no-duplicate-declarations test currently only checks that a model variable is a string, so it doesn’t validate actual linter behavior and may give false confidence. Since this issue is primarily setup/tooling for the default ruleset, I’d recommend either,
Removing that test from this PR to keep scope focused on config/docs, orUpdating it to run the ruleset and assert real lint results (for example, expected violation code/message/count for duplicate declarations).
Everything else looks aligned with the issue goal and improves contributor experience.

[Ananya-vastare]

@divyansh-cyber Thanks for the feedback! I see your point about the current no-duplicate-declarations test — it does just check a string rather than fully validating the linter behavior, which could indeed give false confidence.
I have updated the test to actually run the default ruleset and assert expected lint results for duplicate declarations, so it validates the behavior properly.
This will ensure the test aligns with the PR’s goal of improving tooling and contributor experience without adding unnecessary scope.

[divyansh-cyber]

@divyansh-cyber Thanks for the feedback! I see your point about the current no-duplicate-declarations test — it does just check a string rather than fully validating the linter behavior, which could indeed give false confidence. I have updated the test to actually run the default ruleset and assert expected lint results for duplicate declarations, so it validates the behavior properly. This will ensure the test aligns with the PR’s goal of improving tooling and contributor experience without adding unnecessary scope.

happy to make a fix there