ByoungSooPark/diff-viewer-extension
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
d3a4f4c27c8b2238b359224899aaabe642cef913
diff-viewer-extension/README.md

49 lines
1.6 KiB
Markdown
Raw Normal View History

Minimal working version (#1) * cra boilerplate * Dummy chrome extension * eslint and working url popup * content script and dummy messaging * replace .obj diffs with dummy test * comment and in-order multiple type support * get pull api data from url * README title and desc * api/elements match with filename check * github token signin signout * manifest v3, service request for CORS * working kittycad api in service worker * First real background message * Clean up, better types * Fix settings * multiservice settings * Tweaks * WIP: download file * Working downloads and kittycad conversion * Inject react, add three dependencies * Working stl canvas * primer for github-like style * Loading before model * diff colors * colorMode auto * Popup clean up * clean up * Working loading * Logos * Add GitHub CI * Working test * yarn test in ci * Little tweak * Update README * component tests * Better test * Clean up * UserCard test * working caddiff test * Note * Rename App to Settings * storage test * Clean up * Clean up content script * further content cleanup * Fix test * Little tweaks to modelview * More tests and testing * Regex fix * LFS file download test * prettier config from kittycad/website * Little tweaks * comment * log level * Tweaks * README update * more prettier * comment * Irrelevant comment * No .vscode and readme update * Remove .vscode * Package.json update after vscode removal
2023-03-02 04:35:07 -05:00
# Diff Viewer Chrome Extension
Injects @kittycad/lib powered visual diffs for supported CAD files in GitHub Pull Requests.
## Available Scripts
Migrate away from CRA (#155) * Migrate away from CRA Fixes #128 * Add vitest * Fix github client, still issues with kittycad * Working e2e tests when kittycad.ts functions don't call node-fetch * Remove cross-fetch that was causing issues in the browser (not sure why) * Node 18, rm custom kittycad.ts, replace node-fetch * Clean up * Clean up and lint
2023-05-16 18:20:48 -04:00
The project uses Vite, with Node 18, yarn 3 as package manager and TypeScript.
Minimal working version (#1) * cra boilerplate * Dummy chrome extension * eslint and working url popup * content script and dummy messaging * replace .obj diffs with dummy test * comment and in-order multiple type support * get pull api data from url * README title and desc * api/elements match with filename check * github token signin signout * manifest v3, service request for CORS * working kittycad api in service worker * First real background message * Clean up, better types * Fix settings * multiservice settings * Tweaks * WIP: download file * Working downloads and kittycad conversion * Inject react, add three dependencies * Working stl canvas * primer for github-like style * Loading before model * diff colors * colorMode auto * Popup clean up * clean up * Working loading * Logos * Add GitHub CI * Working test * yarn test in ci * Little tweak * Update README * component tests * Better test * Clean up * UserCard test * working caddiff test * Note * Rename App to Settings * storage test * Clean up * Clean up content script * further content cleanup * Fix test * Little tweaks to modelview * More tests and testing * Regex fix * LFS file download test * prettier config from kittycad/website * Little tweaks * comment * log level * Tweaks * README update * more prettier * comment * Irrelevant comment * No .vscode and readme update * Remove .vscode * Package.json update after vscode removal
2023-03-02 04:35:07 -05:00
From the project directory:
### `yarn install`
Installs all the dependencies needed to build and test the project.
### `yarn build`
Migrate away from CRA (#155) * Migrate away from CRA Fixes #128 * Add vitest * Fix github client, still issues with kittycad * Working e2e tests when kittycad.ts functions don't call node-fetch * Remove cross-fetch that was causing issues in the browser (not sure why) * Node 18, rm custom kittycad.ts, replace node-fetch * Clean up * Clean up and lint
2023-05-16 18:20:48 -04:00
Builds the extension for production to the `build` folder.\
Minimal working version (#1) * cra boilerplate * Dummy chrome extension * eslint and working url popup * content script and dummy messaging * replace .obj diffs with dummy test * comment and in-order multiple type support * get pull api data from url * README title and desc * api/elements match with filename check * github token signin signout * manifest v3, service request for CORS * working kittycad api in service worker * First real background message * Clean up, better types * Fix settings * multiservice settings * Tweaks * WIP: download file * Working downloads and kittycad conversion * Inject react, add three dependencies * Working stl canvas * primer for github-like style * Loading before model * diff colors * colorMode auto * Popup clean up * clean up * Working loading * Logos * Add GitHub CI * Working test * yarn test in ci * Little tweak * Update README * component tests * Better test * Clean up * UserCard test * working caddiff test * Note * Rename App to Settings * storage test * Clean up * Clean up content script * further content cleanup * Fix test * Little tweaks to modelview * More tests and testing * Regex fix * LFS file download test * prettier config from kittycad/website * Little tweaks * comment * log level * Tweaks * README update * more prettier * comment * Irrelevant comment * No .vscode and readme update * Remove .vscode * Package.json update after vscode removal
2023-03-02 04:35:07 -05:00
It correctly bundles React in production mode and optimizes the build for the best performance.
The generated `build` directory may then be added to Chrome with the **Load unpacked** button at [chrome://extensions](). This needs to be done everytime there's a change.
### `yarn start`
Migrate away from CRA (#155) * Migrate away from CRA Fixes #128 * Add vitest * Fix github client, still issues with kittycad * Working e2e tests when kittycad.ts functions don't call node-fetch * Remove cross-fetch that was causing issues in the browser (not sure why) * Node 18, rm custom kittycad.ts, replace node-fetch * Clean up * Clean up and lint
2023-05-16 18:20:48 -04:00
Runs the extension in the development mode.
Minimal working version (#1) * cra boilerplate * Dummy chrome extension * eslint and working url popup * content script and dummy messaging * replace .obj diffs with dummy test * comment and in-order multiple type support * get pull api data from url * README title and desc * api/elements match with filename check * github token signin signout * manifest v3, service request for CORS * working kittycad api in service worker * First real background message * Clean up, better types * Fix settings * multiservice settings * Tweaks * WIP: download file * Working downloads and kittycad conversion * Inject react, add three dependencies * Working stl canvas * primer for github-like style * Loading before model * diff colors * colorMode auto * Popup clean up * clean up * Working loading * Logos * Add GitHub CI * Working test * yarn test in ci * Little tweak * Update README * component tests * Better test * Clean up * UserCard test * working caddiff test * Note * Rename App to Settings * storage test * Clean up * Clean up content script * further content cleanup * Fix test * Little tweaks to modelview * More tests and testing * Regex fix * LFS file download test * prettier config from kittycad/website * Little tweaks * comment * log level * Tweaks * README update * more prettier * comment * Irrelevant comment * No .vscode and readme update * Remove .vscode * Package.json update after vscode removal
2023-03-02 04:35:07 -05:00
Migrate away from CRA (#155) * Migrate away from CRA Fixes #128 * Add vitest * Fix github client, still issues with kittycad * Working e2e tests when kittycad.ts functions don't call node-fetch * Remove cross-fetch that was causing issues in the browser (not sure why) * Node 18, rm custom kittycad.ts, replace node-fetch * Clean up * Clean up and lint
2023-05-16 18:20:48 -04:00
The generated `build` directory may then be added to Chrome with the **Load unpacked** button at [chrome://extensions](). Background/content scripts and React views should reload as changes are made.
Minimal working version (#1) * cra boilerplate * Dummy chrome extension * eslint and working url popup * content script and dummy messaging * replace .obj diffs with dummy test * comment and in-order multiple type support * get pull api data from url * README title and desc * api/elements match with filename check * github token signin signout * manifest v3, service request for CORS * working kittycad api in service worker * First real background message * Clean up, better types * Fix settings * multiservice settings * Tweaks * WIP: download file * Working downloads and kittycad conversion * Inject react, add three dependencies * Working stl canvas * primer for github-like style * Loading before model * diff colors * colorMode auto * Popup clean up * clean up * Working loading * Logos * Add GitHub CI * Working test * yarn test in ci * Little tweak * Update README * component tests * Better test * Clean up * UserCard test * working caddiff test * Note * Rename App to Settings * storage test * Clean up * Clean up content script * further content cleanup * Fix test * Little tweaks to modelview * More tests and testing * Regex fix * LFS file download test * prettier config from kittycad/website * Little tweaks * comment * log level * Tweaks * README update * more prettier * comment * Irrelevant comment * No .vscode and readme update * Remove .vscode * Package.json update after vscode removal
2023-03-02 04:35:07 -05:00
### `yarn test`
Migrate away from CRA (#155) * Migrate away from CRA Fixes #128 * Add vitest * Fix github client, still issues with kittycad * Working e2e tests when kittycad.ts functions don't call node-fetch * Remove cross-fetch that was causing issues in the browser (not sure why) * Node 18, rm custom kittycad.ts, replace node-fetch * Clean up * Clean up and lint
2023-05-16 18:20:48 -04:00
Launches the unit tests runner in the interactive watch mode.
Minimal working version (#1) * cra boilerplate * Dummy chrome extension * eslint and working url popup * content script and dummy messaging * replace .obj diffs with dummy test * comment and in-order multiple type support * get pull api data from url * README title and desc * api/elements match with filename check * github token signin signout * manifest v3, service request for CORS * working kittycad api in service worker * First real background message * Clean up, better types * Fix settings * multiservice settings * Tweaks * WIP: download file * Working downloads and kittycad conversion * Inject react, add three dependencies * Working stl canvas * primer for github-like style * Loading before model * diff colors * colorMode auto * Popup clean up * clean up * Working loading * Logos * Add GitHub CI * Working test * yarn test in ci * Little tweak * Update README * component tests * Better test * Clean up * UserCard test * working caddiff test * Note * Rename App to Settings * storage test * Clean up * Clean up content script * further content cleanup * Fix test * Little tweaks to modelview * More tests and testing * Regex fix * LFS file download test * prettier config from kittycad/website * Little tweaks * comment * log level * Tweaks * README update * more prettier * comment * Irrelevant comment * No .vscode and readme update * Remove .vscode * Package.json update after vscode removal
2023-03-02 04:35:07 -05:00
Migrate away from CRA (#155) * Migrate away from CRA Fixes #128 * Add vitest * Fix github client, still issues with kittycad * Working e2e tests when kittycad.ts functions don't call node-fetch * Remove cross-fetch that was causing issues in the browser (not sure why) * Node 18, rm custom kittycad.ts, replace node-fetch * Clean up * Clean up and lint
2023-05-16 18:20:48 -04:00
### `yarn e2e`
Minimal working version (#1) * cra boilerplate * Dummy chrome extension * eslint and working url popup * content script and dummy messaging * replace .obj diffs with dummy test * comment and in-order multiple type support * get pull api data from url * README title and desc * api/elements match with filename check * github token signin signout * manifest v3, service request for CORS * working kittycad api in service worker * First real background message * Clean up, better types * Fix settings * multiservice settings * Tweaks * WIP: download file * Working downloads and kittycad conversion * Inject react, add three dependencies * Working stl canvas * primer for github-like style * Loading before model * diff colors * colorMode auto * Popup clean up * clean up * Working loading * Logos * Add GitHub CI * Working test * yarn test in ci * Little tweak * Update README * component tests * Better test * Clean up * UserCard test * working caddiff test * Note * Rename App to Settings * storage test * Clean up * Clean up content script * further content cleanup * Fix test * Little tweaks to modelview * More tests and testing * Regex fix * LFS file download test * prettier config from kittycad/website * Little tweaks * comment * log level * Tweaks * README update * more prettier * comment * Irrelevant comment * No .vscode and readme update * Remove .vscode * Package.json update after vscode removal
2023-03-02 04:35:07 -05:00
Migrate away from CRA (#155) * Migrate away from CRA Fixes #128 * Add vitest * Fix github client, still issues with kittycad * Working e2e tests when kittycad.ts functions don't call node-fetch * Remove cross-fetch that was causing issues in the browser (not sure why) * Node 18, rm custom kittycad.ts, replace node-fetch * Clean up * Clean up and lint
2023-05-16 18:20:48 -04:00
Builds the extension and runs end-to-end tests through an automated Chromium instance.
Improve release process (#126) Fixes #125
2023-04-26 20:11:14 -04:00
## Release a new version
1. Bump the versions in the source code by creating a new PR, committing the changes from
```bash
VERSION=x.y.z npm run bump
```
2. Merge the PR
3. Create a new release and tag pointing to the bump version commit using semantic versioning `v{x}.{y}.{z}`
A new Action should run, uploading artifacts to the release itself and to the Chrome Web Store at https://chrome.google.com/webstore/detail/kittycad-diff-viewer/gccpihmphokfjpohkmkbimnhhnlpmegp
Reference in New Issue Copy Permalink