Codense

Description

Codense is a command-line tool designed to summarize the contents of a web development project. This tool goes through the specified directory, minifying JavaScript, HTML, and CSS files, and displaying the reduced code with file paths. If a .gitignore or .codenseignore file is present, the tool will ignore the files and directories specified in them. The output can be printed to the console or copied to the clipboard.

Getting Started

Prerequisites

Node.js

Installation

Clone the repository

$ git clone https://github.com/e3ntity/codense.git

Navigate to the project directory

$ cd codense

Install the dependencies and link the package

$ yarn
$ yarn link

To run codense from anywhere, add ~/.yarn/bin to your path by modifying ~/.bashrc

Usage

Run the tool using the codense command followed by the directory you want to summarize. For example:

$ codense ./my-project

To copy the output to the clipboard, use the -c or --clipboard flag:

$ codense ./my-project --clipboard

Options

-c, --clipboard Copies the output to the clipboard.

Ignoring Files

If there are files or directories you don't want the tool to process, you can specify them in a .gitignore or .codenseignore file. The tool will read these files (if they exist) and ignore the specified files and directories. Attention: You will have to add both .gitignore and .codenseignore to your .codenseignore file if you want to ignore them.

Example .codenseignore

/node_modules
/dist
/test
.gitignore
.codenseignore

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. If you have any questions or run into any issues, please file an issue on the GitHub project page.

e3ntity / codense