Skip to content

Fix create-package to handle JSONC files #7631

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mcmire merged 1 commit into from
Jan 14, 2026
+421 −140
Merged

Fix create-package to handle JSONC files #7631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@
"@typescript-eslint/parser": "^8.48.0",
"@yarnpkg/types": "^4.0.0",
"babel-jest": "^29.7.0",
"comment-json": "^4.5.1",
"depcheck": "^1.4.7",
"eslint": "^9.39.1",
"eslint-config-prettier": "^9.1.0",
Expand Down
34 changes: 23 additions & 11 deletions scripts/create-package/utils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import * as commentJson from 'comment-json';
import execa from 'execa';
import fs from 'fs';
import path from 'path';
Expand Down Expand Up @@ -60,8 +61,8 @@ describe('create-package/utils', () => {
const monorepoFileData = await readMonorepoFiles();

expect(monorepoFileData).toStrictEqual({
tsConfig: JSON.parse(tsConfig),
tsConfigBuild: JSON.parse(tsConfigBuild),
tsConfig: commentJson.parse(tsConfig),
tsConfigBuild: commentJson.parse(tsConfigBuild),
nodeVersions: '>=18.0.0',
});
});
Expand Down Expand Up @@ -128,18 +129,29 @@ describe('create-package/utils', () => {
expect(format).toHaveBeenCalledTimes(2);
expect(fs.promises.writeFile).toHaveBeenCalledWith(
expect.stringMatching(/tsconfig\.json$/u),
JSON.stringify({
references: [{ path: './packages/bar' }, { path: './packages/foo' }],
}),
JSON.stringify(
{
references: [
{ path: './packages/bar' },
{ path: './packages/foo' },
],
},
null,
2,
),
);
expect(fs.promises.writeFile).toHaveBeenCalledWith(
expect.stringMatching(/tsconfig\.build\.json$/u),
JSON.stringify({
references: [
{ path: './packages/bar' },
{ path: './packages/foo/tsconfig.build.json' },
],
}),
JSON.stringify(
{
references: [
{ path: './packages/bar' },
{ path: './packages/foo/tsconfig.build.json' },
],
},
null,
2,
),
);

// Postprocessing
Expand Down
9 changes: 5 additions & 4 deletions scripts/create-package/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import * as commentJson from 'comment-json';
import execa from 'execa';
import { promises as fs } from 'fs';
import path from 'path';
Expand Down Expand Up @@ -75,8 +76,8 @@ export async function readMonorepoFiles(): Promise<MonorepoFileData> {
]);

return {
tsConfig: JSON.parse(tsConfig) as Tsconfig,
tsConfigBuild: JSON.parse(tsConfigBuild) as Tsconfig,
tsConfig: commentJson.parse(tsConfig) as unknown as Tsconfig,
tsConfigBuild: commentJson.parse(tsConfigBuild) as unknown as Tsconfig,
nodeVersions: (JSON.parse(packageJson) as PackageJson).engines.node,
};
}
Expand Down Expand Up @@ -111,11 +112,11 @@ export async function finalizeAndWriteData(
updateTsConfigs(packageData, monorepoFileData);
await writeJsonFile(
REPO_TS_CONFIG,
JSON.stringify(monorepoFileData.tsConfig),
commentJson.stringify(monorepoFileData.tsConfig, null, 2),
);
await writeJsonFile(
REPO_TS_CONFIG_BUILD,
JSON.stringify(monorepoFileData.tsConfigBuild),
commentJson.stringify(monorepoFileData.tsConfigBuild, null, 2),
Copy link

@cursor cursor bot Jan 14, 2026

Choose a reason for hiding this comment

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

Prettier JSON parser incompatible with JSONC comments

Medium Severity

The writeJsonFile function uses parser: 'json' with prettier, but commentJson.stringify outputs JSONC content with comments when the input object has comment symbols (parsed from real tsconfig files). Prettier's json parser doesn't support comments and would throw a parse error. The test doesn't catch this because mock data lacks comment symbols. Using parser: 'json5' instead would handle comments correctly.

Fix in Cursor Fix in Web

Copy link
Contributor Author

@mcmire mcmire Jan 14, 2026

Choose a reason for hiding this comment

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

Hmm I didn't know about this. Well, if this is a problem we can try this out.

);

// Postprocess
Expand Down
248 changes: 186 additions & 62 deletions tsconfig.build.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,80 +7,204 @@
* (indirectly) extends it.
*/
"references": [
{ "path": "./packages/account-tree-controller/tsconfig.build.json" },
{ "path": "./packages/accounts-controller/tsconfig.build.json" },
{ "path": "./packages/address-book-controller/tsconfig.build.json" },
{ "path": "./packages/analytics-controller/tsconfig.build.json" },
{ "path": "./packages/announcement-controller/tsconfig.build.json" },
{ "path": "./packages/app-metadata-controller/tsconfig.build.json" },
{ "path": "./packages/approval-controller/tsconfig.build.json" },
{ "path": "./packages/assets-controllers/tsconfig.build.json" },
{ "path": "./packages/assets-controller/tsconfig.build.json" },
{ "path": "./packages/core-backend/tsconfig.build.json" },
{ "path": "./packages/base-controller/tsconfig.build.json" },
{ "path": "./packages/bridge-controller/tsconfig.build.json" },
{ "path": "./packages/bridge-status-controller/tsconfig.build.json" },
{ "path": "./packages/build-utils/tsconfig.build.json" },
{ "path": "./packages/chain-agnostic-permission/tsconfig.build.json" },
{ "path": "./packages/claims-controller/tsconfig.build.json" },
{ "path": "./packages/composable-controller/tsconfig.build.json" },
{ "path": "./packages/controller-utils/tsconfig.build.json" },
{ "path": "./packages/delegation-controller/tsconfig.build.json" },
{ "path": "./packages/earn-controller/tsconfig.build.json" },
{ "path": "./packages/eip-5792-middleware/tsconfig.build.json" },
{
"path": "./packages/account-tree-controller/tsconfig.build.json"
},
{
"path": "./packages/accounts-controller/tsconfig.build.json"
},
{
"path": "./packages/address-book-controller/tsconfig.build.json"
},
{
"path": "./packages/analytics-controller/tsconfig.build.json"
},
{
"path": "./packages/announcement-controller/tsconfig.build.json"
},
{
"path": "./packages/app-metadata-controller/tsconfig.build.json"
},
{
"path": "./packages/approval-controller/tsconfig.build.json"
},
{
"path": "./packages/assets-controller/tsconfig.build.json"
},
{
"path": "./packages/assets-controllers/tsconfig.build.json"
},
{
"path": "./packages/base-controller/tsconfig.build.json"
},
{
"path": "./packages/bridge-controller/tsconfig.build.json"
},
{
"path": "./packages/bridge-status-controller/tsconfig.build.json"
},
{
"path": "./packages/build-utils/tsconfig.build.json"
},
{
"path": "./packages/chain-agnostic-permission/tsconfig.build.json"
},
{
"path": "./packages/claims-controller/tsconfig.build.json"
},
{
"path": "./packages/composable-controller/tsconfig.build.json"
},
{
"path": "./packages/controller-utils/tsconfig.build.json"
},
{
"path": "./packages/core-backend/tsconfig.build.json"
},
{
"path": "./packages/delegation-controller/tsconfig.build.json"
},
{
"path": "./packages/earn-controller/tsconfig.build.json"
},
{
"path": "./packages/eip-5792-middleware/tsconfig.build.json"
},
{
"path": "./packages/eip-7702-internal-rpc-middleware/tsconfig.build.json"
},
{ "path": "./packages/eip1193-permission-middleware/tsconfig.build.json" },
{ "path": "./packages/ens-controller/tsconfig.build.json" },
{ "path": "./packages/error-reporting-service/tsconfig.build.json" },
{ "path": "./packages/eth-block-tracker/tsconfig.build.json" },
{ "path": "./packages/eth-json-rpc-middleware/tsconfig.build.json" },
{ "path": "./packages/eth-json-rpc-provider/tsconfig.build.json" },
{ "path": "./packages/foundryup/tsconfig.build.json" },
{ "path": "./packages/gas-fee-controller/tsconfig.build.json" },
{ "path": "./packages/gator-permissions-controller/tsconfig.build.json" },
{ "path": "./packages/json-rpc-engine/tsconfig.build.json" },
{ "path": "./packages/json-rpc-middleware-stream/tsconfig.build.json" },
{ "path": "./packages/keyring-controller/tsconfig.build.json" },
{ "path": "./packages/logging-controller/tsconfig.build.json" },
{ "path": "./packages/message-manager/tsconfig.build.json" },
{ "path": "./packages/messenger/tsconfig.build.json" },
{ "path": "./packages/multichain-account-service/tsconfig.build.json" },
{ "path": "./packages/multichain-api-middleware/tsconfig.build.json" },
{ "path": "./packages/multichain-network-controller/tsconfig.build.json" },
{
"path": "./packages/eip1193-permission-middleware/tsconfig.build.json"
},
{
"path": "./packages/ens-controller/tsconfig.build.json"
},
{
"path": "./packages/error-reporting-service/tsconfig.build.json"
},
{
"path": "./packages/eth-block-tracker/tsconfig.build.json"
},
{
"path": "./packages/eth-json-rpc-middleware/tsconfig.build.json"
},
{
"path": "./packages/eth-json-rpc-provider/tsconfig.build.json"
},
{
"path": "./packages/foundryup/tsconfig.build.json"
},
{
"path": "./packages/gas-fee-controller/tsconfig.build.json"
},
{
"path": "./packages/gator-permissions-controller/tsconfig.build.json"
},
{
"path": "./packages/json-rpc-engine/tsconfig.build.json"
},
{
"path": "./packages/json-rpc-middleware-stream/tsconfig.build.json"
},
{
"path": "./packages/keyring-controller/tsconfig.build.json"
},
{
"path": "./packages/logging-controller/tsconfig.build.json"
},
{
"path": "./packages/message-manager/tsconfig.build.json"
},
{
"path": "./packages/messenger/tsconfig.build.json"
},
{
"path": "./packages/multichain-account-service/tsconfig.build.json"
},
{
"path": "./packages/multichain-api-middleware/tsconfig.build.json"
},
{
"path": "./packages/multichain-network-controller/tsconfig.build.json"
},
{
"path": "./packages/multichain-transactions-controller/tsconfig.build.json"
},
{ "path": "./packages/name-controller/tsconfig.build.json" },
{ "path": "./packages/network-controller/tsconfig.build.json" },
{ "path": "./packages/network-enablement-controller/tsconfig.build.json" },
{
"path": "./packages/name-controller/tsconfig.build.json"
},
{
"path": "./packages/network-controller/tsconfig.build.json"
},
{
"path": "./packages/network-enablement-controller/tsconfig.build.json"
},
{
"path": "./packages/notification-services-controller/tsconfig.build.json"
},
{ "path": "./packages/permission-controller/tsconfig.build.json" },
{ "path": "./packages/permission-log-controller/tsconfig.build.json" },
{ "path": "./packages/phishing-controller/tsconfig.build.json" },
{ "path": "./packages/polling-controller/tsconfig.build.json" },
{ "path": "./packages/preferences-controller/tsconfig.build.json" },
{ "path": "./packages/profile-metrics-controller/tsconfig.build.json" },
{ "path": "./packages/profile-sync-controller/tsconfig.build.json" },
{ "path": "./packages/ramps-controller/tsconfig.build.json" },
{ "path": "./packages/rate-limit-controller/tsconfig.build.json" },
{ "path": "./packages/remote-feature-flag-controller/tsconfig.build.json" },
{ "path": "./packages/sample-controllers/tsconfig.build.json" },
{ "path": "./packages/seedless-onboarding-controller/tsconfig.build.json" },
{ "path": "./packages/selected-network-controller/tsconfig.build.json" },
{ "path": "./packages/shield-controller/tsconfig.build.json" },
{ "path": "./packages/signature-controller/tsconfig.build.json" },
{ "path": "./packages/storage-service/tsconfig.build.json" },
{ "path": "./packages/subscription-controller/tsconfig.build.json" },
{
"path": "./packages/permission-controller/tsconfig.build.json"
},
{
"path": "./packages/permission-log-controller/tsconfig.build.json"
},
{
"path": "./packages/phishing-controller/tsconfig.build.json"
},
{
"path": "./packages/polling-controller/tsconfig.build.json"
},
{
"path": "./packages/preferences-controller/tsconfig.build.json"
},
{
"path": "./packages/profile-metrics-controller/tsconfig.build.json"
},
{
"path": "./packages/profile-sync-controller/tsconfig.build.json"
},
{
"path": "./packages/ramps-controller/tsconfig.build.json"
},
{
"path": "./packages/rate-limit-controller/tsconfig.build.json"
},
{
"path": "./packages/remote-feature-flag-controller/tsconfig.build.json"
},
{
"path": "./packages/sample-controllers/tsconfig.build.json"
},
{
"path": "./packages/seedless-onboarding-controller/tsconfig.build.json"
},
{
"path": "./packages/selected-network-controller/tsconfig.build.json"
},
{
"path": "./packages/shield-controller/tsconfig.build.json"
},
{
"path": "./packages/signature-controller/tsconfig.build.json"
},
{
"path": "./packages/storage-service/tsconfig.build.json"
},
{
"path": "./packages/subscription-controller/tsconfig.build.json"
},
{
"path": "./packages/token-search-discovery-controller/tsconfig.build.json"
},
{ "path": "./packages/transaction-controller/tsconfig.build.json" },
{ "path": "./packages/transaction-pay-controller/tsconfig.build.json" },
{ "path": "./packages/user-operation-controller/tsconfig.build.json" }
{
"path": "./packages/transaction-controller/tsconfig.build.json"
},
{
"path": "./packages/transaction-pay-controller/tsconfig.build.json"
},
{
"path": "./packages/user-operation-controller/tsconfig.build.json"
}
],
"files": [],
"include": []
Expand Down
Loading
Loading