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.

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

feat: Deprecate tools DOCS-609 #1907

Merged
merged 11 commits into from
Oct 25, 2023
32 changes: 4 additions & 28 deletions docs/getting-started/supported-languages-and-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,7 @@ The table below lists all languages and frameworks that Codacy supports and the
</tr>
<tr>
<td>CSS</td>
<td><a href="http://csslint.net/">CSSLint</a>,
<a href="https://stylelint.io/">Stylelint</a></td>
<td><a href="https://stylelint.io/">Stylelint</a></td>
<td>-</td>
<td>-</td>
<td>-</td>
Expand Down Expand Up @@ -214,7 +213,6 @@ The table below lists all languages and frameworks that Codacy supports and the
<tr>
<td>JavaScript</td>
<td><a href="https://eslint.org/">ESLint</a>,
<a href="https://jshint.com/">JSHint</a>,
<a href="https://pmd.github.io/">PMD</a></td>
<td><a href="https://eslint.org/docs/rules/">ESLint</a> <a href="#suggest-fixes">🔧</a></td>
<td><a href="https://trivy.dev">Trivy</a></td>
Expand Down Expand Up @@ -280,7 +278,7 @@ The table below lists all languages and frameworks that Codacy supports and the
</tr>
<tr>
<td>Objective-C</td>
<td><a href="https://clang.llvm.org/extra/clang-tidy/">Clang-Tidy</a><a href="#client-side"><sup>2</sup></a>, <a href="http://fauxpasapp.com/">Faux Pas</a><a href="#client-side"><sup>2</sup></a></td>
<td><a href="https://clang.llvm.org/extra/clang-tidy/">Clang-Tidy</a><a href="#client-side"><sup>2</sup></a></td>
<td>-</td>
<td>-</td>
<td>-</td>
Expand Down Expand Up @@ -406,8 +404,7 @@ The table below lists all languages and frameworks that Codacy supports and the
</tr>
<tr>
<td>Swift </td>
<td><a href="https://github.com/realm/SwiftLint">SwiftLint</a>,
<a href="https://github.com/sleekbyte/tailor">Tailor</a></td>
<td><a href="https://github.com/realm/SwiftLint">SwiftLint</a></td>
<td>-</td>
<td>-</td>
<td><a href="https://trivy.dev">Trivy</a>, scans <br><code>Package.resolved</code> (SwiftPM) </td>
Expand Down Expand Up @@ -435,8 +432,7 @@ The table below lists all languages and frameworks that Codacy supports and the
</tr>
<tr>
<td>TypeScript</td>
<td><a href="https://eslint.org/">ESLint</a>,
<a href="https://palantir.github.io/tslint/">TSLint</a></td>
<td><a href="https://eslint.org/">ESLint</a></td>
<td><a href="https://eslint.org/docs/rules/">ESLint</a> <a href="#suggest-fixes">🔧</a></td>
<td><a href="https://trivy.dev">Trivy</a></td>
<td><a href="https://trivy.dev">Trivy</a>, scans <br><code>package.json</code> and <code>package-lock.json</code> (npm), <br><code>yarn.lock</code> (Yarn) </td>
Expand Down Expand Up @@ -564,10 +560,6 @@ The following table lists the Codacy GitHub repositories corresponding to each s
<td><a href="https://github.com/codacy/codacy-scalameta" class="skip-vale">codacy/codacy-scalameta</a></td>
</tr>
<tr>
<td><a href="http://fauxpasapp.com/">Faux Pas</a></td>
<td><a href="https://github.com/codacy/codacy-faux-pas" class="skip-vale">codacy/codacy-faux-pas</a></td>
</tr>
<tr>
<td><a href="https://github.com/securego/gosec">Gosec</a></td>
<td><a href="https://github.com/codacy/codacy-gosec" class="skip-vale">codacy/codacy-gosec</a></td>
</tr>
Expand Down Expand Up @@ -596,10 +588,6 @@ The following table lists the Codacy GitHub repositories corresponding to each s
<td><a href="https://github.com/codacy/codacy-credo" class="skip-vale">codacy/codacy-credo</a></td>
</tr>
<tr>
<td><a href="http://csslint.net/">CSSLint</a></td>
<td><a href="https://github.com/codacy/codacy-csslint" class="skip-vale">codacy/codacy-csslint</a></td>
</tr>
<tr>
<td><a href="https://github.com/arturbosch/detekt">detekt</a></td>
<td><a href="https://github.com/codacy/codacy-detekt" class="skip-vale">codacy/codacy-detekt</a></td>
</tr>
Expand All @@ -624,10 +612,6 @@ The following table lists the Codacy GitHub repositories corresponding to each s
<td><a href="https://github.com/codacy/codacy-jackson-linter" class="skip-vale">codacy/codacy-jackson-linter</a></td>
</tr>
<tr>
<td><a href="https://jshint.com/">JSHint</a></td>
<td><a href="https://github.com/codacy/codacy-jshint" class="skip-vale">codacy/codacy-jshint</a></td>
</tr>
<tr>
<td><a href="https://github.com/squizlabs/PHP_CodeSniffer">PHP_CodeSniffer</a></td>
<td><a href="https://github.com/codacy/codacy-codesniffer" class="skip-vale">codacy/codacy-codesniffer</a></td>
</tr>
Expand Down Expand Up @@ -708,18 +692,10 @@ The following table lists the Codacy GitHub repositories corresponding to each s
<td><a href="https://github.com/codacy/codacy-swiftlint" class="skip-vale">codacy/codacy-swiftlint</a></td>
</tr>
<tr>
<td><a href="https://github.com/sleekbyte/tailor">Tailor</a></td>
<td><a href="https://github.com/codacy/codacy-tailor" class="skip-vale">codacy/codacy-tailor</a></td>
</tr>
<tr>
<td><a href="https://trivy.dev">Trivy</a></td>
<td><a href="https://github.com/codacy/codacy-trivy/" class="skip-vale">codacy/codacy-trivy</a></td>
</tr>
<tr>
<td><a href="https://palantir.github.io/tslint/">TSLint</a></td>
<td><a href="https://github.com/codacy/codacy-tslint" class="skip-vale">codacy/codacy-tslint</a></td>
</tr>
<tr>
<td><a href="https://github.com/tsqllint/tsqllint/">TSQLLint</a></td>
<td><a href="https://github.com/codacy/codacy-tsqllint" class="skip-vale">codacy/codacy-tsqllint</a></td>
</tr>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
rss_title: Codacy release notes RSS feed
rss_href: /feed_rss_created.xml
---

# Deprecation of CSSLint, JSHint, Faux Pas, Tailor, TSLint October 25, 2023

On October 25th 2023 we deprecated the following tools: **CSSLint**, **Faux Pas**, **JSHint**, **Tailor**, and **TSLint**.

These tools have become deprecated or stopped being updated by their maintainers and started providing a bad experience to Codacy users either by reporting false positives or causing other unexpected issues.

We've been working on alternatives for each deprecated tool. See [what to do if you are using one of the deprecated tools](#if-you-are-using-one-of-these-tools).

## Removal of CSSLint and TSLint January 1, 2024

On January 1st, 2024 we'll be removing the following tools from Codacy: **CSSLint** and **TSLint**.

The remaining deprecated tools (Faux Pas, JSHint, and Tailor) will be removed later. You can follow the [Codacy release notes](https://docs.codacy.com/release-notes/) for further updates.

## If you are using one of these tools

To continue analyzing your repositories, enable the replacement tool for the corresponding deprecated tool listed below in your [organization coding standards](../../organizations/using-coding-standards.md) (recommended) or on the [code patterns page](../../repositories-configure/configuring-code-patterns.md) of each affected repository:

| Deprecated tool | Replacement tool |
|-----------------|------------------|
| CSSLint | Stylelint |
| Faux Pas | Clang-Tidy |
| JSHint | ESLint |
| Tailor | SwiftLint |
| TSLint | ESLint |

The suggested replacement tools are enabled by default for new repositories, except for Clang Tidy, which is a [client-side tool](../../repositories-configure/local-analysis/client-side-tools.md).

If you have any questions or need help, please contact <mailto:support@codacy.com>.
1 change: 1 addition & 0 deletions docs/release-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ For product updates that are in progress or planned [visit the Codacy public roa

2023

- [Deprecation of CSSLint, JSHint, Faux Pas, Tailor, TSLint October 25, 2023](cloud/cloud-2023-10-25-csslint-jshint-fauxpas-tailor-tslint-deprecation.md)
- [Deprecation of bundler-audit October 13, 2023](cloud/cloud-2023-10-13-bundler-audit-deprecation.md)
- [Cloud September 2023](cloud/cloud-2023-09.md)
- [Cloud August 2023](cloud/cloud-2023-08.md)
Expand Down
3 changes: 0 additions & 3 deletions docs/repositories-configure/codacy-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,6 @@ eslint
flawfinder
hadolint
jacksonlinter
jshint
markdownlint
phpcs
phpmd
Expand All @@ -137,9 +136,7 @@ SQLint
spectral
stylelint
swiftlint
tailor
trivy
tslint
tsqllint
```

Expand Down
19 changes: 0 additions & 19 deletions docs/repositories-configure/configuring-code-patterns.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,12 +202,6 @@ The table below lists the configuration file names that Codacy detects and suppo
<td><code>.hadolint.yaml</code></td>
<td></td>
</tr>
<tr>
<td>JSHint</td>
<td>JavaScript</td>
<td><code>.jshintrc</code></td>
<td></td>
</tr>
<tr>
<td>markdownlint</td>
<td>Markdown</td>
Expand Down Expand Up @@ -304,18 +298,6 @@ The table below lists the configuration file names that Codacy detects and suppo
<td><code>.swiftlint.yml</code></td>
<td></td>
</tr>
<tr>
<td>Tailor</td>
<td>Swift</td>
<td><code>.tailor.yml</code></td>
<td></td>
</tr>
<tr>
<td>TSLint</td>
<td>TypeScript</td>
<td><code>tslint.json</code></td>
<td></td>
</tr>
<tr>
<td>TSQLLint</td>
<td>Transact-SQL</td>
Expand All @@ -335,7 +317,6 @@ The table below lists the configuration file names that Codacy detects and suppo
- CoffeeLint
- Cppcheck
- deadcode
- Faux Pas
- Flawfinder
- Gosec
- Jackson Linter
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,11 +86,6 @@ The table below describes the supported client-side tools and includes links to
<td>Clang-tidy is a clang-based C++ "linter" tool. Its purpose is to provide an extensible framework for diagnosing and fixing typical programming errors, like style violations, interface misuse, or bugs that can be deduced via static analysis. Clang-tidy is modular and provides a convenient interface for writing new checks.</td>
<td><a href="https://github.com/codacy/codacy-clang-tidy#usage">Running Clang-Tidy</a> (standalone)</td>
</tr>
<tr>
<td><a href="http://fauxpasapp.com/">Faux Pas</a></td>
<td>Faux Pas inspects your iOS or Mac app's Xcode project and warns about possible bugs, as well as about maintainability and style issues.</td>
<td><a href="https://github.com/codacy/codacy-faux-pas#usage">Running Faux Pas</a> (standalone)</td>
</tr>
<tr>
<td>Unity</td>
<td><a href="https://github.com/microsoft/Microsoft.Unity.Analyzers">Unity Roslyn Analyzers</a></td>
Expand Down
2 changes: 0 additions & 2 deletions docs/special-thanks.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ In addition to in-house built rules, we use open source tools for many of our st
<li><a href="https://github.com/SonarSource/sonar-dotnet">SonarVB</a></li>
<li><a href="https://github.com/phpmd/phpmd">PHPMD</a></li>
<li><a href="https://github.com/squizlabs/PHP_CodeSniffer">PHP_CodeSniffer</a></li>
<li><a href="https://github.com/jshint/jshint">JSHint</a></li>
<li><a href="https://github.com/mochajs/mocha">Mocha</a></li>
<li><a href="https://github.com/scalastyle/scalastyle">Scalastyle</a></li>
<li><a href="https://github.com/CSSLint/csslint">CSSLint</a></li>
Expand All @@ -50,7 +49,6 @@ In addition to in-house built rules, we use open source tools for many of our st
<td>
<ul>
<li><a href="https://github.com/hadolint/hadolint">Hadolint</a></li>
<li><a href="https://palantir.github.io/tslint/">TSLint</a></li>
<li><a href="https://github.com/sds/scss-lint">SCSSLint</a></li>
<li><a href="https://github.com/rrrene/credo">Credo</a></li>
<li><a href="https://github.com/PowerShell/PSScriptAnalyzer">PSScriptAnalyzer</a></li>
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -660,6 +660,7 @@ nav:
- release-notes/index.md
- Cloud:
- 2023:
- release-notes/cloud/cloud-2023-10-25-csslint-jshint-fauxpas-tailor-tslint-deprecation.md
- release-notes/cloud/cloud-2023-10-13-bundler-audit-deprecation.md
- release-notes/cloud/cloud-2023-09.md
- release-notes/cloud/cloud-2023-08.md
Expand Down
Loading