linguachecker

package module
v0.0.0-...-0dad241 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 11, 2024 License: MIT Imports: 5 Imported by: 0

README

Name

Linguachecker is a linter for Golang that checks the language of comments in your code.

Usage

After installation, you can run the linter using the following command:

linguachecker ./...

This command will check all files in the current directory and its subdirectories.

Configuration

You can configure the linter by creating a .comment-lang-linter.yaml file in the root directory of your project. Here is an example configuration:

language: en

In this example, the linter will check that all comments are written in English.

TODO

  • Add actions
  • Add testdata filtration and config to filter out some files
  • Sanitize multiline comments
  • Check for code comments
  • Add linting
  • Detect code comments

Contribution

We welcome any contribution to this project. If you found a bug or want to add a new feature, feel free to create an issue or pull request.

License

This project is licensed under the MIT license. Details can be found in the LICENSE file.

Documentation

Index

Constants

This section is empty.

Variables

View Source
var Analyzer = &analysis.Analyzer{
	Name: "Linguachecker",
	Doc:  "Linguachecker checks for language of comments in code",
	Run:  run,
}

Functions

This section is empty.

Types

This section is empty.

Directories

Path Synopsis
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL