refactor(cli,cli-lib-alpha): restrict relative package imports (#492)

Enabled the linter rule `import/no-relative-packages` to disallow
relative imports from other monorepo packages. While relative imports
are generally possible, they require special handling w.r.t. to bundling
of the JS code **and** type declarations. Hence we discourage them by
default.

There are currently two packages that require relative imports:
`aws-cdk` (the CLI) and `cli-lib-alpha`. Both depend on functionality
that is not publicly available in the respective monorepo packages, so
we need to import relatively. `cli-lib-alpha` is about to be deprecated,
and `aws-cdk` should eventually move to only use public features from
`toolkit-lib`. Both packages have their relative imports updated to
optimize for the number of files allowed to still import relatively.

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

Author: mrgrain

.eslintrc.json

@@ -1024,7 +1024,6 @@ const cli = configureProject(
       nodeBundle,
       yargsGen,
       cliPluginContract,
-      toolkitLib,
       '@octokit/rest',
       '@types/archiver',
       '@types/fs-extra@^9',
@@ -1051,6 +1050,7 @@ const cli = configureProject(
       cloudAssemblySchema.customizeReference({ versionType: 'minimal' }),
       cloudFormationDiff.customizeReference({ versionType: 'exact' }),
       cxApi,
+      toolkitLib,
       'archiver',
       `@aws-sdk/client-appsync@${CLI_SDK_V3_RANGE}`,
       `@aws-sdk/client-cloudformation@${CLI_SDK_V3_RANGE}`,

.projenrc.ts

@@ -0,0 +1,6 @@
+/* eslint-disable import/no-extraneous-dependencies */
+/* eslint-disable import/no-relative-packages */
+export { prepareContext, prepareDefaultEnvironment } from '../../../aws-cdk/lib/api/cloud-assembly';
+export { createAssembly } from '../../../aws-cdk/lib/cxapp/exec';
+export { exec } from '../../../aws-cdk';
+export { debug } from '../../../aws-cdk/lib/logging';

packages/@aws-cdk-testing/cli-integ/.eslintrc.json

@@ -1,9 +1,6 @@
+import { exec as runCli, debug, createAssembly, prepareContext, prepareDefaultEnvironment } from './aws-cdk';
 import type { SharedOptions, DeployOptions, DestroyOptions, BootstrapOptions, SynthOptions, ListOptions } from './commands';
 import { StackActivityProgress, HotswapMode } from './commands';
-import { exec as runCli } from '../../../aws-cdk/lib';
-import { prepareContext, prepareDefaultEnvironment } from '../../../aws-cdk/lib/api/cloud-assembly';
-import { createAssembly } from '../../../aws-cdk/lib/cxapp';
-import { debug } from '../../../aws-cdk/lib/legacy-exports';
 
 const debugFn = async (msg: string) => void debug(msg);
 

packages/@aws-cdk/cdk-cli-wrapper/.eslintrc.json

@@ -1,13 +1,13 @@
 import { join } from 'path';
 import * as core from 'aws-cdk-lib/core';
-import * as cli from '../../../aws-cdk/lib';
 import { AwsCdkCli } from '../lib';
+import * as cli from '../lib/aws-cdk';
 
 // These tests synthesize an actual CDK app and take a bit longer
 jest.setTimeout(60_000);
 
-jest.mock('../../../aws-cdk/lib', () => {
-  const original = jest.requireActual('../../../aws-cdk/lib');
+jest.mock('../lib/aws-cdk', () => {
+  const original = jest.requireActual('../lib/aws-cdk');
   return {
     ...original,
     exec: jest.fn(original.exec),

packages/@aws-cdk/cli-lib-alpha/.eslintrc.json

@@ -1,5 +1,5 @@
+import * as cli from 'aws-cdk';
 import * as core from 'aws-cdk-lib/core';
-import * as cli from '../../../aws-cdk/lib';
 import { AwsCdkCli } from '../lib';
 import { HotswapMode, RequireApproval, StackActivityProgress } from '../lib/commands';