Move migration-tools to separate example package #22267
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
area: examples
scottn12
approved these changes
Aug 20, 2024
| @@ -65,14 +70,15 @@ class MigrationTool implements IMigrationTool { | |||
| return "migrated"; | |||
| } else if (this.acceptedMigration !== undefined) { | |||
| return "migrating"; | |||
| // eslint-disable-next-line unicorn/no-negated-condition | |||
There was a problem hiding this comment.
This is an interesting eslint rule 🤔
There was a problem hiding this comment.
Yeah, I'm usually not a fan but will go along with it. Here though I decided to at least put off compliance since it would want me to swap just the last two clauses that are otherwise in chronological order.
github-actions
bot
added
area: examples
⯅ @fluid-example/bundle-size-tests: +245 Bytes
Baseline commit: 1a86c7d |
jason-ha
reviewed
Aug 20, 2024
Comment on lines
33
to
40
| "build:docs": "api-extractor run --local", | ||
| "build:esnext": "tsc --project ./tsconfig.json", | ||
| "check:are-the-types-wrong": "attw --pack .", | ||
| "check:biome": "biome check .", | ||
| "check:exports": "api-extractor run --config ./api-extractor-lint.json", | ||
| "check:format": "npm run check:biome", | ||
| "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore", | ||
| "ci:build:docs": "api-extractor run", |
There was a problem hiding this comment.
Remove "build:docs" and "ci:build:docs" to avoid API extractor reports. api-extractor.json could also be removed.
I think the policy will be okay with you leaving the API linting via "check:exports": "api-extractor run --config ./api-extractor-lint.json" using api-extractor-lint.json.
All of the APIs are tagged @internal which doesn't seem to make sense. Add notes if this is intentional and explain the pattern.
- If nothing will ever be publicly used (package could be in the
@fluid-internalscope eventually) then remove all API related things - linting too. - If some might be public facing, then use a tag other than
@internalto distinguish. The linting step should keep tagging honest (even without the report).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR primarily moves the migration-tools to their own separate example package, rather than their current home of example-utils. There are no material functional changes to the tools or examples.
Since we'll eventually be putting these through the experimental/beta phase this will be necessary anyway, and in the meantime it'll help clarify to customers what portions they should be checking out.
It largely does not touch the same-container migration tools since they're not the focus right now, beyond separating out some shared types.
Other changes are:
AB#12617
AB#12618