mirror of
https://github.com/super-linter/super-linter.git
synced 2024-11-22 08:41:02 -05:00
6f70adee89
textlint was expensive to run because we added every file in the list of files to lint to FILE_ARRAY_NATURAL_LANGUAGE. In #5041, we mitigated this issue but lost the ability to run textlint on changed files only. Given that textlint ignore files for which it doesn't have a plugin installed, and that we don't currently install additional plugins besides the default ones to lint markdown files and text files, we let textlint run on these files only, so we can have the feature to lint only changed files with this linter as well, back.
77 lines
3.5 KiB
Markdown
77 lines
3.5 KiB
Markdown
# Super-linter upgrade guide
|
|
|
|
This document helps you upgrade from a super-linter version to newer ones:
|
|
|
|
- [Upgrade from v5 to v6](#upgrade-from-v5-to-v6)
|
|
|
|
## Upgrade from v5 to v6
|
|
|
|
This section helps you migrate from super-linter `v5` to `v6`.
|
|
|
|
### eslint-config-airbnb-typescript
|
|
|
|
- eslint-config-airbnb-typescript (a library to add TypeScript support to
|
|
Airbnb's ESLint config)
|
|
[appears to be unmaintained](https://github.com/iamturns/eslint-config-airbnb-typescript/issues/314).
|
|
We had to remove it from super-linter because it was blocking updates to other
|
|
dependencies, such as ESLint.
|
|
|
|
### Checkstyle
|
|
|
|
- Checkstyle
|
|
[embeds some configuration files](https://checkstyle.sourceforge.io/cmdline.html#Command_line_usage),
|
|
such as `sun_checks.xml` and `google_checks.xml`. There is no need to provide
|
|
your own checkstyle configuration files if it matches one of the embedded
|
|
ones. You can safely remove your Checkstyle configuration file if it matches
|
|
one of the embedded ones.
|
|
|
|
### Dart
|
|
|
|
- super-linter doesn't include a default configuration file for `dart analyzer`
|
|
because the Dart SDK doesn't support running `dart analyzer` against an
|
|
arbitrary configuration file anymore. For more information about how to
|
|
customize static analysis of Dart files, see
|
|
[Customizing static analysis](https://dart.dev/tools/analysis) in the Dart SDK
|
|
documentation.
|
|
|
|
### Experimental batch workers
|
|
|
|
- Experimental batch support is deprecated. You can safely remove the
|
|
`EXPERIMENTAL_BATCH_WORKER` variable from your configuration.
|
|
|
|
### Gitleaks
|
|
|
|
- If you defined secret patterns in `.gitleaks.toml`, Gitleaks may report errors
|
|
about that file. If this happens, you can
|
|
[configure Gitleaks to ignore that file](https://github.com/gitleaks/gitleaks/tree/master?tab=readme-ov-file#gitleaksignore).
|
|
- Gitleaks doesn't consider the `FILTER_REGEX_EXCLUDE`, `FILTER_REGEX_INCLUDE`,
|
|
`IGNORE_GENERATED_FILES`, `IGNORE_GITIGNORED_FILES` variables. For more
|
|
information about how to ignore files with Gitleaks, see
|
|
[the Gitleaks documentation](https://github.com/gitleaks/gitleaks/tree/master?tab=readme-ov-file#gitleaksignore).
|
|
|
|
### Jscpd
|
|
|
|
- The `VALIDATE_JSCPD_ALL_CODEBASE` variable is deprecated. Jscpd now lints the
|
|
entire workspace instead of linting files one by one. You can safely remove
|
|
the `VALIDATE_JSCPD_ALL_CODEBASE` variable from your configuration.
|
|
- Jscpd doesn't consider the `FILTER_REGEX_EXCLUDE`, `FILTER_REGEX_INCLUDE`,
|
|
`IGNORE_GENERATED_FILES`, `IGNORE_GITIGNORED_FILES` variables. For more
|
|
information about how to ignore files with Jscpd, see
|
|
[the Jscpd documentation](https://github.com/kucherenko/jscpd/tree/master/packages/jscpd).
|
|
|
|
### USE_FIND_ALGORITHM and VALIDATE_ALL_CODEBASE used together
|
|
|
|
- Setting `USE_FIND_ALGORITHM` to `true` and `VALIDATE_ALL_CODEBASE` to `false`
|
|
is an unsupported configuration. super-linter `v5` and earlier silently
|
|
ignored `VALIDATE_ALL_CODEBASE` when `USE_FIND_ALGORITHM` is set to `true`,
|
|
leading to potentially confusing behavior for users. super-linter `v6`
|
|
explicitly fail in this case. Remove one of the two from your configuration,
|
|
depending on the desired behavior.
|
|
|
|
### VALIDATE_KOTLIN_ANDROID
|
|
|
|
- The `VALIDATE_KOTLIN_ANDROID` variable has been deprecated because ktlint
|
|
handles linting Kotlin files for Android using a configuration option, so
|
|
super-linter doesn't need to account for this special case anymore. If you
|
|
set `VALIDATE_KOTLIN_ANDROID` in your configuration, change it to
|
|
`VALIDATE_KOTLIN` and configure ktlint to lint Android files.
|