Skip to content

update docs, add nodenext config #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rosskevin merged 1 commit into from
Jan 22, 2025
Merged

update docs, add nodenext config #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,26 @@ yarn install -D @alienfast/tsconfig

*This config requires TypeScript 5 or later.*

## Available configs

- `node`
- `nodenext` - extends `node` with changed `module` and `moduleResolution`
- `react` - for bundling
- `react-lib` - extends `react`, focused on library builds

## Usage

Example for a `node` package:

```json
{
"$schema": "https://json.schemastore.org/tsconfig",
"extends": "@alienfast/tsconfig/node.json",
"extends": "@alienfast/tsconfig/node.json",
"compilerOptions": {
"composite": true,
"outDir": "dist",
"rootDir": "src"
},
"include": ["src", "../../typings/**/*", "../../typings-local/**/*"],
"include": ["src", "typings"],
"exclude": ["node_modules", "dist"],
}
```
11 changes: 11 additions & 0 deletions nodenext.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"$schema": "https://json.schemastore.org/tsconfig",

"display": "NodeNext shared base.",

"extends": "./node.json",
"compilerOptions": {
"moduleResolution": "nodenext",
"module": "NodeNext"
}
}
Loading