CLC - Conscious Language Checker

CLC is a suite of tools that checks software projects for potentially problematic words and sentences and tracks the development over time. It comes with a background indexer and a web server with a visual user interface for viewing reports and adding/editing projects.

Installation

• Clone the repo: git clone https://github.com/Humbedooh/clc.git
• Go to the server/ dir and fix up clc.yaml to your liking
• To run with pipenv for virtualizing the environment:
  • Install pipenv: apt install pipenv or yum install pipenv etc (older systems might use pip3 install pipenv)
  • From the server/ dir, run: pipenv install -r requirements.txt
  • Start the service: pipenv run python3 main.py and see your service at http://localhost:8080 (default settings)
• OR, you can pick the global pip3 method if pipenv is not available:
  • From the server/ dir, run: pip3 install -r requirements.txt
  • Start the service: python3 main.py and see your service at http://localhost:8080

Running as a Docker container

The simplest form is to use the provided Dockerfile as such:

• docker build . -t clc
• docker run -d -p 8080:8080 clc

And visit http://localhost:8080/ for goodness!

Speeding up YAML parsing

If you have a project with a lot of issues (10,000+), you can make use of the C++ YAML parser in python by installing the libyaml-cpp-dev package before you install PyYaml. This will speed up YAML parsing/writing by 10x.

Default scan options

The default set or words and contexts to scan for is defined in the defaults.yaml file. It contains a set of potentially problematic words and their contexts, as well as an exclude list (both files and sentence contexts) for where the words are either unavoidable or harmless.

Any new project added will use these defaults unless otherwise specified in the project settings.

User accounts

When open_server is set to false, only logged-in users may add/edit projects. The account file to use is defined in clc.yaml under the acl section. A sample configuration file has been provided in this repo, users.sample.yaml.

The distinction between admin and user is that admins will be able to see the audit logs for the server, whereas normal users will not. Only plain logins are currently supported.

Importing entire organizations (GitHub etc)

To support importing entire organizations, you will need to add a Personal Access Token to the clc.yaml file, currently under the oauth section. This will ensure that CLC can use the GraphQL interface in GitHub for grabbing the list of repos.

If you need to sync the repos with an org, you can re-import, and any new repos discovered will be added, while the old existing repositories will be retained as they were.