MetaMask/eslint-plugin-design-tokens

Create repo based on module template repo

Closed this issue · 1 comments

georgewrmarshall commented

Description

To support our initiative for enforcing color linting rules within the MetaMask portfolio, we require a dedicated repository for the custom ESLint plugin. This repository will be based on the MetaMask module template to ensure consistency with our development practices and to leverage the established project structure and tooling setup. The creation of this repository is a foundational step in developing, documenting, and maintaining the ESLint plugin that will help guide engineers towards the correct usage of theme variables and design tokens.

Technical Details

  • Repository Creation: Initiate a new repository using the MetaMask module template as a starting point. This ensures that the repository adheres to our standard project structure and includes necessary configurations and tooling.
  • Initial Setup: Bootstrap the repository with an initial ESLint plugin setup. This includes installing ESLint dependencies, setting up a basic plugin structure, and creating a placeholder for the custom linting rules as outlined in the epic.
  • Documentation: Update the README file to reflect the purpose of the repository, how to install the plugin, and a brief overview of the linting rules it will enforce. The README should also include instructions for contributing to the plugin's development.

Acceptance Criteria

  • A new repository for the ESLint plugin is successfully created, based on the MetaMask module template.
  • The repository is bootstrapped with an initial ESLint plugin setup, ready for further development of the custom linting rules.
  • The README is updated to provide essential information about the plugin, including its purpose, installation instructions, and contribution guidelines.
  • The repository setup facilitates easy integration with the MetaMask portfolio's existing ESLint configuration.

Additional Notes

This repository will serve as the central location for the development and maintenance of the ESLint plugin that enforces our color linting rules. It's crucial for this repository to be easily accessible and understandable to both internal team members and external contributors who may wish to contribute to the plugin's development.

Tracking

This task is part of the broader epic aimed at enforcing color linting rules across the MetaMask portfolio. Progress on this task will be tracked through this GitHub issue, with subsequent tasks and milestones documented as the plugin development progresses.