Using hardcode file paths in code (UsingHardcodePath)¶
| Type | Scope | Severity | Activated by default |
Minutes to fix |
Tags |
|---|---|---|---|---|---|
Error |
BSL |
Critical |
Yes |
15 |
standard |
Parameters¶
| Name | Type | Description | Default value |
|---|---|---|---|
searchWordsStdPathsUnix |
String |
Search keywords for standard Unix root folders |
bin|boot|dev|etc|home|lib|lost\+found|misc|mnt|media|opt|proc|root|run|sbin|tmp|usr|var |
Description¶
It's forbidden to store in code:
- Paths to files and folders (Windows, Unix)
There are several ways to correctly store this information:
- Store in Constants.
- Store in Information registers.
- Store in separate module, where this diagnostic is disabled (not recommended).
- Store in Catalog, Exchange plan node and etc.
Nuances¶
When search for Windows / Unix paths, also check for URL in a string. URL search keywords:
* http
* https
* ftp
Examples¶
Incorrect:
EchangeFolder = "c:/exchange/dataexchange";
Correct:
ExchangeFolder = Constants.ExchangeFolder.Get();
or
ExchangeFolder = DataExchangeReuse.ExchangeFolder();
Snippets¶
Diagnostic ignorance in code¶
// BSLLS:UsingHardcodePath-off
// BSLLS:UsingHardcodePath-on
Parameter for config¶
"UsingHardcodePath": {
"searchWordsStdPathsUnix": "bin|boot|dev|etc|home|lib|lost\\+found|misc|mnt|media|opt|proc|root|run|sbin|tmp|usr|var"
}