Table of content

1. Purpose
2. Features
3. Showcase
4. Install
5. Platform Support
6. How to use it
7. Changelog
8. License
9. Development
   1. LLMs and AI in general
   2. Before you open any pull request
   3. Before Implementing a feature
   4. Autogenerated files
   5. Needed Tools for Development
   6. Additionally needed tools for a release of a version
      1. Set rpm signing packages for a release
      2. How to make a release for a new version

Purpose

CLI tool to get an overview over which programming languages are used under a directory.

Features

• Minimal viable product
• Scans directory and puts out all found languages, unknown part and total part with the following info
• File Count and its percentage
• Lines and its percentage
• Size in Bytes, either as 1000 scale or as 1024 scale and its percentage
• Can be run in single threaded or multi threaded mode

Showcase

Running this command

please-code-count <path_to_directory_inspect>

Provides you with a overview of what programming languages a project is made up.

Here is an example how that might look like.

Example

Install

Follow this instructions.

Platform Support

I support all Architectures for which I provide a binary within a release. I provide binaries for the x86_64, arm 64 bit and RISC-V architecture only on Linux.

This application is primarily tested on a Fedora System on x86_64 CPU. While I do not develop on arm 64 bit and RISC-V Systems, I at least make sure that all unit and integration tests pass within a Container running one of theses architectures.

In addition I also provide packages for Red Had Systems and Debian based Linux Distribution, Arch.

Other Linux distribution family or BSD Systems might follow.

I do not intend to provide binaries for or support Window or Mac OS systems. You can of course still compile application for those unsupported systems yourself.

How to use it

You have three ways to learn more about using this application

1. See the online documentation for latest version.
2. Read the man page running man please-code-count.
3. Run please-code-count --help and for reading examples please-code-count --help-examples.

Changelog

See this Changelog

License

Is licensed under MIT. See the following file for more details.

Development

LLMs and AI in general

I do not accept/want any contribution produced by LLM or AI.

Before you open any pull request

Run this command just check and make sure it passes

Before Implementing a feature

Before opening a pull request for a feature, please open an issue for a discussion. Only if I approve for this feature in an issue then I am willing to review any pull request implementing this feature

Autogenerated files

All files under the dir are automatically created. Do not edit them manually. This files serve the following purposes

• Provide online documentation as an alternative to the man page of this tool.
• Currently checked in auto generated shell completions/man pages for access and review of the app's autocompletion without the need of installing or compiling the application.

Needed Tools for Development

• rust_toolchain
• just
• cargo audit
• cargo insta
• typos
• podman
• git lfs

Setup: Run git lfs install within this project.

Additionally needed tools for a release of a version

• podman
• cross
• nfpm

Set rpm signing packages for a release

Create at ~/.rpmmacros

%_signature gpg
%_gpg_path ~/gnupg
%_gpg_name bool_purist
%_gpgbin /usr/bin/gpg

How to make a release for a new version

1. Run the following command just check and make sure it passes.
2. Run the following command just podman_test_release and make sure it passes.
3. Bump the version of the package within Cargo.toml
4. Within the changelog move the unreleased section to newly created section with the bumped version
5. Make new commit and create a corresponding git tag for the new version.
6. Push this new commit and this tag to the branch main.
7. Run this command just prep_podman to build the needed local containers.
8. Run this command just full_release.
9. Run just sign_release <KEYID_OF_GPG_KEY>.
10. Under the directory ./dist/release you find all the artificates to be released.
11. Make release with newly created tag.
12. Upload under dist/release the following to the release: CHANGLOGE.md, SHA512SUMS.txt, SHA512SUMS.txt.asc and all dist/release/please-code-count-*.tar.gz and all dist/release/please-code-count-*.gz.
13. Type codeberg API token into the environmental variable APP_PASSWORD via read -s APP_PASSWORD and the export it export APP_PASSWORD.
14. Run just upload_all_packages
15. Head to the homebrew repo and adjust this formula for this release.