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

feat: adds support for markdown output to the token diff tool #443

Merged
merged 53 commits into from
Dec 18, 2024

Conversation

mrcjhicks
Copy link
Collaborator

@mrcjhicks mrcjhicks commented Oct 24, 2024

Description

Refactoring of diff reporting to support additional output format, various bug fixes, and additional support stuff.

intended to be squashed, fyi

  • cli reporting can choose to output as markdown (and to a file)

  • adds additional command line options to better support git stuff

  • refactors update token detection code for clarity and debugging and whatnot

  • adds git workflows for comparing branches against s1, s2, and foundation data sets

  • adds some moon tasks for prettier and eslint checks

  • fixes some edge cases in the reporting that could cause a failure

  • fixes a token diff object tree traversal issue

  • fixes token diff object manipulation impacting downstream tests

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

... i can tell it is markdown now without this
... since npm versions aren't supported, yet, just git tags
Copy link

changeset-bot bot commented Oct 24, 2024

🦋 Changeset detected

Latest commit: b371af5

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@adobe/token-diff-generator Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@GarthDB
Copy link
Member

GarthDB commented Oct 24, 2024

Run report for b371af50

Total time: 12.5s | Comparison time: 11.9s | Estimated loss: 520.9ms (4.2% slower)

Action Time Status Info
🟩 SyncWorkspace 5.6ms Passed
⬛️ SetupToolchain(node:~20.12) 1.2s Skipped
🟩 SyncProject(node, diff) 0.2ms Passed
🟩 InstallWorkspaceDeps(node:~20.12) 7.2s Passed
🟩 RunTask(diff:diff) 115.2ms Passed
🟩 RunTask(diff:test) 4.1s Passed
Touched files
.changeset/strong-timers-wonder.md
.github/workflows/_tdiff.yml
.github/workflows/tdiff-spectrum-foundations.yml
.github/workflows/tdiff-spectrum1.yml
.github/workflows/tdiff-spectrum2.yml
.gitignore
pnpm-lock.yaml
tools/diff-generator/README.md
tools/diff-generator/eslint.config.js
tools/diff-generator/github-api-key.js
tools/diff-generator/moon.yml
tools/diff-generator/package-lock.json
tools/diff-generator/package.json
tools/diff-generator/src/lib/added-token-detection.js
tools/diff-generator/src/lib/cli.js
tools/diff-generator/src/lib/diff.js
tools/diff-generator/src/lib/file-import.js
tools/diff-generator/src/lib/format-function.js
tools/diff-generator/src/lib/formatterCLI.js
tools/diff-generator/src/lib/formatterMarkdown.js
tools/diff-generator/src/lib/helpers.js
tools/diff-generator/src/lib/index.js
tools/diff-generator/src/lib/store-output.js
tools/diff-generator/src/lib/updated-token-detection.js
tools/diff-generator/test/addedToken.test.js
tools/diff-generator/test/deletedToken.test.js
tools/diff-generator/test/deprecatedToken.test.js
tools/diff-generator/test/renamedToken.test.js
tools/diff-generator/test/updatedToken.test.js

@mrcjhicks mrcjhicks requested a review from GarthDB October 24, 2024 20:20
@mrcjhicks mrcjhicks marked this pull request as ready for review November 1, 2024 17:42
@GarthDB GarthDB merged commit b371af5 into main Dec 18, 2024
4 checks passed
@GarthDB GarthDB deleted the cable/tdiff-markdown-reporting branch December 18, 2024 21:28
@GarthDB GarthDB mentioned this pull request Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants