Description
2024/Q1/O4/KR1 Description:
There are various libraries across our organization that need continued maintenance work and the responsibility of this maintenance work is spread across many teams. The Shared Libraries team has been mostly focused on moving and maintaining libraries which have core wallet functionality but in the process of doing this work we have started to create a tool which can help teams stay on top of this work for libraries in their scope of work. This tool is called “module-lint”. Module-lint started as a way for us to complete the library migration and maintenance work we have but we have realized this could and should be a product / tool we provide to other teams. The KR allows us to continue building the MVP of this tool and begin to help other teams take advantage of using it.
MVP inclusions target:
- Node.js version (Add checks for Node version compliance module-lint#12)
- Yarn version/configuration (Add checks for Yarn compliance module-lint#11)
- ESLint versions/configuration (Add checks for whether lint/formatting packages are present and up to date module-lint#9)
- Jest version/configuration (Add checks for Jest compliance module-lint#10)
- TypeScript version/configuration (Add checks for TypeScript compliance module-lint#8)
- TypeDoc version/configuration (Add checks for TypeDoc compliance module-lint#47)
- auto-changelog version/configuration (Add changelog-related checks module-lint#48)
- allow-scripts version/configuration (Add
allow-scripts-related checks module-lint#51) -
npm package scripts for building, linting, changelog validation, testsThis will already be covered by the above - GitHub actions (nice to have) (Add workflow-related checks module-lint#52)
- Checks for general module template adherence (https://github.com/MetaMask/module-lint//issues/6)