Created moon project for diff-generator in tools directory #344
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
🦋 Changeset detectedLatest commit: 9459e3a The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
Run report for 9459e3a9Total time: 41.2s | Comparison time: 1m 15s | Estimated savings: 34.6s (45.6% faster)
Expanded report
Touched files |
|
|
…ma to helper function
GarthDB
reviewed
Jun 3, 2024
…detection function
…detect-deleted-tokens branch
…trum-tokens into detect-deleted-tokens
…files in previous commit
…ma to helper function
…detection function
…trum-tokens into detect-deleted-tokens
…recated in change
…se and vice versa
GarthDB
requested changes
Jul 9, 2024
There was a problem hiding this comment.
Could you also update the root README.md file to include the diff generator in the list of packages in the mono repo? https://github.com/adobe/spectrum-tokens/blob/main/README.md?plain=1#L18
tools/diff-generator/package.json
Outdated
| "version": "0.0.1", | ||
| "description": "Creates diffs for tokens", | ||
| "type": "module", | ||
| "private": true, |
There was a problem hiding this comment.
If "private": true is in this file it won't publish this package to npm. Could you just delete it?
| - ava | ||
| - --watch | ||
| local: true | ||
| platform: node |
There was a problem hiding this comment.
Could you add a task for code coverage? It's in the package.json file, but it's ok to have it here too so it can be run in github actions for as part of moon ci
tools/diff-generator/package.json
Outdated
| @@ -0,0 +1,37 @@ | |||
| { | |||
| "name": "diff-generator", | |||
There was a problem hiding this comment.
We should update this name to include the @adobe org namespace. What do you think of @adobe/token-diff-generator? Or @adobe/token-diff?
GarthDB
requested changes
Jul 9, 2024
.changeset/small-radios-mate.md
Outdated
| @@ -0,0 +1,5 @@ | |||
| --- | |||
| "diff-generator": major | |||
There was a problem hiding this comment.
We will need to update this to the new package name in tools/diff-generator/package.json.
GarthDB
requested changes
Jul 9, 2024
tools/diff-generator/README.md
Outdated
| Installing the package is done preferably with pnpm. | ||
|
|
||
| ``` | ||
| pnpm i @adobe/spectrum-tokens/token-diff-generator |
There was a problem hiding this comment.
This would just be the name in the tools/diff-generator/package.json file. So, pnpm I @adobe/token-diff-generator. NPM doesn't support sub packages like this.
tools/diff-generator/README.md
Outdated
| Import the token diff generator as a module per ES6 standards. | ||
|
|
||
| ``` | ||
| import tokenDiff from “@adobe/spectrum-tokens/token-diff-generator”; |
There was a problem hiding this comment.
Similar to the comment above, this would just be the name property in the package.json file.
added 2 commits
July 9, 2024 10:46
GarthDB
approved these changes
Aug 7, 2024
Merged
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.
Description
This commit contains the setup of the diff generating tool using the node-tool template.
Related Issue
This project intends to improve diff generation between two schemas.
Motivation and Context
The motivation behind this project is to improve the diff generation between two schemas. Currently, the diff generation is inaccurate. For example, schema values that aren't deleted get marked as deleted.
How Has This Been Tested?
The project hasn't been tested yet, because this PR only contains the project setup.
Types of changes
Checklist: