feat: migrate project to TypeScript

[j9t]

Summary by CodeRabbit

• New Features

  • Updated to version 1.7.0, introducing new build and development scripts for improved workflow.
  • Added TypeScript compiler configuration with a new tsconfig.json file for enhanced type safety and compilation settings.

• Bug Fixes

  • Adjusted paths in test cases to reference the correct location of the executable script.

• Documentation

  • Updated .gitignore to streamline repository management by ignoring the dist directory.

• Refactor

  • Transitioned to ES module syntax in test files for better compatibility and readability.
  • Enhanced type safety in core application code with explicit type annotations.

[coderabbitai]

Walkthrough

The changes introduce TypeScript support to the project by updating the package.json to include build scripts and dependencies, transitioning files to ES module syntax, and enhancing type safety in the codebase. A new tsconfig.json file is added to configure TypeScript compilation settings. Additionally, the .gitignore file is updated to exclude the dist/ directory from version control, reflecting a shift in project structure and output.

Changes

File(s)	Change Summary
.gitignore	Added dist/ to ignore distribution files.
package.json	Updated version to 1.7.0, modified scripts for build and development, added TypeScript dependencies.
src/obsohtml.test.ts	Transitioned from CommonJS to ES module syntax and updated paths for test cases.
src/obsohtml.ts	Added TypeScript type annotations for variables and function parameters.
tsconfig.json	Introduced TypeScript compiler configuration with specified options and file inclusion/exclusion settings.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f5d5258 and 1bd4c9a.

Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

Files selected for processing (5)

• .gitignore (1 hunks)
• package.json (2 hunks)
• src/obsohtml.test.ts (2 hunks)
• src/obsohtml.ts (3 hunks)
• tsconfig.json (1 hunks)

Files skipped from review due to trivial changes (3)

• .gitignore
• src/obsohtml.test.ts
• tsconfig.json

Additional comments not posted (11)

package.json (5)

5-5: Version update approved.

The version increment from 1.6.3 to 1.7.0 is appropriate for the addition of TypeScript support, aligning with semantic versioning practices.

---

20-20: Addition of build script approved.

The build script using tsc is essential for compiling TypeScript files and is correctly configured.

---

21-21: Addition of dev script approved.

The dev script using ts-node for direct execution of TypeScript files enhances the development workflow.

---

22-22: Update to start script approved.

The change to execute the JavaScript file from the dist directory aligns with the typical output structure for compiled TypeScript projects.

---

30-34: Addition of TypeScript-related dependencies approved.

The new dependencies (@types/commander, @types/node, ts-node, typescript) are crucial for enabling TypeScript development and ensuring type safety.

src/obsohtml.ts (6)

3-7: Type annotations for imports approved.

The explicit type annotations for imports (fs, path, os, Command, Chalk) enhance type safety and clarity in the codebase.

---

12-17: Type annotations for obsoleteElements and obsoleteAttributes approved.

The explicit type string[] for both obsoleteElements and obsoleteAttributes ensures type safety and is appropriate for their usage in the script.

---

22-22: Type annotation for defaultProjectDirectory approved.

The explicit type string for defaultProjectDirectory clarifies its usage and ensures type safety.

---

25-27: Modifications to findObsolete function approved.

The addition of type annotations for the filePath parameter (string) and the return type (Promise<void>) enhances the function's clarity and type safety.

Also applies to: 33-33, 41-41

---

47-49: Modifications to walkDirectory function approved.

The addition of type annotations for the directory (string) and verbose (boolean) parameters, along with the return type (void), enhances the function's clarity and type safety.

---

97-97: Modifications to main function approved.

The addition of type annotations for the projectDirectory (string) and verbose (boolean) parameters, along with the return type (Promise<void>), enhances the function's clarity and type safety.

Also applies to: 109-110

[j9t]

(Continued work on this, got everything to run except for some issue with the tests, but ultimately decided all the many hoops are not worth it. Not now.)