Skip to content

Commit 558dd50

Browse files
kaiz-ioMichael Kaiser
andauthored
chore(typescript): update .gitignore and .npmignore with comprehensive patterns
Co-authored-by: Michael Kaiser <kaiser@kaiz.io>
1 parent 3f688bc commit 558dd50

File tree

3 files changed

+80
-3
lines changed

3 files changed

+80
-3
lines changed

typescript/.gitignore

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,34 @@
1-
.LAST_BUILD
2-
*.snk
1+
# TypeScript compiled files
32
*.js
3+
!jest.config.js
44
*.d.ts
5+
6+
# TypeScript incremental build states
7+
*.tsbuildinfo
8+
9+
# Node.js dependency directory
10+
node_modules/
11+
12+
# NPM debug logs
13+
npm-debug.log*
14+
yarn-debug.log*
15+
yarn-error.log*
16+
17+
# CDK asset staging directory
18+
.cdk.staging
19+
cdk.out
20+
21+
# Legacy build artifacts
22+
.LAST_BUILD
23+
*.snk
24+
25+
# Editor and IDE files
26+
.idea/
27+
.vscode/
528
*.swp
29+
*.swo
30+
*~
31+
32+
# OS specific files
33+
.DS_Store
34+
Thumbs.db

typescript/.npmignore

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,32 @@
1+
# TypeScript source files
2+
*.ts
3+
!*.d.ts
14

5+
# Test files
6+
test/
7+
__tests__/
8+
9+
# CDK asset staging directory
10+
.cdk.staging
11+
cdk.out
12+
13+
# Legacy build artifacts
214
.LAST_BUILD
3-
*.snk
15+
*.snk
16+
17+
# Source control files
18+
.git/
19+
.github/
20+
.gitignore
21+
22+
# Configuration files
23+
tsconfig.json
24+
cdk.json
25+
jest.config.js
26+
.eslintrc.js
27+
.prettierrc
28+
.npmignore
29+
30+
# Editor and IDE files
31+
.idea/
32+
.vscode/

typescript/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,25 @@
44

55
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).
66

7+
## Repository Configuration Files
8+
9+
This directory contains the following configuration files:
10+
11+
- `.gitignore`: Specifies which files and directories should be excluded from Git version control
12+
- Excludes compiled JavaScript files (except jest.config.js)
13+
- Excludes TypeScript declaration files (*.d.ts)
14+
- Excludes node_modules and other build artifacts
15+
- Excludes CDK staging and output directories
16+
- Excludes editor/IDE specific files and OS-specific files
17+
18+
- `.npmignore`: Specifies which files and directories should be excluded when publishing to npm
19+
- Excludes TypeScript source files (but includes declaration files)
20+
- Excludes test files and directories
21+
- Excludes configuration files and build artifacts
22+
- Excludes source control files
23+
24+
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.
25+
726
## Running Examples
827

928
To run a Typescript example, execute the following:

0 commit comments

Comments
 (0)