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

Commander cli #47

Merged
merged 6 commits into from
Jun 24, 2024
Merged

Commander cli #47

merged 6 commits into from
Jun 24, 2024

Conversation

yoonieaj
Copy link
Collaborator

@yoonieaj yoonieaj commented Jun 21, 2024

Proposed Changes

Adopted Commander.js library for the MemoryViz CLI, and added optional --width and --height arguments to specify the width and height of SVGs generated with the CLI. This simplifies the CLI code and adds functionality.

...

Type of Change

(Write an X or a brief description next to the type or types that best describe your changes.)

Type Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change that adds functionality) X
🐛 Bug fix (non-breaking change that fixes an issue)
🎨 User interface change (change to user interface; provide screenshots)
♻️ Refactoring (internal change to codebase, without changing functionality)
🚦 Test update (change that only adds or modifies tests)
📚 Documentation update (change that only updates documentation)
📦 Dependency update (change that updates a dependency)
🔧 Internal (change that only affects developers or continuous integration)

Checklist

(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the [ ] into a [x] in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)

Before opening your pull request:

  • I have performed a self-review of my changes.
    • Check that all changed files included in this pull request are intentional changes.
    • Check that all changes are relevant to the purpose of this pull request, as described above.
  • I have added tests for my changes, if applicable.
    • This is required for all bug fixes and new features.
  • I have updated the project documentation, if applicable.
    • This is required for new features.
  • If this is my first contribution, I have added myself to the list of contributors.
  • I have updated the project Changelog (this is required for all changes).

After opening your pull request:

  • I have verified that the CI tests have passed.
  • I have reviewed the test coverage changes reported by Coveralls.
  • I have requested a review from a project maintainer.

Questions and Comments

(Include any questions or comments you have regarding your changes.)

@coveralls
Copy link
Collaborator

coveralls commented Jun 21, 2024

Pull Request Test Coverage Report for Build 9608043343

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 87.692%

Totals Coverage Status
Change from base Build 9574231615: 0.0%
Covered Lines: 388
Relevant Lines: 429

💛 - Coveralls

@yoonieaj yoonieaj marked this pull request as draft June 21, 2024 04:06
@yoonieaj yoonieaj marked this pull request as ready for review June 23, 2024 20:14
@coveralls
Copy link
Collaborator

coveralls commented Jun 23, 2024

Pull Request Test Coverage Report for Build 9636137265

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 87.692%

Totals Coverage Status
Change from base Build 9574231615: 0.0%
Covered Lines: 388
Relevant Lines: 429

💛 - Coveralls

@yoonieaj yoonieaj requested a review from david-yz-liu June 23, 2024 20:19
it("produces consistent svg when provided height and width options", (done) => {
fs.writeFileSync(filePath, input);

exec(`memory-viz ${filePath} --height=700, width=1200`, (err) => {
Copy link
Owner

Choose a reason for hiding this comment

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

There shouldn't be a comma after the 700

package.json Outdated
@@ -17,5 +17,8 @@
},
"lint-staged": {
"**/*": "prettier --write --ignore-unknown"
},
"dependencies": {
Copy link
Owner

Choose a reason for hiding this comment

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

This isn't the right place to add this; you need to add it to the memory-viz/ subpackage.

I actually realized that this is also true for the tmp dev dependency for testing. Please go ahead and fix that in this PR (i.e., remove tmp from the dev dependency list above and move it to the memory-viz/ subpackage.

@coveralls
Copy link
Collaborator

coveralls commented Jun 24, 2024

Pull Request Test Coverage Report for Build 9640526770

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 87.692%

Totals Coverage Status
Change from base Build 9574231615: 0.0%
Covered Lines: 388
Relevant Lines: 429

💛 - Coveralls

@yoonieaj yoonieaj requested a review from david-yz-liu June 24, 2024 06:21
@coveralls
Copy link
Collaborator

coveralls commented Jun 24, 2024

Pull Request Test Coverage Report for Build 9647281387

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 87.692%

Totals Coverage Status
Change from base Build 9647267380: 0.0%
Covered Lines: 388
Relevant Lines: 429

💛 - Coveralls

@david-yz-liu david-yz-liu merged commit 53769eb into david-yz-liu:master Jun 24, 2024
3 checks passed
@yoonieaj yoonieaj deleted the commander-cli branch September 17, 2024 00:41
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.

3 participants