Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

migrate design tokens: Replace config files #106

Closed
georgewrmarshall opened this issue Nov 13, 2024 · 0 comments · Fixed by #107
Closed

migrate design tokens: Replace config files #106

georgewrmarshall opened this issue Nov 13, 2024 · 0 comments · Fixed by #107
Assignees
@georgewrmarshall
Labels
team-design-system

Comments

@georgewrmarshall
Copy link
Contributor

Description

As part of the design tokens migration, this task focuses on updating configuration files to ensure consistency across the monorepo. Key config files in non-root directories should extend from the root directory’s corresponding files, aligning with the shared project standards. For additional guidance, refer to the Package Migration Process Guide.

Technical Details

  • Update Config Files:
    • Modify tsconfig*.json, typedoc.json, and jest.config.js to extend from the root directory versions.
    • Copy settings from these files in other non-root packages as a reference.
  • Configuration Adjustments:
    • TypeScript:
      • Preserve compiler flags and the target for TypeScript compilation.
      • Add reference paths for non-root packages that serve as upstream dependencies.
    • Jest:
      • Maintain existing coverage threshold values for consistent test coverage.
  • Dependencies:
    • Add deepmerge as a devDependency for handling configuration merging.
  • Reference:
    • Refer to Example PR for guidance on configuration structure and dependency setup.

Acceptance Criteria

  • Updated config files (tsconfig*.json, typedoc.json, jest.config.js) are set to extend from the root versions.
  • TypeScript settings and Jest coverage values are preserved as specified.
  • deepmerge is added as a devDependency and applied as needed.
  • Builds and tests operate correctly across packages with the updated configuration.

References
@georgewrmarshall georgewrmarshall self-assigned this Nov 13, 2024
This was referenced Nov 13, 2024
Merged
Merged
georgewrmarshall added a commit that referenced this issue Nov 14, 2024
@georgewrmarshall
chore: update config files for design-tokens (#107)
c3f64b1 
## **Description**

This PR resolves [Issue
#106](#106) by
updating the configuration files as part of the design tokens migration
process. Following the [Package Migration Process
Guide](https://github.com/MetaMask/metamask-design-system/blob/main/docs/package-migration-process-guide.md#pr9-5-replace-config-files)

## **Related issues**

Fixes: #106

## **Manual testing steps**

1. Verify that the updated config files match the steps in the migration
guide

## **Pre-merge author checklist**

- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs)
- [x] I've completed the PR template to the best of my ability.
- [x] I’ve included tests if applicable.
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable.
- [x] I’ve applied the appropriate labels to the PR.

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g., pulled and built the branch,
checked the app, and verified updated configurations).
- [ ] I confirm that this PR addresses all acceptance criteria described
in issue #106 and includes necessary testing evidence such as recordings
or screenshots.
georgewrmarshall added a commit that referenced this issue Nov 15, 2024
@georgewrmarshall
chore: update align dependencies and update build scripts in design t…
0b8ca68 
…okens (#115)

## **Description**

This PR resolves [Issue
#108](#108) by
aligning the dependencies and build scripts in the target package with
the monorepo's root configuration as part of the design tokens migration
process. Following the [Package Migration Process
Guide](https://github.com/MetaMask/metamask-design-system/blob/main/docs/package-migration-process-guide.md#pr10-6-align-dependencies-and-build-scripts-with-monorepo)

## **Related issues**

Fixes: #108

## **Manual testing steps**

1. Verify that all unnecessary dependencies have been removed

## **Pre-merge author checklist**

- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs)
- [x] I've completed the PR template to the best of my ability.
- [x] I’ve included tests if applicable.
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable.
- [x] I’ve applied the appropriate labels to the PR.

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g., pulled and built the branch,
checked the app, and verified updated configurations).
- [ ] I confirm that this PR addresses all acceptance criteria described
in issue #106 and includes necessary testing evidence such as recordings
or screenshots.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@georgewrmarshall georgewrmarshall

Labels
team-design-system
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: update config files for design-tokens MetaMask/metamask-design-system
1 participant
@georgewrmarshall