fix: esm compatibility issues

[Jamie-BitFlight]

Description

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Code refactoring
• Performance improvement
• Test update
• Build/CI update
• Other (please describe):

Related Issues

• Fixes #
• Related to #

Changes Made

Testing

• All existing tests pass
• Added new tests for new functionality
• Manually tested the changes
• Updated documentation

Checklist

• My code follows the project's code style
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings or errors
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published

Screenshots (if applicable)

Additional Notes

Summary by CodeRabbit

• Documentation

  • Added a critical workflow section describing dist/ file handling and CI-driven distribution steps
  • Added new AI coding/instructions guidance
  • Adjusted guidance around commit/pre-commit hook descriptions
  • Standardized README usage example formatting

• Dependencies

  • Bumped multiple core and dev dependency versions (action tooling, icon libs, formatter/lint utilities)

[coderabbitai]

Walkthrough

Adds a critical "Dist Files Workflow" section to copilot docs, adds CLAUDE.md, updates README example quoting, bumps multiple dependencies in package.json, and refactors nconf imports in src/inputs.ts. All changes are docs, dependency updates, or a local-import refactor; no public API changes.

Changes

Cohort / File(s)	Summary
Copilot instructions & dist workflow .github/copilot-instructions.md	Adds "⚠️ CRITICAL: Dist Files Workflow" detailing dist/ file handling, AI decision logic, commit/CI workflow and rationale; suppresses explicit pre-commit / commit-msg hook narrative and adjusts surrounding formatting.
Claude guidelines CLAUDE.md	New file adding Claude AI instructions that reference project coding standards and .github/copilot-instructions.md.
README formatting README.md	Changes example YAML empty string literals from single quotes ('') to double quotes ("") in usage examples (textual only).
Dependency bumps package.json	Updates versions for several dependencies and devDependencies (e.g., @actions/core, @actions/github, @svgdotjs/svg.js, feather-icons, prettier, yaml, @commitlint/cli, @commitlint/config-conventional, etc.).
Import refactor src/inputs.ts	Replaces named imports of IOptions and Provider from nconf with a default nconf import, then defines const { Provider } = nconf and type IOptions = nconf.IOptions; whitespace tweak only.

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

• Pay attention to compatibility risks for bumped packages in package.json, especially @actions/* and @commitlint/*.
• Verify src/inputs.ts import refactor preserves both runtime behavior and TypeScript typings.
• Skim .github/copilot-instructions.md for clarity and any CI/hook wording that could be misinterpreted.

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'fix: esm compatibility issues' accurately reflects the main changes in the pull request, which involve updating dependencies and modifying imports in src/inputs.ts to address ESM compatibility concerns.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch claude/fix-readme-generator-issue-011CUpBbScMduUTctqgM3pYN

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 60acd70 and d350a2d.

⛔ Files ignored due to path filters (1)

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

📒 Files selected for processing (5)

• .github/copilot-instructions.md (5 hunks)
• CLAUDE.md (1 hunks)
• README.md (2 hunks)
• package.json (1 hunks)
• src/inputs.ts (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• README.md
• package.json

🧰 Additional context used

🧬 Code graph analysis (2)

src/inputs.ts (1)

__tests__/inputs.test.ts (3)

• process (155-166)
• log (119-126)
• beforeEach (128-167)

.github/copilot-instructions.md (2)

src/readme-generator.ts (1)

• generate (95-102)

src/readme-editor.ts (1)

• ReadmeEditor (27-114)

🪛 LanguageTool

.github/copilot-instructions.md

[uncategorized] ~181-~181: The official name of this software platform is spelled with a capital “H”.
Context: ...odifications 4. CI deploy workflow (.github/workflows/deploy.yml lines 87-92): ...

(GITHUB)

CLAUDE.md

[uncategorized] ~5-~5: The official name of this software platform is spelled with a capital “H”.
Context: ... and project standards, please read: @.github/copilot-instructions.md This file cont...

(GITHUB)

🔇 Additional comments (3)

.github/copilot-instructions.md (1)

156-213: Excellent addition of dist workflow documentation!

This section provides clear, actionable guidance on handling dist/ files and the CI workflow. The decision logic for AI agents (lines 162-174) is particularly helpful for preventing common mistakes.

The documentation effectively explains:

• Why dist/ modifications should be ignored in local commits
• How the CI deploy workflow handles dist/ files
• The relationship between .gitignore and tracked dist/ files

Minor style note: Line 181 could capitalize "GitHub" in .github/workflows/deploy.yml for consistency with the official platform name, though this is a very minor point.

CLAUDE.md (1)

1-14: LGTM! Clear reference file for AI coding guidelines.

This file effectively points to the comprehensive coding guidelines in .github/copilot-instructions.md and summarizes the key areas covered. The structure is simple and serves its purpose well.

Note: The static analysis hint about capitalizing "github" in line 5 is a false positive—.github is the correct directory name for GitHub's special directories.

src/inputs.ts (1)

13-24: ESM compatibility refactor is solid—no issues found.

Verification confirms that nconf.IOptions is a valid type export and the build completes successfully with the new import pattern. The type alias is used consistently across the codebase (return types, assertions), and the default import with destructuring properly handles the CommonJS module in ESM context. The refactor resolves ESM compatibility with nconf 0.12.1 as intended.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[github-actions]

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	49.93%	404 / 809
🔵	Statements	50.6%	416 / 822
🔵	Functions	65.74%	71 / 108
🔵	Branches	49.38%	200 / 405

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
src/inputs.ts	90.47%	81.03%	100%	90.47%	336-341, 370-371, 399, 489, 624-629

Generated in workflow #224 for commit d350a2d by the Vitest Coverage Report Action

[Copilot]

Pull Request Overview

This PR updates project dependencies to their latest versions and refactors the nconf import pattern in src/inputs.ts from named imports to a default import with destructured access. Additionally, it adds documentation for AI coding assistants and improves markdown formatting in the copilot instructions.

• Updates all production and development dependencies to current versions
• Refactors nconf import from named to default import pattern
• Adds CLAUDE.md file for AI assistant reference
• Enhances copilot instructions with dist/ file workflow documentation

Reviewed Changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/inputs.ts	Changed nconf import from named imports to default import with destructured Provider and type alias for IOptions
package.json	Updated all production dependencies (@actions/core, chalk, prettier, etc.) and key dev dependencies (@commitlint packages) to latest versions
package-lock.json	Reflected dependency updates with resolved versions and integrity hashes, added new transitive dependencies
README.md	Standardized quotes in usage examples from single to double quotes for consistency
CLAUDE.md	Added new file directing Claude AI to read copilot instructions
.github/copilot-instructions.md	Added critical dist/ files workflow documentation and improved markdown formatting with blank lines

[Copilot]

The import has changed from named imports import { IOptions, Provider } from 'nconf'; to a default import import nconf from 'nconf';. However, nconf's TypeScript definitions export Provider and IOptions as named exports, not as properties of a default export. This could cause type errors if nconf doesn't provide a default export or if the default export doesn't include these members. Verify that nconf v0.12.1 properly supports default imports and that nconf.Provider and nconf.IOptions are accessible.

[Copilot]

[nitpick] Removed blank line after bullet point content. While this makes the markdown more compact, the previous formatting with a blank line between list items improved readability. Consider keeping the blank lines for consistency with the enhanced formatting added elsewhere in this file (e.g., lines 19, 29, 39, 69, 73).