2019-03-13 17:00:30 +01:00
#
# Copyright 2018 New Vector Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# This file list String which are not allowed in source code.
# Use Perl regex to write forbidden strings
# Note: line cannot start with a space. Use \s instead.
# It is possible to specify an authorized number of occurrence with === suffix. Default is 0
# Example:
# AuthorizedStringThreeTimes===3
# Extension:java
# Extension:kt
# Use new SecureLinearLayoutManager
# DISABLED
#new LinearLayoutManager
### No import static: use full class name
import static
### Rubbish from merge. Please delete those lines (sometimes in comment)
<<<<<<<
>>>>>>>
### carry return before "}". Please remove empty lines.
\n\s*\n\s*\}
### typo detected.
formated
abtract
Succes[^s]
succes[^s]
### Please insert line break. ex: .flatMap() not at new line
\}\)\.[\w]
### Use int instead of Integer
protected Integer
2019-07-09 15:40:49 +02:00
### Use the interface declaration. Example: use type "Map" instead of type "HashMap" to declare variable or parameter. For Kotlin, use mapOf, setOf, ...
2019-03-13 17:00:30 +01:00
(private|public|protected| ) (static )?(final )?(HashMap|HashSet|ArrayList)<
### Use int instead of short
Short\.parseShort
\(short\)
private short
final short
### Line length is limited to 160 chars. Please split long lines
2020-04-16 14:35:23 +02:00
[^─]{161}
2019-03-13 17:00:30 +01:00
### "DO NOT COMMIT" has been committed
DO NOT COMMIT
### invalid formatting
\s{8}/\*\n \*
2020-02-25 09:57:12 +01:00
# Now checked by ktlint
# [^\w]if\(
# while\(
# for\(
2019-03-13 17:00:30 +01:00
# Add space after //
# DISABLED To re-enable when code will be formatted globally
#^\s*//[^\s]
# Not usable with unitary test. Use StringUtils
# DISABLED
#TextUtils\.isEmpty\(
### invalid formatting (too many space char)
^ /\*
# No ternary operator
# DISABLED
# \?
### unnecessary parenthesis around numbers, example: " (0)"
\(\d+\)
### Malformatted comment
^ \*
### import the package, do not use long class name with package
android\.os\.Build\.
### Tab char is forbidden. Use only spaces
\t
# Empty lines and trailing space
# DISABLED To re-enable when code will be formatted globally
#[ ]$
### Deprecated, use retrofit2.HttpException
import retrofit2\.adapter\.rxjava\.HttpException
### This is generally not necessary, no need to reset the padding if there is no drawable
setCompoundDrawablePadding\(0\)
# Change thread with Rx
# DISABLED
#runOnUiThread
### Bad formatting of chain (missing new line)
\w\.flatMap\(
### Bad formatting of Realm query chain. Insert new line
2020-06-03 18:54:03 +02:00
# DISABLED
# \)\.equalTo
2019-03-13 17:00:30 +01:00
# Use StandardCharsets.UTF_8.name()
# DISABLED (min API to low)
#\"UTF-
### Directly use getString() in a Fragment
getActivity\(\)\.getString\(
### In Kotlin, Void has to be null safe, i.e. use 'Void?' instead of 'Void'
\: Void\)
### Home menu click is managed in parent Activity, with one exception
android\.R\.id\.home===2
### Kotlin conversion tools introduce this, but is can be replace by trim()
trim \{ it \<\= \' \' \}
2021-06-09 11:51:04 +02:00
### Use MaterialAlertDialogBuilder
2019-03-13 17:00:30 +01:00
android\.app\.AlertDialog
2021-06-09 11:51:04 +02:00
androidx\.appcompat\.app\.AlertDialog===4
2019-03-13 17:00:30 +01:00
### Put the operator at the beginning of next line
==$
### Use JsonUtils.getBasicGson()
new Gson\(\)
2019-07-09 17:08:24 +02:00
### Use matrixOneTimeWorkRequestBuilder
2020-09-10 17:13:11 +02:00
import androidx.work.OneTimeWorkRequestBuilder===2
2019-09-26 10:41:52 +02:00
### Use TextUtils.formatFileSize
Formatter\.formatFileSize===1
### Use TextUtils.formatFileSize with short format param to true
Formatter\.formatShortFileSize===1
2019-10-22 17:41:59 +02:00
### Use kotlin stdlib to test or compare strings
2020-02-03 16:14:36 +01:00
# DISABLED
# android\.text\.TextUtils
2020-06-28 22:06:03 +02:00
2020-10-14 11:20:01 +02:00
### This is not a rule, but a warning: the number of "enum class" has changed. For Json classes, it is mandatory that they have `@JsonClass(generateAdapter = false)`. If the enum is not used as a Json class, change the value in file forbidden_strings_in_code.txt
2021-12-25 23:48:11 +01:00
enum class===117
2020-06-29 14:22:30 +02:00
### Do not import temporary legacy classes
2020-08-13 10:44:55 +02:00
import org.matrix.android.sdk.internal.legacy.riot===3
2020-06-29 14:22:30 +02:00
import org.matrix.androidsdk.crypto.data===2
2020-08-11 12:42:32 +02:00
### Use `Context#getSystemService` extension function provided by `core-ktx`
getSystemService\(Context
2020-09-09 12:10:46 +02:00
### Use DefaultSharedPreferences.getInstance() instead for better performance
PreferenceManager\.getDefaultSharedPreferences==2
2020-12-16 02:05:38 +01:00
### Use ViewBindings
2020-12-16 14:35:30 +01:00
# findViewById
2021-03-03 18:08:05 +01:00
### Do not use `template_` string. Please remove the prefix `template_` to use the generated resource instead.
R\.string\.template_