refactor: reorganize codebase as monorepo #19
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
Convert the codebase into a monorepo, using NPM's workspaces. The packages are: - The core package (@webtoon/psd) is moved under `packages/psd/` - The browser example app, benchmark app, and Node.js example app are given their own packages under `packages/`. These packages are marked private in order to prevent accidentally publishing them. - The example apps now import @webtoon/psd using NPM's workspace support (i.e. `import "@webtoon/psd"`) instead of relative paths (i.e. `import "../../src"`). This has several benefits: - Clarify which dependencies are needed for building and testing @webtoon/psd, and which ones are needed for building the examples. - Allow us to apply different configurations for the core package and example apps in a sensible way. - Force the examples to consume @webtoon/psd as though it was installed from npmjs.com. This helps us identify bundling/deployment problems, and provides better examples for users. Other changes added in this commit: - Change the bundle name to `index.js`. This fixes issue #13 properly (better than #14, which may have caused TypeScript issues for users) - The benchmark app now has its own PSD file (`example.psd`) instead of borrowing it from the Node.js example app. - The Node.js example app uses node-dev instead of tsc-watch. - We now have two README.md and LICENSE files. The ones in the root directory are for people who visit the project repo, while the ones under `packages/psd/` are included when publishing @webtoon/psd. - Properly sort import statements in some files.
pastelmind
force-pushed
the
refactor-monorepo
branch
from
f238e6e
to
a6ac4db
Compare
pastelmind
pushed a commit
that referenced
this pull request
Jul 13, 2023
remove +1 for height and width
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.
Convert the codebase into a monorepo, using NPM's workspaces.
The packages are:
packages/psd/packages/. These packages are marked private in order to prevent accidentally publishing them.import "@webtoon/psd") instead of relative paths (i.e.import "../../src").This has several benefits:
Other changes added in this commit:
index.js. This fixes issue Package main points to missing file #13 properly (better than fix: update main and types in package.json #14, which may have caused TypeScript issues for users)example.psd) instead of borrowing it from the Node.js example app.packages/psd/are included when publishing @webtoon/psd.