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

Add check command #3

Merged
merged 3 commits into from
Jan 13, 2022
Merged

Add check command #3

merged 3 commits into from
Jan 13, 2022

Conversation

ohad83
Copy link

@ohad83 ohad83 commented Jan 12, 2022

Solve #1

Add a check command to check whether the currently generated files are up to date.

bin/index.js Outdated Show resolved Hide resolved
Copy link
Collaborator

@robinglen robinglen left a comment

Choose a reason for hiding this comment

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

Here are some comments, all small mainly for consistency but it looks good!


## Check

Check whether current generated files are up to date with the yaml file.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I wonder if its worth documenting here why you might want to use this?

Copy link
Author

Choose a reason for hiding this comment

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

Added some documentation, hope that's what you meant.

src/check-bookmarks.js Outdated Show resolved Hide resolved
@@ -3,11 +3,13 @@ import * as generateBookmarks from "./generate-bookmarks.js";
import * as saveBookmarks from "./save-bookmarks.js";
import * as mergeBookmarks from "./merge-bookmarks.js";
import * as convertBookmarks from "./convert-bookmarks.js";
import * as checkBookmarks from "./check-bookmarks.js";
Copy link
Collaborator

@robinglen robinglen Jan 12, 2022

Choose a reason for hiding this comment

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

I think we should also add this to the developer readme my to explain how the functions can be used to be consistent with other modules. Its just a quick note for people who might want to import into other projects

Copy link
Author

Choose a reason for hiding this comment

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

Added documentation.

@robinglen
Copy link
Collaborator

Looks good, thanks so much for the contribution I will merge and publish

@robinglen robinglen merged commit 35ae54e into gullwing-io:main Jan 13, 2022
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