Back to list
crmagz

import-conventions

by crmagz

A comprehensive AWS Cloud Development Kit (CDK) library providing infrastructure-as-code constructs and utilities for AWS applications

6🍴 0📅 Jan 20, 2026

SKILL.md


name: import-conventions description: Import conventions and ordering rules. Use when writing imports or organizing import statements. Enforces explicit named imports, never wildcards.

Import Conventions

Explicit Named Imports

ALWAYS use explicit named imports. NEVER use wildcard imports.

// CORRECT
import {Stack, Duration, RemovalPolicy} from 'aws-cdk-lib';
import {Bucket, BucketEncryption, BlockPublicAccess} from 'aws-cdk-lib/aws-s3';
import {Function, Runtime, Code} from 'aws-cdk-lib/aws-lambda';

// INCORRECT - Never do this
import * as cdk from 'aws-cdk-lib';
import * as s3 from 'aws-cdk-lib/aws-s3';

Import Order

Organize imports in this order:

  1. Node.js built-in modules
  2. External dependencies (@aws-sdk/*, third-party)
  3. AWS CDK (constructs, aws-cdk-lib)
  4. Internal monorepo packages (@cdk-constructs/*)
  5. Local imports (./, ../)
import {readFileSync} from 'fs';

import {SecretsManagerClient} from '@aws-sdk/client-secrets-manager';

import {Construct} from 'constructs';
import {Stack, Duration} from 'aws-cdk-lib';
import {Bucket} from 'aws-cdk-lib/aws-s3';

import {Account, Region, Environment} from '@cdk-constructs/aws';
import {CodeArtifactStackProps} from '@cdk-constructs/codeartifact';

import {MyLocalType} from './types/my-types';

Workspace Package Imports

When importing from workspace packages, use the package name:

// CORRECT
import {Account, Region} from '@cdk-constructs/aws';
import {createCodeArtifact} from '@cdk-constructs/codeartifact';

// INCORRECT - Don't use relative paths to packages
import {Account} from '../../packages/aws/src';

Score

Total Score

70/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

+10
説明文

100文字以上の説明がある

+10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

0/5

Reviews

💬

Reviews coming soon