feat: Remove generateTsConfig option from ts-proto module#108
Merged
Conversation
This commit removes the `generatePackageJson` configuration option from Bufrnix's JavaScript/TypeScript language modules. Users are now required to manage their own package.json files. ## Changes ### Configuration Schema - Removed `js.packageName` option from bufrnix-options.nix - Note: `generatePackageJson` options were never added to the schema ### Implementation - Removed packageName echo from js/default.nix initHooks - ts-proto.nix and connect.nix already had correct comments ### Examples - Updated examples/js-es-modules: - Removed generatePackageJson and packageName from flake.nix - Updated README.md with migration guidance - Updated flake.lock - Updated examples/ts-flake-parts: - Removed generatePackageJson and packageName from flake.nix - Updated README.md with migration guidance ### Documentation - Removed all generatePackageJson references from: - doc/src/content/docs/reference/configuration.mdx - doc/src/content/docs/reference/languages.mdx - doc/src/content/docs/reference/languages/javascript.mdx - doc/src/content/docs/guides/troubleshooting.mdx - Created migration guide at: - doc/src/content/docs/guides/migrating-from-generatepackagejson.mdx ### Spectr - Converted tasks.md to tasks.jsonc format - Updated proposal and design documents ## Rationale - **Focus**: Bufrnix should focus on protobuf generation, not package management - **Control**: Users have full control over package.json structure - **Maintenance**: Reduces burden of maintaining hard-coded dependency versions - **Standard Practice**: Aligns with standard JavaScript/TypeScript workflows ## Breaking Change Users currently using the removed options must: 1. Remove the configuration options from their flake.nix 2. Create/maintain their own package.json files 3. See the migration guide for details 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Remove the generateTsConfig configuration option from the ts-proto language module. This option generated a basic tsconfig.json file in the generated code output directory, which violated architectural principles by placing configuration in generated code rather than source code. Changes: - Removed generateTsConfig conditional block from src/languages/js/ts-proto.nix - Removed option definition from src/lib/bufrnix-options.nix (already removed) - Converted tasks.md to tasks.jsonc for better task tracking - All 39 test examples pass without the option Breaking Change: Users who relied on generateTsConfig = true will need to create their own tsconfig.json in their project root or use protobuf-es as a modern alternative. Implements: spectr change remove-ts-proto-generatetsconfig 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Removes the
generateTsConfigconfiguration option from the ts-proto language module as part of architectural cleanup (Spectr change:remove-ts-proto-generatetsconfig).Why This Change
The
generateTsConfigoption violated architectural principles by:What Changed
generateTsConfigblock fromsrc/languages/js/ts-proto.nix(lines 88-109)src/lib/bufrnix-options.nixin previous worktasks.mdtotasks.jsoncfor better Spectr task trackingBreaking Change
Yes - This removes a public configuration option. Users who rely on
generateTsConfig = truewill need to:tsconfig.jsonin their project root if neededImpact
false)Test Plan
./test-examples.sh)./check-examples.sh)nix fmt)lint)spectr validate remove-ts-proto-generatetsconfig)Migration Guide
Before (will no longer work):
After (recommended):
Related
remove-es-generatepackagejson(similar cleanup for protobuf-es)spectr/changes/remove-ts-proto-generatetsconfig/proposal.md🤖 Generated with Claude Code