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';
 

packages/@aws-cdk/cli-lib-alpha/lib/aws-cdk.ts

@@ -1,3 +1,7 @@
-export * from '../../@aws-cdk/toolkit-lib/lib/api/private';
+/* eslint-disable import/no-relative-packages */
 export { deployStack, DeployStackOptions as DeployStackApiOptions } from '../../@aws-cdk/toolkit-lib/lib/api/deployments/deploy-stack';
 export * as cfnApi from '../../@aws-cdk/toolkit-lib/lib/api/deployments/cfn-api';
+export * from '../../@aws-cdk/toolkit-lib/lib/api/io/private';
+export * from '../../@aws-cdk/toolkit-lib/lib/private/activity-printer';
+export * from '../../@aws-cdk/toolkit-lib/lib/api/cloud-assembly/private/borrowed-assembly';
+

packages/@aws-cdk/cli-lib-alpha/lib/cli.ts

@@ -1,2 +1,5 @@
+/* eslint-disable import/no-relative-packages */
 export * from '../../../@aws-cdk/toolkit-lib/lib/api/aws-auth';
 export * from '../../../@aws-cdk/toolkit-lib/lib/api/aws-auth/private';
+export * from '../../../@aws-cdk/toolkit-lib/lib/api/aws-auth/awscli-compatible';
+

packages/@aws-cdk/cli-lib-alpha/test/cli.test.ts

@@ -1 +1,2 @@
+/* eslint-disable import/no-relative-packages */
 export * from '../../../@aws-cdk/toolkit-lib/lib/api/bootstrap';

packages/@aws-cdk/cli-lib-alpha/test/commands.test.ts

@@ -1,3 +1,4 @@
+/* eslint-disable import/no-relative-packages */
 export * from '../../../@aws-cdk/toolkit-lib/lib/api/cloud-assembly';
 export * from '../../../@aws-cdk/toolkit-lib/lib/api/cloud-assembly/private';
 export * from '../../../@aws-cdk/toolkit-lib/lib/api/cloud-assembly/environment';

packages/@aws-cdk/cli-plugin-contract/.eslintrc.json

@@ -1 +1,2 @@
+/* eslint-disable import/no-relative-packages */
 export * from '../../../@aws-cdk/toolkit-lib/lib/api/cloudformation';

packages/@aws-cdk/cloud-assembly-schema/.eslintrc.json

@@ -1 +1,2 @@
+/* eslint-disable import/no-relative-packages */
 export * from '../../../@aws-cdk/toolkit-lib/lib/api/context';

packages/@aws-cdk/cloudformation-diff/.eslintrc.json

@@ -1 +1,2 @@
+/* eslint-disable import/no-relative-packages */
 export * from '../../../@aws-cdk/toolkit-lib/lib/api/deployments';

packages/@aws-cdk/integ-runner/.eslintrc.json

@@ -1 +1,2 @@
+/* eslint-disable import/no-relative-packages */
 export * from '../../../@aws-cdk/toolkit-lib/lib/api/hotswap';

packages/@aws-cdk/node-bundle/.eslintrc.json

@@ -1,11 +1,18 @@
+/* eslint-disable import/no-relative-packages */
 export * from './bootstrap';
-export * from './garbage-collection';
+export * from './cloudformation';
+export * from './cloud-assembly';
 export * from './deployments';
-export * from './toolkit-info';
 export * from './aws-auth';
-export * from './rwlock';
-export * from './tree';
-
-export * from '../../../@aws-cdk/toolkit-lib/lib/toolkit/toolkit-error';
 export * from './cloud-assembly';
-export * from './plugin';
+export * from './notices';
+
+export * from '../../../@aws-cdk/toolkit-lib/lib/api/diff';
+export * from '../../../@aws-cdk/toolkit-lib/lib/api/io';
+export * from '../../../@aws-cdk/toolkit-lib/lib/api/logs-monitor';
+export * from '../../../@aws-cdk/toolkit-lib/lib/api/resource-import';
+export { RWLock, IReadLock } from '../../../@aws-cdk/toolkit-lib/lib/api/rwlock';
+export * from '../../../@aws-cdk/toolkit-lib/lib/api/toolkit-info';
+export { loadTree, some } from '../../../@aws-cdk/toolkit-lib/lib/api/tree';
+export * from '../../../@aws-cdk/toolkit-lib/lib/api/work-graph';
+export * from '../../../@aws-cdk/toolkit-lib/lib/api/garbage-collection';

packages/@aws-cdk/toolkit-lib/.eslintrc.json

@@ -1 +1,2 @@
+/* eslint-disable import/no-relative-packages */
 export * from '../../../@aws-cdk/toolkit-lib/lib/api/notices';

packages/@aws-cdk/toolkit-lib/lib/api/private.ts

@@ -1 +1,2 @@
+/* eslint-disable import/no-relative-packages */
 export * from '../../../@aws-cdk/toolkit-lib/lib/api/plugin';

packages/@aws-cdk/user-input-gen/.eslintrc.json

@@ -1 +1,2 @@
+/* eslint-disable import/no-relative-packages */
 export * from '../../../@aws-cdk/toolkit-lib/lib/api/settings';

packages/@aws-cdk/yarn-cling/.eslintrc.json

@@ -1 +1,2 @@
+/* eslint-disable import/no-relative-packages */
 export * from '../../../@aws-cdk/toolkit-lib/lib/api/tags';

packages/aws-cdk/.eslintrc.json

@@ -1,6 +1,9 @@
 import * as path from 'path';
 import { format } from 'util';
+import { RequireApproval } from '@aws-cdk/cloud-assembly-schema';
 import * as cxapi from '@aws-cdk/cx-api';
+import { StackSelectionStrategy, ToolkitError, PermissionChangeType, Toolkit } from '@aws-cdk/toolkit-lib';
+import type { ToolkitAction, ToolkitOptions } from '@aws-cdk/toolkit-lib';
 import * as chalk from 'chalk';
 import * as chokidar from 'chokidar';
 import * as fs from 'fs-extra';
@@ -9,28 +12,17 @@ import * as uuid from 'uuid';
 import { CliIoHost } from './io-host';
 import type { Configuration } from './user-configuration';
 import { PROJECT_CONFIG } from './user-configuration';
-import type { ToolkitAction } from '../../../@aws-cdk/toolkit-lib';
-import { StackSelectionStrategy, ToolkitError } from '../../../@aws-cdk/toolkit-lib';
-import { asIoHelper } from '../../../@aws-cdk/toolkit-lib/lib/api/io/private';
-import { PermissionChangeType } from '../../../@aws-cdk/toolkit-lib/lib/payloads';
-import type { ToolkitOptions } from '../../../@aws-cdk/toolkit-lib/lib/toolkit';
-import { Toolkit } from '../../../@aws-cdk/toolkit-lib/lib/toolkit';
-import { DEFAULT_TOOLKIT_STACK_NAME } from '../api';
+import { asIoHelper, cfnApi } from '../../lib/api-private';
+import type { AssetBuildNode, AssetPublishNode, Concurrency, StackNode, WorkGraph } from '../api';
+import { DEFAULT_TOOLKIT_STACK_NAME, DiffFormatter, WorkGraphBuilder, removeNonImportResources, ResourceImporter, ResourceMigrator, GarbageCollector, CloudWatchLogEventMonitor, findCloudWatchLogGroups } from '../api';
 import type { SdkProvider } from '../api/aws-auth';
 import type { BootstrapEnvironmentOptions } from '../api/bootstrap';
 import { Bootstrapper } from '../api/bootstrap';
 import { ExtendedStackSelection, StackCollection } from '../api/cloud-assembly';
 import type { DeploymentMethod, Deployments, SuccessfulDeployStackResult } from '../api/deployments';
-import { GarbageCollector } from '../api/garbage-collection';
 import { EcsHotswapProperties, HotswapMode, HotswapPropertyOverrides } from '../api/hotswap';
-import { CloudWatchLogEventMonitor, findCloudWatchLogGroups } from '../api/logs-monitor';
-import { removeNonImportResources, ResourceImporter, ResourceMigrator } from '../api/resource-import';
 import { type Tag, tagsForStack } from '../api/tags';
-import type { AssetBuildNode, AssetPublishNode, Concurrency, StackNode, WorkGraph } from '../api/work-graph';
-import { WorkGraphBuilder } from '../api/work-graph';
-import { cfnApi } from '../api-private';
 import { StackActivityProgress } from '../commands/deploy';
-import { DiffFormatter, RequireApproval } from '../commands/diff';
 import { listStacks } from '../commands/list-stacks';
 import type { FromScan, GenerateTemplateOutput } from '../commands/migrate';
 import {
@@ -2032,6 +2024,6 @@ function stackMetadataLogger(verbose?: boolean): (level: 'info' | 'error' | 'war
  * - RequireApproval.BROADENING and the changes are indeed broadening permissions
  */
 function requiresApproval(requireApproval: RequireApproval, permissionChangeType: PermissionChangeType) {
-  return requireApproval === RequireApproval.ANY_CHANGE ||
+  return requireApproval === RequireApproval.ANYCHANGE ||
   requireApproval === RequireApproval.BROADENING && permissionChangeType === PermissionChangeType.BROADENING;
 }

packages/aws-cdk/.projen/deps.json

@@ -1,8 +1,8 @@
+import { RequireApproval } from '@aws-cdk/cloud-assembly-schema';
 // eslint-disable-next-line import/no-extraneous-dependencies
 import { CliHelpers, type CliConfig } from '@aws-cdk/user-input-gen';
 import * as cdk_from_cfn from 'cdk-from-cfn';
 import { StackActivityProgress } from '../commands/deploy';
-import { RequireApproval } from '../commands/diff';
 import { availableInitLanguages } from '../commands/init';
 
 export const YARGS_HELPERS = new CliHelpers('./util/yargs-helpers');
@@ -118,7 +118,7 @@ export async function makeConfig(): Promise<CliConfig> {
           'all': { type: 'boolean', desc: 'Deploy all available stacks', default: false },
           'build-exclude': { type: 'array', alias: 'E', desc: 'Do not rebuild asset with the given ID. Can be specified multiple times', default: [] },
           'exclusively': { type: 'boolean', alias: 'e', desc: 'Only deploy requested stacks, don\'t include dependencies' },
-          'require-approval': { type: 'string', choices: [RequireApproval.NEVER, RequireApproval.ANY_CHANGE, RequireApproval.BROADENING], desc: 'What security-sensitive changes need manual approval' },
+          'require-approval': { type: 'string', choices: [RequireApproval.NEVER, RequireApproval.ANYCHANGE, RequireApproval.BROADENING], desc: 'What security-sensitive changes need manual approval' },
           'notification-arns': { type: 'array', desc: 'ARNs of SNS topics that CloudFormation will notify with stack related events. These will be added to ARNs specified with the \'notificationArns\' stack property.' },
           // @deprecated(v2) -- tags are part of the Cloud Assembly and tags specified here will be overwritten on the next deployment
           'tags': { type: 'array', alias: 't', desc: 'Tags to add to the stack (KEY=VALUE), overrides tags from Cloud Assembly (deprecated)' },

packages/aws-cdk/.projen/tasks.json

@@ -1,37 +1,34 @@
+/* eslint-disable @typescript-eslint/no-shadow */ // yargs
 import * as cxapi from '@aws-cdk/cx-api';
+import { ToolkitError } from '@aws-cdk/toolkit-lib';
 import * as chalk from 'chalk';
 import { CdkToolkit, AssetBuildTime } from './cdk-toolkit';
 import type { IoMessageLevel } from './io-host';
 import { CliIoHost } from './io-host';
 import { parseCommandLineArguments } from './parse-command-line-arguments';
 import { checkForPlatformWarnings } from './platform-warnings';
 import { prettyPrintError } from './pretty-print-error';
+import { GLOBAL_PLUGIN_HOST } from './singleton-plugin-host';
 import type { Command } from './user-configuration';
 import { Configuration } from './user-configuration';
 import * as version from './version';
-import { ToolkitError } from '../../../@aws-cdk/toolkit-lib';
-import { asIoHelper, IO } from '../../../@aws-cdk/toolkit-lib/lib/api/io/private';
-import { SdkProvider, IoHostSdkLogger, setSdkTracing } from '../api/aws-auth';
+import { asIoHelper, IO } from '../../lib/api-private';
+import type { IReadLock } from '../api';
+import { ToolkitInfo, Notices } from '../api';
+import { SdkProvider, IoHostSdkLogger, setSdkTracing, makeRequestHandler } from '../api/aws-auth';
 import type { BootstrapSource } from '../api/bootstrap';
 import { Bootstrapper } from '../api/bootstrap';
 import type { DeploymentMethod } from '../api/deployments';
 import { Deployments } from '../api/deployments';
 import { HotswapMode } from '../api/hotswap';
-import { Notices } from '../api/notices';
-import type { IReadLock } from '../api/rwlock';
 import type { Settings } from '../api/settings';
-import { ToolkitInfo } from '../api/toolkit-info';
 import { contextHandler as context } from '../commands/context';
 import { docs } from '../commands/docs';
 import { doctor } from '../commands/doctor';
 import { cliInit, printAvailableTemplates } from '../commands/init';
 import { getMigrateScanType } from '../commands/migrate';
 import { execProgram, CloudExecutable } from '../cxapp';
 import type { StackSelector, Synthesizer } from '../cxapp';
-import { GLOBAL_PLUGIN_HOST } from './singleton-plugin-host';
-import { makeRequestHandler } from '../../../@aws-cdk/toolkit-lib/lib/api/shared-private';
-/* eslint-disable max-len */
-/* eslint-disable @typescript-eslint/no-shadow */ // yargs
 
 if (!process.stdout.isTTY) {
   // Disable chalk color highlighting