Skip to content

force esm via tsconfig, remove package.json creation #2084

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

Closed
wants to merge 10 commits into from
Closed

force esm via tsconfig, remove package.json creation #2084

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
9db24ae
force esm via tsconfig, remove package.json creation
josefaidt Oct 7, 2024
63898fd
npm run update:api
josefaidt Oct 7, 2024
aa26514
revert client-config api update
josefaidt Nov 1, 2024
22079e0
Merge remote-tracking branch 'upstream/main' into create-amplify-no-p…
josefaidt Nov 1, 2024
db7fe8e
revert change to platform-core api
josefaidt Nov 1, 2024
4fbfce6
add changeset
josefaidt Nov 1, 2024
2949c11
bump minimum typescript req to 5.4 in create-amplify
josefaidt Nov 4, 2024
f0232a6
re-add moduleResolution: bundler to defer resolution logic to tsx
josefaidt Nov 4, 2024
5e5ebe2
remove snippet from tests for package.json
josefaidt Nov 5, 2024
e0768bb
Merge remote-tracking branch 'upstream/main' into create-amplify-no-p…
josefaidt Nov 5, 2024
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
6 changes: 6 additions & 0 deletions .changeset/thirty-starfishes-smash.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'create-amplify': patch
'@aws-amplify/cli-core': patch
---

update create-amplify flow to init a tsconfig that forces module context, removes creation of package.json in the amplify directory
3 changes: 2 additions & 1 deletion packages/cli-core/src/package-manager-controller/package_manager_controller_base.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,8 @@ export abstract class PackageManagerControllerBase
const tsConfigTemplate = {
compilerOptions: {
target: 'es2022',
module: 'es2022',
module: 'preserve',
Copy link
Contributor

@sobolk sobolk Nov 4, 2024

Choose a reason for hiding this comment

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

Few things here.

  1. TS docs mention esnext next to preserve: You very likely want "nodenext" for modern Node.js projects and preserve or esnext for code that will be bundled . Why would we choose preserve over esnext ? (unless bundling doesn't matter here anymore).
  2. preserve was added in Typescript 5.4 . If we do this we have to bump Typescript to ^5.4.0. Including here

    amplify-backend/packages/create-amplify/src/amplify_project_creator.ts

    Line 21 in 7bf0c64

    'typescript@^5.0.0',

Copy link
Contributor Author

@josefaidt josefaidt Nov 5, 2024

Choose a reason for hiding this comment

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

for 1, bundling doesn't matter here aside from Functions. nodenext is the one that'll force you to specify .js file extensions (though I think there's a new compiler option coming that'll support .ts extensions and transform). preserve will not transform your module syntax, which should yield the same results when writing with ESM syntax using import/export instead of require/module.exports

for 2, bumped the minimum version

moduleDetection: 'force',
moduleResolution: 'bundler',
resolveJsonModule: true,
esModuleInterop: true,
Expand Down
2 changes: 1 addition & 1 deletion packages/create-amplify/src/amplify_project_creator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export class AmplifyProjectCreator {
'aws-cdk@^2',
'aws-cdk-lib@^2',
'constructs@^10.0.0',
'typescript@^5.0.0',
'typescript@^5.4.0',
'tsx',
'esbuild',
];
Expand Down
8 changes: 0 additions & 8 deletions packages/create-amplify/src/initial_project_file_generator.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,6 @@ void describe('InitialProjectFileGenerator', () => {
path.join(process.cwd(), 'testDir', 'amplify'),
{ recursive: true },
]);
assert.equal(
fsMock.writeFile.mock.calls[0].arguments[0],
path.join(process.cwd(), 'testDir', 'amplify', 'package.json')
);
assert.deepStrictEqual(
JSON.parse(fsMock.writeFile.mock.calls[0].arguments[1]),
{ type: 'module' }
);
});

void it('creates default tsconfig file', async () => {
Expand Down
6 changes: 0 additions & 6 deletions packages/create-amplify/src/initial_project_file_generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,6 @@ export class InitialProjectFileGenerator {
{ recursive: true }
);

const packageJsonContent = { type: 'module' };
await this.fsp.writeFile(
this.path.resolve(targetDir, 'package.json'),
JSON.stringify(packageJsonContent, null, 2)
);

await this.packageManagerController.initializeTsConfig(targetDir);
};
}
Loading