@brandingbrand/code-plugin-clean

A plugin for cleaning up native android and ios directories from your project. This plugin checks if these directories exist and removes them, providing clear logging for each action. It is useful for resetting your environment or cleaning up unnecessary native directories during your build or maintenance process.

Features

• Directory Removal: Removes android and ios directories if they exist in the project.
• Clear Logging: Logs success or failure messages for both directories.
• Error Handling: Catches and logs errors if the directories cannot be removed.

Installation

To install the plugin with Yarn, run the following command:

yarn add -D @brandingbrand/code-plugin-clean

Ensure that you have the necessary setup to use the plugin with @brandingbrand/code-cli.

Usage

This plugin is executed using @brandingbrand/code-cli, making it part of your build or maintenance process to clean up unnecessary directories.

Configuration

You can add this plugin to your project by integrating it with your build pipeline or running it manually like this:

import cleanNativeFilesPlugin from '@brandingbrand/code-plugin-clean';

cleanNativeFilesPlugin.ios();
cleanNativeFilesPlugin.android();

Plugin Workflow

The plugin performs the following steps:

1. Check for the existence of the android directory:
   • If the android directory exists, it will be removed.
2. Check for the existence of the ios directory:
   • If the ios directory exists, it will be removed.
3. Clear Logging:
   • Logs whether the android and ios directories were successfully removed.
   • Logs any errors encountered during the removal process.

Example Usage

To use this plugin with @brandingbrand/code-cli in a project, ensure that your project is set up with a flagship-code.config.ts file. This file typically contains the configuration for various actions and plugins, including this clean-up plugin.

Here’s how to integrate it into your flagship-code.config.ts:

1. Configure the Plugin in flagship-code.config.ts:

   You will need to add the @brandingbrand/code-plugin-clean plugin to your flagship-code.config.ts to execute it automatically or as part of a custom command.

   Example flagship-code.config.ts:

   import { defineConfig } from '@brandingbrand/code-cli-kit';
   
   export default defineConfig({
     plugins: [
       '@brandingbrand/code-plugin-clean',
     ],
     // Other configurations for your project
   });

Error Handling

If the plugin encounters any issues while removing the directories, it will log the errors and throw an exception with a detailed error message. For instance:

Error: unable to remove ios directory, <error_message>

Development

Running Tests

To run tests for this plugin:

1. Install the dependencies:

yarn install

2. Run the tests using jest:

yarn test

Linting

To ensure code quality, you can run ESLint:

yarn lint