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.

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

refactor(build-tools): Deprecate some outdated commands and APIs #23280

Merged
merged 7 commits into from
Dec 11, 2024

Conversation

tylerbutler
Copy link
Member

@tylerbutler tylerbutler commented Dec 10, 2024

There are a number of build-tools APIs that should no longer be used for new code. We also have some commands that are no longer used and can be removed in the future. To help clarify which APIs and commands are definitely going away, I have made the following changes:

  1. Removed the Timer class export from the build-tools package.
  2. Removed use of Timer in the check:layers command, including the logtime flag. The flag was hidden and unused.
  3. Updated Logger function signatures and implementations to be compatible with oclif logging functions, so that the base class can correctly call the logger used by the concrete instance.
  4. Deprecated MonoRepoKind type and removed some uses in test files (prod code remains unchanged).
  5. Deprecated FluidRepo, GitRepo, MonoRepo, readPackageJsonAndIndent, updatePackageJsonFile, updatePackageJsonFileAsync.
  6. Updated build-cli lint config to only warn on uses of deprecated APIs except for vnext code.

AB#19713

Next steps after merge:

Move logger interfaces and types to build-infra and use in both build-tools and build-cli.

@github-actions github-actions bot added area: build Build related issues base: main PRs targeted against main branch labels Dec 10, 2024
/**
* A CLI flag to parse the root directory of the Fluid repo.
*/
const rootPathFlag = Flags.custom({
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was unused.

@tylerbutler tylerbutler marked this pull request as ready for review December 10, 2024 20:22
@tylerbutler tylerbutler merged commit dc9530d into microsoft:main Dec 11, 2024
36 checks passed
@tylerbutler tylerbutler deleted the bt-deprecated-commands branch December 11, 2024 21:56
Josmithr pushed a commit to Josmithr/FluidFramework that referenced this pull request Dec 12, 2024
…rosoft#23280)

There are a number of build-tools APIs that should no longer be used for
new code. We also have some commands that are no longer used and can be
removed in the future. To help clarify which APIs and commands are
definitely going away, I have made the following changes:

1. Removed the Timer class export from the build-tools package.
2. Removed use of Timer in the `check:layers` command, including the
logtime flag. The flag was hidden and unused.
3. Updated Logger function signatures and implementations to be
compatible with oclif logging functions, so that the base class can
correctly call the logger used by the concrete instance.
4. Deprecated MonoRepoKind type and removed some uses in test files
(prod code remains unchanged).
5. Deprecated FluidRepo, GitRepo, MonoRepo, readPackageJsonAndIndent,
updatePackageJsonFile, updatePackageJsonFileAsync.
6. Updated build-cli lint config to only warn on uses of deprecated APIs
_except_ for vnext code.


[AB#19713](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/19713)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: build Build related issues base: main PRs targeted against main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants