tclint 
tclint is a collection of modern dev tools for Tcl. It includes a linter, a formatter, and a language server that provides Tcl support to your editor of choice.
Features
- Editor integration for VS Code, Neovim, and Emacs
- Linting for common Tcl errors
- Formatter that enforces a consistent, readable style
- Plugin system that supports Tcl variants
- More features coming soon!
Getting Started
Install tclint from PyPI using pipx (recommended):
pipx install tclint
Or with pip:
pip install tclint
Run tclint on a Tcl source file by providing its path as a positional argument:
tclint example.tcl
If the file contains any lint violations, they will be printed and tclint will return a non-zero exit code. Otherwise, the output will be empty and tclint will exit successfully.
Example
$ cat example.tcl
if { [expr {$input > 10}] } {
puts $input is greater than 10!
}
$ tclint example.tcl
data/example.tcl:1:6: unnecessary command substitution within expression [redundant-expr]
data/example.tcl:2:3: too many args for puts: got 5, expected no more than 3 [command-args]
Usage
tclint is a command-line utility. It takes a list of paths as positional arguments, which may either be direct paths to source files, or directories which will be recursively searched for files ending in .tcl, .sdc, .xdc, or .upf.
Collected files will be checked for lint violations. See the
Violations documentation page for a description of all
lint violations tclint may report.
Aspects of tclint's behavior can be controlled by a configuration file.
By default, tclint will search for a file named tclint.toml or .tclint by walking the parent directories of source files, but a path to an alternate configuration file can be provided using the -c or --config flag.
See Configuration for documentation on the configuration file.
tclint includes a plugin system for checking EDA tool-specific commands. See the Plugins documentation page for more info.
Contributing
tclint welcomes community contributions. The best way to help the project is to open an issue if you find a bug or have a feature request.
PRs are also welcome, but for non-trivial changes please open an issue first to solicit feedback. This helps avoid wasted effort.
Use the following steps to set up tclint for local development:
$ git clone https://github.com/nmoroze/tclint.git # or URL to fork
$ cd tclint
$ python3 -m venv .venv # set up a venv to ensure clean environment
$ source .venv/bin/activate
(venv) $ pip install --upgrade pip # development requires pip >= 25.1
(venv) $ pip install -e . --group dev
Please format, lint, and run tests before submitting changes:
$ source .venv/bin/activate
(venv) $ black .
(venv) $ ./util/pre-commit
License
This project is copyright Noah Moroze, released under the MIT license.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tclint-0.9.0.tar.gz.
File metadata
- Download URL: tclint-0.9.0.tar.gz
- Upload date:
- Size: 100.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
15517ecb8193e3fd72b657459b633853ba9a60c2124b421c95f613914b89654b
|
|
| MD5 |
2710322b8930bc959e8c65013920a339
|
|
| BLAKE2b-256 |
85d8ebee2778ef596bb6038381299142923f7dbd8e021f2d5711b201a56a5c13
|
Provenance
The following attestation bundles were made for tclint-0.9.0.tar.gz:
Publisher:
release.yml on nmoroze/tclint
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
tclint-0.9.0.tar.gz -
Subject digest:
15517ecb8193e3fd72b657459b633853ba9a60c2124b421c95f613914b89654b - Sigstore transparency entry: 2314425721
- Sigstore integration time:
-
Permalink:
nmoroze/tclint@8fd725b273f5edc1c45c3dad2a9965890d48cf96 -
Branch / Tag:
refs/tags/v0.9.0 - Owner: https://github.com/nmoroze
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@8fd725b273f5edc1c45c3dad2a9965890d48cf96 -
Trigger Event:
release
-
Statement type:
File details
Details for the file tclint-0.9.0-py3-none-any.whl.
File metadata
- Download URL: tclint-0.9.0-py3-none-any.whl
- Upload date:
- Size: 58.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e4f0eb6b263161190a502184425fdd3ab046d09112da8089ddb767e7de198583
|
|
| MD5 |
7aa9d0973fc5b599357400be10ecc43b
|
|
| BLAKE2b-256 |
46d6d1cf5cad5bb11d79546785972f04f6cb51e4415f25eba8957d405c1f8148
|
Provenance
The following attestation bundles were made for tclint-0.9.0-py3-none-any.whl:
Publisher:
release.yml on nmoroze/tclint
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
tclint-0.9.0-py3-none-any.whl -
Subject digest:
e4f0eb6b263161190a502184425fdd3ab046d09112da8089ddb767e7de198583 - Sigstore transparency entry: 2314425777
- Sigstore integration time:
-
Permalink:
nmoroze/tclint@8fd725b273f5edc1c45c3dad2a9965890d48cf96 -
Branch / Tag:
refs/tags/v0.9.0 - Owner: https://github.com/nmoroze
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@8fd725b273f5edc1c45c3dad2a9965890d48cf96 -
Trigger Event:
release
-
Statement type:
