Assets-fit NPM

Assets-Fit

Please note that this project is in the early development stage and may not work as expected.

Assets-Fit is a CLI tool designed to help reduce the weight of assets in your project. It scans your project directories to find unused assets and duplicated files under different names.

Features

Scan for Unused Assets: Quickly identify unused assets in your project.
Flexible Configuration: Configure assets and files directories through a configuration file.
Easy to Use: Simple commands and clear output make it easy to manage your assets.

Installation

To install Assets-Fit, you need to have Node.js installed on your machine.

npm i -g assets-fit

This will install the af command to your system globally.

Configuration

Assets-Fit can be configured using a configuration file .af.json that can be created manually or using the init command:

af init

Please note, that the init command should be run in the root of your project.

This will create a .af.json file with default values in the root of your project. Update the configuration file to match your project structure.

Here is an example of a configuration file:

{
  "assets": {
    "include": "src/assets/",
    "exclude": [
      ".DS_Store"
    ]
  },
  "files": {
    "include": [
      "src/"
    ],
    "exclude": "src/mocks"
  }
}

assets.include - a directory or directories where assets are stored.

assets.exclude - a list of files or directories to exclude from the scan.

files.include - a directory or directories with project files to scan for asset usage.

files.exclude - a list of files or directories to exclude from the scan for asset usage.

It is recommended to specify exactly the assets.include directories. And for the files.include directories, you may specify the root directory of your project or the ./src directory, for example. It does not affect the performance too much.

Usage

To scan your project for unused assets, run the following command:

af unused

or with short variant:

af u

Running this command will recursively scan directories specified in the files.include configuration option, excluding directories specified in the files.exclude option, and will search for imports or usage of assets from directories specified in the assets.include configuration option, excluding directories specified in the assets.exclude option.

To scan your project for duplicate assets, run the following command:

af duplicate

or with short variant:

af d

duplicate command will compare all files by content and will output all duplicates, which may have different names. It can be useful to find images that were imported multiple times under different names.

Running this command will recursively scan directories specified in the assets.include configuration option, excluding directories specified in the assets.exclude option.