Skip to content

Update compiler target#181

Merged
lucperkins merged 3 commits into
mainfrom
update-node
May 15, 2026
Merged

Update compiler target#181
lucperkins merged 3 commits into
mainfrom
update-node

Conversation

@lucperkins
Copy link
Copy Markdown
Member

@lucperkins lucperkins commented May 12, 2026

Description

This doesn't actually change the generated JS payload but this is something we should be doing anyway.

I also fixed a funny issue where this was showing up in the docs:

image
Checklist
  • Tested changes against a test repository
  • Added or updated relevant documentation (leave unchecked if not applicable)
  • (If this PR is for a release) Updated README to point to the new tag (leave unchecked if not applicable)

Summary by CodeRabbit

  • Documentation

    • Added project documentation and wired it into the generated TypeScript docs (README included).
  • Chores

    • Updated TypeScript build configuration to target modern JavaScript (esnext) for output compilation.

Review Change Stack

@netlify
Copy link
Copy Markdown

netlify Bot commented May 12, 2026

Deploy Preview for detsys-ts-docs ready!

Name Link
🔨 Latest commit baab84f
🔍 Latest deploy log https://app.netlify.com/projects/detsys-ts-docs/deploys/6a02a126b1a6a900088fb10b
😎 Deploy Preview https://deploy-preview-181--detsys-ts-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 12, 2026

📝 Walkthrough

Walkthrough

Adds a short DOCS.md and sets TypeDoc's readme to it; updates tsdown.config.ts TypeScript target from "node20" to "esnext".

Changes

Documentation and Build Setup

Layer / File(s) Summary
Documentation Setup with TypeDoc Integration
DOCS.md, typedoc.config.cjs
Adds DOCS.md with a brief introduction and a [detsys] link reference; typedoc.config.cjs now sets readme: "./DOCS.md".
Build Target Update
tsdown.config.ts
Changes tsdown target from "node20" to "esnext".

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A rabbit nibbles docs by night,
Links and readmes set just right.
Targets shift to esnext light,
Hopping through configs in moonlight. 🐇📜

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Update compiler target' is partially related to the changeset, referring to the TypeScript build target change from 'node20' to 'esnext', which is a real aspect of the PR. However, the PR also includes documentation updates (DOCS.md and typedoc.config.cjs changes) that are not reflected in the title, making it incomplete.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update-node

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@DOCS.md`:
- Line 2: The markdown uses non-descriptive link text "[here][typedoc]" which
triggers MD059; replace the "here" link text with a descriptive phrase (e.g.,
"generated documentation" or "Typedoc documentation") while keeping the existing
reference label [typedoc], so the line becomes something like "Check out the
generated documentation [generated documentation][typedoc]" (use a concise,
descriptive label that conveys the destination).

In `@tsdown.config.ts`:
- Line 7: The tsdown configuration sets an unsupported target "es2026"; update
the target property in tsdown.config.ts (the target: "es2026" entry) to a
supported value such as "es2023" or "esnext" so the build uses a valid
ECMAScript target and avoids transpilation errors.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 905c5c19-8cce-41f8-bbc4-243be32c1e66

📥 Commits

Reviewing files that changed from the base of the PR and between 65d8cdf and eb71b68.

📒 Files selected for processing (3)
  • DOCS.md
  • tsdown.config.ts
  • typedoc.config.cjs

Comment thread DOCS.md Outdated
Comment thread tsdown.config.ts Outdated
Copy link
Copy Markdown
Member

@cole-h cole-h left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don't forget to merge all the PRs against all the actions that this is going to spawn 🙏

Comment thread DOCS.md
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure the point of this when we already have a README.md, but it doesn't really matter 🤷

@lucperkins lucperkins merged commit 97cd148 into main May 15, 2026
6 checks passed
@lucperkins lucperkins deleted the update-node branch May 15, 2026 23:05
@lucperkins lucperkins deployed to detsys-pr-bot May 15, 2026 23:05 — with GitHub Actions Active
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants