Refactor package directories #1265
Merged
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
acjh
reviewed
Jun 28, 2020
ang-zeyu
force-pushed
the
refactor-package-directories
branch
3 times, most recently
from
bdc4a59 to
f5ed7fe
Compare
acjh
reviewed
Jun 30, 2020
acjh
approved these changes
Jun 30, 2020
@markbind/core's uses markbind-cli's logging utilities, which implies it cannot function on its own. The default logger instance as provided by winston and configured in @markbind/core also includes the DailyRotateFile transport. This causes unit tests for @markbind/core files that also mock the node fs module to fail, since it is a file-based transport. Let's restructure the logging slightly, providing @markbind/core with it's own winston configuration without the DailyRotateFile transport. Let's also increase the logging level of the console transport to 'debug', which was previously handled by the DailyRotateFile transport. This ensures unit tests function properly, and allows @markbind/core to function on its own. Then, let's override this configuration in markbind-cli's configuration, such that the old behaviour from a user standpoint is preserved.
ang-zeyu
force-pushed
the
refactor-package-directories
branch
from
b5d3eaa to
9d89140
Compare
|
Thanks for the review @acjh! Fyi: Added |
This was referenced Aug 7, 2020
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.
What is the purpose of this pull request? (put "X" next to an item, remove the rest)
• [x] Other, please explain: move sub packages to
packages/directoryImplements #1253 (comment)
Fixes #1060
What is the rationale for this request?
Standardise location of sub packages
What changes did you make? (Give an overview)
Move markbind core package to
packages/markbind(preserved instead ofcoreas we reference "themarkbindcore package..." quite a few times in docs)Move frontend/components package to
packages/vue-componentsUse scoped package naming
@markbind/core&@markbind/vue-componentsChanged the respective path references in linting configurations,
requires,package.jsonand the dev guide for the aboveProposed commit message: (wrap lines at 72 characters)
Move sub packages into /packages/ directory
The markbind core package resides in /src/lib/markbind/ directory of
the markbind-cli package, while the vue components package resides in
frontend/components.
Let's move these into /packages/ for consistent placing of
markbind-cli's dependencies.
Let's also rename the packages as scoped packages to reflect the new
directory structure.