Skip to content

Commit

Permalink
docs: Provide documentation for configuration files
Browse files Browse the repository at this point in the history
  • Loading branch information
d3xter666 committed Oct 7, 2024
1 parent 9c13e0c commit 1a9997e
Showing 1 changed file with 21 additions and 8 deletions.
29 changes: 21 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,15 +185,28 @@ module.exports = {

- **ignores**: This option allows you to define glob patterns to ignore specific files or directories during linting. Patterns are relative to the root of the project. You can also un-ignore specific files by using the `!` prefix. The order of the patterns matters; later patterns override earlier ones.

Example:
```js
ignores: [
"webapp/test/**", // Ignore all files in the test folder
"!webapp/test/integration/**", // Un-ignore files in a specific subdirectory
];
```
Example:
```js
ignores: [
"webapp/test/**", // Ignore all files in the test folder
"!webapp/test/integration/**", // Un-ignore files in a specific subdirectory
];
```

In this way, you can control which files the UI5 linter should process and which it should ignore.

- **files**: This option allows you to specify glob patterns to target particular files or directories for linting. However, it does not enable you to include files that are typically excluded from the process (e.g., files outside the `webapp` directory in application projects). Only POSIX path separators (`/`) are supported, irrespective of the platform you're using.
> **Note:** This option corresponds to the CLI command `ui5lint [files...]`. If CLI's `[files...]` are provided, the configuration gets ignored.

**Example:**

In this way, you can control which files the UI5 linter should process and which it should ignore.
```js
files: [
"webapp/index.html",
"webapp/**/*", // Lint all files and subdirectories within "webapp/"
];
```

## Support, Feedback, Contributing

Expand Down

0 comments on commit 1a9997e

Please sign in to comment.