feat: markdown reporting stuff

.gitignore

@@ -112,3 +112,9 @@ dist
 # moon
 .moon/cache
 .moon/docker
+
+# visual studio code
+.vscode/
+
+# api key
+github-api-key.js

tools/diff-generator/README.md

@@ -68,15 +68,17 @@ tdiff report
 
 ### Options
 
-| Shorthand | Name                  | Argument(s)    | Description                                            |
-| --------- | --------------------- | -------------- | ------------------------------------------------------ |
-| `-y`      | `-y`                  | `null`         | answers yes to removing deprecated status of token(s)  |
-| `-otv`    | `--old-token-version` | `<oldVersion>` | npm package version/github tag to pull old tokens from |
-| `-ntv`    | `--new-token-version` | `<newVersion>` | npm package version/github tag to pull new tokens from |
-| `-otb`    | `--old-token-branch`  | `<oldBranch>`  | branch to fetch old token data from                    |
-| `-ntb`    | `--new-token-branch`  | `<newBranch>`  | branch to fetch new token data from                    |
-| `-l`      | `--local`             | `<path>`       | local path within repository to fetch token data from  |
-| `-tn`     | `--token-names`       | `<tokens...>`  | indicates specific tokens to compare                   |
+| Shorthand | Name                  | Argument(s)    | Description                                           |
+| --------- | --------------------- | -------------- | ----------------------------------------------------- |
+| `-otv`    | `--old-token-version` | `<oldVersion>` | github tag to pull old tokens from                    |
+| `-ntv`    | `--new-token-version` | `<newVersion>` | github tag to pull new tokens from                    |
+| `-otb`    | `--old-token-branch`  | `<oldBranch>`  | branch to fetch old token data from                   |
+| `-ntb`    | `--new-token-branch`  | `<newBranch>`  | branch to fetch new token data from                   |
+| `-l`      | `--local`             | `<path>`       | local path within repository to fetch token data from |
+| `-tn`     | `--token-names`       | `<tokens...>`  | indicates specific tokens to compare                  |
+| `-gak`    | `--githubAPIKey`      | `<key>`        | github api key to use when fetching from github       |
+| `-f`      | `--format`            | `<format>`     | choose result format cli (default) or markdown        |
+| `-o`      | `--output`            | `<path>`       | choose where to store result output, if available     |
 
 ### Usage examples
 
@@ -91,3 +93,7 @@ This is how you can compare specific token files from a remote branch with your
 ```
 tdiff report -otb shirlsli/file-import-tests -l packages/tokens/src -tn color-aliases.json color-component.json
 ```
+
+```
+tdiff report -otv "@adobe/[email protected]" -ntv "@adobe/[email protected]" --format markdown --output logs/output.md
+```

tools/diff-generator/github-api-key.js

@@ -0,0 +1 @@
+export const githubAPIKey = "";

tools/diff-generator/src/lib/added-token-detection.js

@@ -15,6 +15,7 @@ governing permissions and limitations under the License.
  * @param {object} renamed - the token data that were renamed
  * @param {object} deprecatedTokens - the newly deprecated tokens
  * @param {object} changes - the changed token data
+ * @param {object} original - token data to compare against
  * @returns {object} addedTokens - a JSON object containing the added tokens
  */