README

Welcome to the documentation for the eslint-plugin-jibe GitHub Actions workflow!

Table of Contents

• Introduction
• Installation
• Usage
• Configuration
• Contributing
• License

Introduction

The eslint-plugin-jibe GitHub Actions workflow is designed to help you enforce coding standards and best practices in your JIBE projects. It integrates seamlessly with ESLint to provide automated code analysis and feedback.

Installation

To use the eslint-plugin-jibe GitHub Actions workflow, follow these steps:

1. Clone the repository to your local machine.
2. Install the required dependencies by running npm install.
3. Configure the workflow by updating the .github/workflows/readme.yml file.
4. Commit and push your changes to trigger the workflow.

Usage

Once the workflow is set up, it will automatically run ESLint on your JIBE project whenever a push or pull request is made. The results will be displayed in the GitHub Actions tab of your repository.

Configuration

The eslint-plugin-jibe GitHub Actions workflow can be customized to fit your specific needs. You can modify the ESLint rules, exclude certain files or directories, and more. Refer to the ESLint documentation for detailed instructions on how to configure ESLint.

Contributing

Contributions to the eslint-plugin-jibe GitHub Actions workflow are welcome! If you encounter any issues or have suggestions for improvement, please open an issue or submit a pull request on the repository.

License

The eslint-plugin-jibe GitHub Actions workflow is licensed under the MIT License.

Using eslint-plugin-jibe in Other Projects

To use the eslint-plugin-jibe package in your other projects, follow these steps:

1. Install the package by running the following command in your project directory:

yarn -D eslint-plugin-jibe

2. In the .eslintrc.js file, add the following configuration:

module.exports = {
  plugins: ["jibe"],
  rules: {
    "jibe/deprecated-spacing-tokens": "error",
    "jibe/no-link-from-other-packages": "error",
    "jibe/require-sizes-in-image": "error",
  },
};

Now, when you run ESLint in your project, it will use the eslint-plugin-jibe package and apply the specified rules.