Skip to content

BSL256 — Typo

← All rules

Summary

Typo

Identifiers

Field Value
Rule code BSL256
Compatible alias Typo
Severity INFORMATION
Enabled by default Yes
Implemented Yes
Tags convention

Behavior

  • The public identifier BSL256 and alias Typo are stable.
  • The rule reports the cases documented on this page.
  • Suppressions and project configuration are applied before publication.
  • The rule requires neither an external analyzer nor network access.

Configuration and suppression

BSL### is the primary stable identifier. The compatible alias is accepted in select, ignore, and compatible block suppression comments.

[tool.onec-hbk-bsl]
select = ["BSL256"]
ignore = ["Typo"]

All three suppression families support both a current line and a range. When an opening comment follows code, it affects only that line. Use any one form:

  • noqa:
Value = "example";  // noqa: BSL256
  • bsl-disable:
Value = "example";  // bsl-disable: BSL256
  • compatible BSLLS form:
Value = "example";  // BSLLS:Typo-off

When the same opening comment is on a line by itself, it starts a range. Close it with the matching marker from the same family:

// noqa: BSL256
// code without this diagnostic
// noqa-enable: BSL256

// bsl-disable: BSL256
// code without this diagnostic
// bsl-enable: BSL256

// BSLLS:Typo-off
// code without this diagnostic
// BSLLS:Typo-on

To disable the rule until the end of the file, omit the closing noqa-enable, bsl-enable, or BSLLS:…-on marker.

Opening and closing markers must belong to the same family.

Description

Spell checking is done with LanguageTool. The strings are split into camelCase chunks and checked against a built-in dictionary.

Cache

The diagnostic uses persistent disk cache (EhCache) to store information about already checked words. The cache directory path is configured using app.cache.basePath and app.cache.fullPath properties in the application configuration.

By default, the application has:

app.cache.basePath=${user.home}
app.cache.fullPath=

This means that: - Cache will be created in the user directory (${user.home}/.bsl-language-server/cache/<hash>/) - <hash> is an MD5 hash of the absolute path to the current working directory, ensuring cache isolation for different workspaces - Cache is not created in the project's working directory, avoiding clutter in git repositories

To override the cache path, you can use: - app.cache.fullPath — full path to cache directory (if set, used directly) - app.cache.basePath — base path for automatic calculation (defaults to ${user.home})

Example override:

# Set explicit cache path
app.cache.fullPath=/custom/cache/location

# Or change only the base path
app.cache.basePath=/opt/bsl-ls
# Result: /opt/bsl-ls/.bsl-language-server/cache/<hash>/

CI Recommendations:

Important: With the new version, cache is stored by default in the user directory with workspace hash. For CI, it's recommended to explicitly set app.cache.fullPath to simplify caching between builds.

  • GitHub Actions
  • Set explicit cache path in environment variables or configuration
  • Use actions/cache to save the directory between build and test runs
- name: Cache BSL LS Typo
  uses: actions/cache@v3
  with:
    path: .bsl-ls-cache
    key: ${{ runner.os }}-bsl-typo-${{ hashFiles('**/*.bsl') }}
    restore-keys: |
      ${{ runner.os }}-bsl-typo-
  • GitLab CI

  • In .gitlab-ci.yml use the cache section:

    variables:
  APP_CACHE_FULLPATH: ".bsl-ls-cache"

cache:
  key: "bsl-ls-typo-cache"
  paths:
    - .bsl-ls-cache/
  policy: pull-push

  • If needed, set a unique key for different branches/runners.

  • Jenkins

  • Set environment variable APP_CACHE_FULLPATH for explicit cache path
  • In pipeline, you can save the cache directory between builds in several ways:
    • Use stash/unstash to transfer data between stages in one build.
    • Use the Workspace Cleanup plugin and configure workspace preservation on the agent (if agents are permanent) or archive the artifact using archiveArtifacts and download it in subsequent builds.
    • For Jenkins with dynamic agents (e.g., Kubernetes), it's recommended to save cache in network storage or object storage (S3) and restore it at the beginning of the job.

General recommendations: - For CI environments, it's recommended to explicitly set app.cache.fullPath (e.g., .bsl-ls-cache in project workspace) to simplify caching - Ensure that the cache path is accessible to the build process and has sufficient permissions.

Sources