Skip to content
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

Jump to bottom

Add include/exclude documentation #353

Merged
merged 4 commits into from
Mar 11, 2024
Merged

Add include/exclude documentation #353

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
de7fe19
Add include/exclude documentation
dsherret Mar 7, 2024
66d610e
Update for latest changes
dsherret Mar 8, 2024
f942422
Fix code blocks to be jsonc
dsherret Mar 11, 2024
05ad354
Missed this jscon block
dsherret Mar 11, 2024
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
147 changes: 141 additions & 6 deletions runtime/manual/getting_started/configuration_file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Configuration for [`deno lint`](../tools/linter.md).
{
"lint": {
"include": ["src/"],
"exclude": ["src/testdata/", "data/fixtures/**/*.ts"],
"exclude": ["src/testdata/", "src/fixtures/**/*.ts"],
"rules": {
"tags": ["recommended"],
"include": ["ban-untagged-todo"],
Expand All @@ -96,7 +96,7 @@ Configuration for [`deno fmt`](../tools/formatter.md)
"singleQuote": true,
"proseWrap": "preserve",
"include": ["src/"],
"exclude": ["src/testdata/", "data/fixtures/**/*.ts"]
"exclude": ["src/testdata/", "src/fixtures/**/*.ts"]
}
}
```
Expand Down Expand Up @@ -131,6 +131,138 @@ The `unstable` property is an array of strings used to configure which unstable
feature flags should be enabled for your program.
[Learn more](../tools/unstable_flags.md).

## `include` and `exclude`

Many configurations (ex. `lint`, `fmt`) have an `include` and `exclude` property
for specifying the files to include.

### `include`

Only the paths or patterns specified here will be included.

```jsonc
{
"lint": {
// only format the src/ directory
"include": ["src/"]
}
}
```

### `exclude`

The paths or patterns specified here will be excluded.

```jsonc
{
"lint": {
// don't lint the dist/ folder
"exclude": ["dist/"]
}
}
```

This has HIGHER precedence than `include` and will win over `include` if a path
is matched in both `include` and `exclude`.

```jsonc
{
"lint": {
// only lint .js files in the src directory
"include": ["src/**/*.js"],
// js files in the src/fixtures folder will not be linted
"exclude": ["src/fixtures"]
}
}
```

You may wish to exclude a directory, but include a sub directory. In Deno
1.41.2+, you may un-exclude a more specific path by specifying a negated glob
below the more general exclude:

```jsonc
{
"fmt": {
// don't format the "fixtures" directory,
// but do format "fixtures/scripts"
"exclude": [
"fixtures",
"!fixtures/scripts"
]
}
}
```

### Top level `exclude`

If there's a directory you never want Deno to fmt, lint, type check, analyze in
the LSP, etc., then specify it in the top level exclude array:

```jsonc
{
"exclude": [
// exclude the dist folder from all sub-commands and the LSP
"dist/"
]
}
```

Sometimes you may find that you want to un-exclude a path or pattern that's
excluded in the top level-exclude. In Deno 1.41.2+, you may un-exclude a path by
specifying a negated glob in a more specific config:

```jsonc
{
"fmt": {
"exclude": [
// format the dist folder even though it's
// excluded at the top level
"!dist"
]
},
"exclude": [
"dist/"
]
}
```

### Publish - Override .gitignore

The _.gitignore_ is taken into account for the unstable `deno publish` command.
In Deno 1.41.2+, you can opt-out of excluded files ignored in the _.gitignore_
by using a negated exclude glob:

```title=".gitignore"
dist/
.env
```

```jsonc title="deno.json"
{
"publish": {
"exclude": [
// include the .gitignored dist folder
"!dist/"
]
}
}
```

Alternatively, explicitly specifying the gitignored paths in an `"include"`
works as well:

```json
{
"publish": {
"include": [
"dist/",
"README.md",
"deno.json"
]
}
}
```

## Full example

```json
Expand All @@ -142,7 +274,7 @@ feature flags should be enabled for your program.
},
"lint": {
"include": ["src/"],
"exclude": ["src/testdata/", "data/fixtures/**/*.ts"],
"exclude": ["src/testdata/", "src/fixtures/**/*.ts"],
"rules": {
"tags": ["recommended"],
"include": ["ban-untagged-todo"],
Expand All @@ -157,22 +289,25 @@ feature flags should be enabled for your program.
"singleQuote": true,
"proseWrap": "preserve",
"include": ["src/"],
"exclude": ["src/testdata/", "data/fixtures/**/*.ts"]
"exclude": ["src/testdata/", "src/fixtures/**/*.ts"]
},
"lock": false,
"nodeModulesDir": true,
"unstable": ["webgpu"],
"npmRegistry": "https://mycompany.net/artifactory/api/npm/virtual-npm",
"test": {
"include": ["src/"],
"exclude": ["src/testdata/", "data/fixtures/**/*.ts"]
"exclude": ["src/testdata/", "src/fixtures/**/*.ts"]
},
"tasks": {
"start": "deno run --allow-read main.ts"
},
"imports": {
"oak": "https://deno.land/x/[email protected]/mod.ts"
}
},
"exclude": [
"dist/"
]
}
```

Expand Down
Loading