amplify-backend force esm via tsconfig, remove package.json creation

force esm via tsconfig, remove package.json creation

Open josefaidt opened this issue 1 year ago • 1 comments

Problem

The purpose of the existing amplify/package.json file is to force the backend project to be an ESM project, and treat all backend project files as ES modules. The existence of this file and the one created at the project root (i.e. above amplify/) can be confusing as it is often used to define dependencies. There have been a few reports of the confusing experience as modules will resolve as they are installed during sandbox, but are not resolved during branch builds using the default configuration, and customer branch deployments fail.

This change is largely from the guidance from the official tsx docs's recommendation

{
	"compilerOptions": {

		// Treat files as modules even if it doesn't use import/export
		"moduleDetection": "force",

		// Ignore module structure
		"module": "Preserve",

		// Allow JSON modules to be imported
		"resolveJsonModule": true,

		// Allow JS files to be imported from TS and vice versa
		"allowJs": true,

		// Use correct ESM import behavior
		"esModuleInterop": true,

		// Disallow features that require cross-file awareness
		"isolatedModules": true,
	},
}

This change:

changes module from es2022 to preserve
removes moduleResolution
adds moduleDetection with force
removes package.json creation

Existing customers will not be impacted, and no changes are required on their part, however later it will be noticed that create-amplify no longer creates the same files or configuration.

Moving forward, would it benefit us from creating the tsconfig.json inside .amplify/ (creating this file preemptively), and extend-ing it from the customer's amplify/ directory? This would allow us to make further changes to this file and create on demand since it is gitignored.

Issue number, if available:

Changes

Corresponding docs PR, if applicable:

Validation

I created a sample project and modified it in place, https://github.com/josefaidt/repro-amplify-gen2-moduledetection/commit/076d870a59d3e52cd1605ce65b93b1265623ab31

Checklist

[ ] If this PR includes a functional change to the runtime behavior of the code, I have added or updated automated test coverage for this change.
[ ] If this PR requires a change to the Project Architecture README, I have included that update in this PR.
[ ] If this PR requires a docs update, I have linked to that docs PR above.
[ ] If this PR modifies E2E tests, makes changes to resource provisioning, or makes SDK calls, I have run the PR checks with the run-e2e label set.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.