Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 31 additions & 2 deletions typescript/.gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,34 @@
.LAST_BUILD
*.snk
# TypeScript compiled files
*.js
!jest.config.js
*.d.ts

# TypeScript incremental build states
*.tsbuildinfo

# Node.js dependency directory
node_modules/

# NPM debug logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# CDK asset staging directory
.cdk.staging
cdk.out

# Legacy build artifacts
.LAST_BUILD
*.snk

# Editor and IDE files
.idea/
.vscode/
*.swp
*.swo
*~

# OS specific files
.DS_Store
Thumbs.db
31 changes: 30 additions & 1 deletion typescript/.npmignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,32 @@
# TypeScript source files
*.ts
!*.d.ts

# Test files
test/
__tests__/

# CDK asset staging directory
.cdk.staging
cdk.out

# Legacy build artifacts
.LAST_BUILD
*.snk
*.snk

# Source control files
.git/
.github/
.gitignore

# Configuration files
tsconfig.json
cdk.json
jest.config.js
.eslintrc.js
.prettierrc
.npmignore

# Editor and IDE files
.idea/
.vscode/
19 changes: 19 additions & 0 deletions typescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,25 @@

This section contains all the CDK code examples written in Typescript. For more information on using the CDK in Typescript, please see the [Developer Guide](https://docs.aws.amazon.com/cdk/latest/guide/work-with-cdk-typescript.html).

## Repository Configuration Files

This directory contains the following configuration files:

- `.gitignore`: Specifies which files and directories should be excluded from Git version control
- Excludes compiled JavaScript files (except jest.config.js)
- Excludes TypeScript declaration files (*.d.ts)
- Excludes node_modules and other build artifacts
- Excludes CDK staging and output directories
- Excludes editor/IDE specific files and OS-specific files

- `.npmignore`: Specifies which files and directories should be excluded when publishing to npm
- Excludes TypeScript source files (but includes declaration files)
- Excludes test files and directories
- Excludes configuration files and build artifacts
- Excludes source control files

These files are used as a reference for the individual example projects. Each example may have its own specific configuration files tailored to its needs.

## Running Examples

To run a Typescript example, execute the following:
Expand Down
Loading