├── .github └── workflows │ ├── release.yml │ └── test.yml ├── .gitignore ├── CHANGELOG.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── package.json ├── src ├── get-current-workspace.js ├── get-metro-android-assets-resolution-fix.js ├── get-metro-tools.js ├── get-monorepo-root.js ├── get-nohoist.js ├── get-webpack-tools.js ├── get-workspaces.js └── index.js └── yarn.lock /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release 2 | on: 3 | push: 4 | branches: 5 | - master 6 | jobs: 7 | release: 8 | name: Release 9 | runs-on: ubuntu-latest 10 | steps: 11 | - name: Checkout 12 | uses: actions/checkout@v2 13 | - name: Setup Node.js 14 | uses: actions/setup-node@v2 15 | with: 16 | node-version: '14.x' 17 | - name: Install dependencies 18 | run: yarn --pure-lockfile 19 | - name: Release 20 | env: 21 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 22 | NPM_TOKEN: ${{ secrets.NPM_TOKEN }} 23 | run: npx semantic-release -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Lint & Test 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | pull_request: 8 | branches: 9 | - master 10 | 11 | jobs: 12 | install: 13 | runs-on: ubuntu-latest 14 | name: Install 15 | steps: 16 | - uses: actions/checkout@v2 17 | - uses: actions/setup-node@v1 18 | with: 19 | node-version: '14.x' 20 | - run: yarn --pure-lockfile 21 | - uses: actions/cache@v1 22 | id: cache-build 23 | with: 24 | path: '.' 25 | key: ${{ github.sha }} 26 | 27 | test: 28 | runs-on: ubuntu-latest 29 | name: Lint 30 | needs: install 31 | steps: 32 | - uses: actions/cache@v1 33 | id: restore-build 34 | with: 35 | path: '.' 36 | key: ${{ github.sha }} 37 | - run: yarn lint -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # OSX 2 | .DS_Store 3 | 4 | # Logs 5 | logs 6 | *.log 7 | npm-debug.log* 8 | yarn-debug.log* 9 | yarn-error.log* 10 | lerna-debug.log* 11 | 12 | # Diagnostic reports (https://nodejs.org/api/report.html) 13 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 14 | 15 | # Runtime data 16 | pids 17 | *.pid 18 | *.seed 19 | *.pid.lock 20 | 21 | # Coverage 22 | lib-cov 23 | coverage 24 | *.lcov 25 | 26 | # Compiled binary addons (https://nodejs.org/api/addons.html) 27 | build/Release 28 | 29 | # Dependency directories 30 | node_modules/ 31 | jspm_packages/ 32 | 33 | # Optional npm cache directory 34 | .npm 35 | 36 | # Optional eslint cache 37 | .eslintcache 38 | 39 | # Output of 'npm pack' 40 | *.tgz 41 | 42 | # Yarn 43 | .yarn-integrity 44 | .yarn/cache 45 | .yarn/unplugged 46 | .yarn/build-state.yml 47 | .pnp.* 48 | 49 | # VSCode 50 | .vscode -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## [1.2.1](https://github.com/mmazzarolo/react-native-monorepo-tools/compare/v1.2.0...v1.2.1) (2022-12-09) 2 | 3 | 4 | ### Bug Fixes 5 | 6 | * Add support for CRACO 7 and CRA 5 ([1431875](https://github.com/mmazzarolo/react-native-monorepo-tools/commit/1431875a999ce710c3c208cc8c3544f88ad2b14f)) 7 | 8 | # [1.2.0](https://github.com/mmazzarolo/react-native-monorepo-tools/compare/v1.1.4...v1.2.0) (2022-06-24) 9 | 10 | 11 | ### Features 12 | 13 | * 🐛 support nohoist in package config ([#13](https://github.com/mmazzarolo/react-native-monorepo-tools/issues/13)) ([409c800](https://github.com/mmazzarolo/react-native-monorepo-tools/commit/409c80067cd371036efabb9e7d32bc536c9308d7)) 14 | 15 | ## [1.1.4](https://github.com/mmazzarolo/react-native-monorepo-tools/compare/v1.1.3...v1.1.4) (2021-12-31) 16 | 17 | 18 | ### Bug Fixes 19 | 20 | * Added safety check on `rule.loader` access ([#11](https://github.com/mmazzarolo/react-native-monorepo-tools/issues/11)) ([413b86f](https://github.com/mmazzarolo/react-native-monorepo-tools/commit/413b86f7d03a0f489b4f6dcac21c5d8bb6172bc1)) 21 | 22 | ## [1.1.3](https://github.com/mmazzarolo/react-native-monorepo-tools/compare/v1.1.2...v1.1.3) (2021-11-08) 23 | 24 | 25 | ### Bug Fixes 26 | 27 | * Fix error when nohoist is not defined ([#10](https://github.com/mmazzarolo/react-native-monorepo-tools/issues/10)) ([ffef661](https://github.com/mmazzarolo/react-native-monorepo-tools/commit/ffef6616dc00d57baebca57fc92bb832fdab4178)) 28 | 29 | ## [1.1.2](https://github.com/mmazzarolo/react-native-monorepo-tools/compare/v1.1.1...v1.1.2) (2021-11-07) 30 | 31 | 32 | ### Bug Fixes 33 | 34 | * Update get-workspaces to return OS specific paths ([#8](https://github.com/mmazzarolo/react-native-monorepo-tools/issues/8)) ([714fd0c](https://github.com/mmazzarolo/react-native-monorepo-tools/commit/714fd0cd6b7642a9938380212c31d0568855c433)) 35 | 36 | ## [1.1.1](https://github.com/mmazzarolo/react-native-monorepo-tools/compare/v1.1.0...v1.1.1) (2021-10-11) 37 | 38 | 39 | ### Bug Fixes 40 | 41 | * solve nohoist windows path backslash issue ([#6](https://github.com/mmazzarolo/react-native-monorepo-tools/issues/6)) ([8aa1368](https://github.com/mmazzarolo/react-native-monorepo-tools/commit/8aa13682cf5b3af67099f25666869e2a00dc00e6)) 42 | 43 | # [1.1.0](https://github.com/mmazzarolo/react-native-monorepo-tools/compare/v1.0.0...v1.1.0) (2021-09-21) 44 | 45 | 46 | ### Features 47 | 48 | * Fix previous feature release ([#4](https://github.com/mmazzarolo/react-native-monorepo-tools/issues/4)) ([e8900e8](https://github.com/mmazzarolo/react-native-monorepo-tools/commit/e8900e8b1d2c25b919909d8d2af7ed446a86f783)) 49 | 50 | # 1.0.0 (2021-09-21) 51 | 52 | 53 | ### Features 54 | 55 | * Renamed API tools and added `enableWorkspacesResolution` and `addNohoistAliases` ([ba3ff8a](https://github.com/mmazzarolo/react-native-monorepo-tools/commit/ba3ff8a7e8a043b7bec4c4a15808de9265829c4e)) 56 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | ## Development Process 4 | 5 | All work on this project happens directly on GitHub. Contributors send pull requests which go through a review process. 6 | 7 | > **Working on your first pull request?** You can learn how from this _free_ series: [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github). 8 | 9 | 1. Fork the repo and create your branch from `master` (a guide on [how to fork a repository](https://help.github.com/articles/fork-a-repo/)). 10 | 2. Run `npm install` to install all required dependencies. 11 | 3. Now you are ready to make your changes! 12 | 13 | ## Tests & Verifications 14 | 15 | Currently we use `eslint` with `prettier` for linting and formatting the code. They are run on Github Actions for all opened pull requests, but you should use them locally when making changes. 16 | 17 | - `npm run lint`: Run `eslint`. 18 | - `npm run lint:fix`: Run `eslint` and automatically fix issues. This is useful for correcting code formatting. 19 | 20 | ## Sending a pull request 21 | 22 | When you're sending a pull request: 23 | 24 | - Prefer small pull requests focused on one change. 25 | - Verify that all tests and validations are passing. 26 | - Follow the pull request template when opening a pull request. 27 | 28 | ## Commit message convention 29 | 30 | We prefix our commit messages with one of the following to signify the kind of change: 31 | 32 | - **build**: Changes that affect the build system or external dependencies. 33 | - **ci**, **chore**: Changes to our CI configuration files and scripts. 34 | - **docs**: Documentation only changes. 35 | - **feat**: A new feature. 36 | - **fix**: A bug fix. 37 | - **perf**: A code change that improves performance. 38 | - **refactor**: A code change that neither fixes a bug nor adds a feature. 39 | - **style**: Changes that do not affect the meaning of the code. 40 | - **test**: Adding missing tests or correcting existing tests. 41 | 42 | ## Release process 43 | 44 | We use [Semantic Release](http://semantic-release.org) to automatically release new versions of the library when changes are merged into master. Using the commit message convention described above, it will detect if we need to release a patch, minor, or major version of the library. 45 | 46 | ## Reporting issues 47 | 48 | You can report issues on our [bug tracker](https://github.com/mmazzarolo/react-native-monorepo-tools/issues). Please search for existing issues and follow the issue template when opening an issue. 49 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # React Native Monorepo Tools 2 | 3 | A set of tools to help you build your React Native project in a Yarn Workspaces monorepo. 4 | 5 | Check out the ["Running React Native everywhere"](https://mmazzarolo.com/blog/2021-09-11-running-react-native-everywhere/) tutorial and the [`react-native-universal-monorepo`](https://github.com/mmazzarolo/react-native-universal-monorepo) to see them in action. 6 | 7 | ## Usage 8 | 9 | Install the package using [npm](https://npmjs.com/) or [Yarn](https://yarnpkg.com/). 10 | 11 | ```bash 12 | # Using npm 13 | npm install -D react-native-monorepo-tools 14 | 15 | # Using yarn 16 | yarn add -D react-native-monorepo-tools 17 | ``` 18 | 19 | ## Tools for making React Native codebases compatible with Yarn Workspaces 20 | 21 | ### `getMetroTools(params: Object): Object` 22 | 23 | Return [Metro](https://facebook.github.io/metro/) tools to make it compatible with Yarn workspaces. 24 | 25 | #### Usage: 26 | 27 | ```js 28 | const { getMetroTools } = require("react-native-monorepo-tools"); 29 | 30 | const metroTools = getMetroTools(); 31 | 32 | console.log(metroTools.watchFolders); 33 | // ↪ [ 34 | // "/Users/me/my-monorepo/node_modules/" 35 | // "/Users/me/my-monorepo/packages/workspace-a/", 36 | // "/Users/me/my-monorepo/packages/workspace-b", 37 | // ] 38 | 39 | console.log(metroTools.blockList); 40 | // ↪ [ 41 | // /^((?!workspace-a).)*\/node_modules\/react\/.*$/, 42 | // /^((?!workspace-a).)*\/node_modules\/react-native\/.*$/, 43 | // ] 44 | 45 | console.log(metroTools.extraNodeModules); 46 | // ↪ { 47 | // "react": "/Users/me/my-monorepo/packages/workspace-a/node_modules/react", 48 | // "react-native": "/Users/me/my-monorepo/packages/workspace-a/node_modules/react-native" 49 | // } 50 | 51 | ``` 52 | 53 | #### Available params: 54 | 55 | - `cwd`: Optional. Current working directory. Defaults to `process.cwd()`. 56 | - `reactNativeAlias`: Optional. Alias for the `react-native` lib (e.g., `react-native-macos`). 57 | - `libNamesOnly`: Optional. Return the nothoist list as library names instead of paths? Defaults to `false`. 58 | 59 | #### Output: 60 | 61 | - `watchFolders`: Directories watched by metro. 62 | - `blockList`: List of regexes resolving to paths ignored by metro. 63 | - `extraNodeModules`: List of required modules outside of the workspace directory. 64 | 65 | ### `getWebpackTools(params: Object): Object` 66 | 67 | Return Webpack tools to make it compatible with Yarn workspaces. 68 | 69 | #### Usage: 70 | 71 | ```js 72 | const { getWebpackTools } = require("react-native-monorepo-tools"); 73 | const webpackConfig = require('./webpack.config.js') 74 | 75 | const webpackTools = getWebpackTools(); 76 | 77 | console.log(webpackTools.addNohoistAliases(webpackConfig)); 78 | // ↪ alias: { 79 | // "react": "/Users/me/my-monorepo/packages/workspace-a/node_modules/react" 80 | // "react-native": "/Users/me/my-monorepo/packages/workspace-a/node_modules/react-native-web" 81 | // } 82 | 83 | console.log(webpackTools.enableWorkspacesResolution(webpackConfig)); 84 | // ↪ adds to babel-loader each workspace 85 | ``` 86 | 87 | #### Available params: 88 | 89 | - `cwd`: Optional. Current working directory. Defaults to `process.cwd()`. 90 | 91 | #### Output: 92 | 93 | - `enableWorkspacesResolution(webpackConfig)`: Updates a webpack config to allow importing from external workspaces. 94 | - `addNohoistAliases(webpackConfig)`: Updates a webpack config to ensure nohoisted libraries are resolved from this workspace. 95 | 96 | ### `getMetroAndroidAssetsResolutionFix(params: Object): Object` 97 | 98 | Return the Metro Android assets resolution fix. 99 | 100 | Metro's bundler has an issue with assets resolution on Android when importing assets from paths outside of the project's root directory. 101 | To fix it, we can patch metro's `publicPath` and `enhanceMiddleware` to allow reading from `n` depths below the project directory. 102 | For more info, see this metro comment: https://github.com/facebook/metro/issues/290#issuecomment-543746458 103 | 104 | #### Usage: 105 | 106 | ```js 107 | const { 108 | getMetroAndroidAssetsResolutionFix, 109 | } = require("react-native-monorepo-tools"); 110 | 111 | const metroAndroidAssetsResolutionFix = getMetroAndroidAssetsResolutionFix(); 112 | 113 | console.log(metroAndroidAssetsResolutionFix.publicPath); 114 | // ↪ "/assets/dir/dir/dir/dir" 115 | 116 | console.log(metroAndroidAssetsResolutionFix.applyMiddleware); 117 | // ↪ Function that applies the patch middleware to metro. 118 | ``` 119 | 120 | #### Available params: 121 | 122 | - `cwd`: Optional. Current working directory. Defaults to `process.cwd()`. 123 | 124 | #### Output: 125 | 126 | - `publicPath`: Metro's `publicPath`. 127 | - `applyMiddleware`: Function that applies the patch middleware to metro. 128 | 129 | ## Additional minor utils 130 | 131 | ### `getMonorepoRoot(params: Object): string` 132 | 133 | Return the root path of this monorepo. 134 | 135 | Usage: 136 | 137 | ```js 138 | const { getMonorepoRoot } = require("react-native-monorepo-tools"); 139 | 140 | const monorepoRoot = getMonorepoRoot(); 141 | console.log(monorepoRoot); 142 | // ↪ /Users/me/my-monorepo', 143 | ``` 144 | 145 | Available params: 146 | 147 | - `cwd`: Optional. Current working directory. Defaults to `process.cwd()`. 148 | 149 | ### `getWorkspaces(params: Object): string[]` 150 | 151 | Return the workspaces of this monorepo (as paths). 152 | 153 | #### Usage: 154 | 155 | ```js 156 | const { getWorkspaces } = require("react-native-monorepo-tools"); 157 | 158 | const workspaces = getWorkspaces(); 159 | console.log(workspaces); 160 | // ↪ [ 161 | // "/Users/me/my-monorepo/packages/workspace-a", 162 | // "/Users/me/my-monorepo/packages/workspace-b", 163 | // ] 164 | ``` 165 | 166 | #### Available params: 167 | 168 | - `cwd`: Optional. Current working directory. Defaults to `process.cwd()`. 169 | 170 | ### `getCurrentWorkspace(params: Object): string` 171 | 172 | Return the current workspace path. 173 | 174 | #### Usage: 175 | 176 | ```js 177 | const { getCurrentWorkspace } = require("react-native-monorepo-tools"); 178 | 179 | const currentWorkspace = getCurrentWorkspace(); 180 | console.log(currentWorkspace); 181 | // ↪ "/Users/me/my-monorepo/packages/workspace-a" 182 | ``` 183 | 184 | ### `getNohoist(params: Object): string[]` 185 | 186 | Return the nothoist libraries of this monorepo (as paths or names). 187 | 188 | #### Usage: 189 | 190 | ```js 191 | const { getNohoist } = require("react-native-monorepo-tools"); 192 | 193 | const nohoist = getNohoist(); 194 | console.log(nohoist); 195 | // ↪ [ 196 | // "/Users/me/my-monorepo/packages/workspace-a/react", 197 | // "/Users/me/my-monorepo/packages/workspace-a/react-native", 198 | // "/Users/me/my-monorepo/packages/workspace-b/react", 199 | // "/Users/me/my-monorepo/packages/workspace-b/react-native", 200 | // ] 201 | ``` 202 | 203 | #### Available params: 204 | 205 | - `cwd`: Optional. Current working directory. Defaults to `process.cwd()`. 206 | - `currentWorkspaceOnly`: Optional. Return the nothoist list for the current workspace only? Defaults to `false`. 207 | - `libNamesOnly`: Optional. Return the nothoist list as library names instead of paths? Defaults to `false`. 208 | 209 | ## Contributing 210 | 211 | Each contribution is welcome! 212 | Please, check the [contributing guidelines](./CONTRIBUTING.md). 213 | 214 | ## License 215 | 216 | React Native Monorepo Tools is released under [AGPL-3.0 - GNU Affero General Public License v3.0](./LICENSE.md). 217 | 218 | ### Briefly: 219 | 220 | - Modification and redistribution allowed for both private and **commercial use**. 221 | - You must **grant patent rigth to the owner and to all the contributors**. 222 | - You must **keep it open source** and distribute under the **same license**. 223 | - Changes must be documented. 224 | - Include a limitation of liability and it **does not provide any warranty**. 225 | 226 | ### Warranty 227 | 228 | THIS TOOL IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. 229 | THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. 230 | For the full warranty check the [LICENSE](./LICENSE.md). 231 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "react-native-monorepo-tools", 3 | "version": "1.2.1", 4 | "description": "Tools to support a Yarn workspaces' React Native monorepo", 5 | "main": "src/index.js", 6 | "files": [ 7 | "src/" 8 | ], 9 | "keywords": [ 10 | "react", 11 | "native", 12 | "react-native", 13 | "monorepo", 14 | "yarn", 15 | "workspaces" 16 | ], 17 | "author": "Mazzarolo Matteo", 18 | "license": "AGPL-3.0", 19 | "homepage": "https://github.com/mmazzarolo/react-native-monorepo-tools", 20 | "repository": { 21 | "type": "git", 22 | "url": "https://github.com/mmazzarolo/react-native-monorepo-tools" 23 | }, 24 | "engines": { 25 | "node": ">=11.0.0" 26 | }, 27 | "scripts": { 28 | "lint": "eslint ./", 29 | "lint:fix": "yarn -- --fix", 30 | "test": "jest", 31 | "test:coverage": "yarn test -- --coverage", 32 | "test:watch": "yarn test -- --watch", 33 | "prepare": "husky install" 34 | }, 35 | "devDependencies": { 36 | "@semantic-release/changelog": "^5.0.1", 37 | "@semantic-release/git": "^9.0.1", 38 | "eslint": "^7.32.0", 39 | "eslint-config-prettier": "^8.3.0", 40 | "eslint-plugin-jest": "^24.4.2", 41 | "husky": "^7.0.2", 42 | "jest": "^27.2.0", 43 | "lint-staged": "^11.1.2", 44 | "prettier": "^2.4.1", 45 | "semantic-release": "^17.4.7" 46 | }, 47 | "eslintConfig": { 48 | "extends": [ 49 | "prettier", 50 | "eslint:recommended", 51 | "plugin:jest/recommended" 52 | ], 53 | "parserOptions": { 54 | "ecmaVersion": 9, 55 | "sourceType": "module" 56 | }, 57 | "env": { 58 | "node": true, 59 | "es6": true, 60 | "commonjs": true 61 | } 62 | }, 63 | "lint-staged": { 64 | "*.{js,jsx}": [ 65 | "yarn lint:fix" 66 | ], 67 | "*.md": [ 68 | "prettier --write" 69 | ] 70 | }, 71 | "release": { 72 | "plugins": [ 73 | "@semantic-release/commit-analyzer", 74 | "@semantic-release/release-notes-generator", 75 | "@semantic-release/npm", 76 | "@semantic-release/github", 77 | "@semantic-release/changelog", 78 | "@semantic-release/git" 79 | ] 80 | }, 81 | "dependencies": { 82 | "find-root": "^1.1.0", 83 | "glob": "^7.1.7" 84 | } 85 | } 86 | -------------------------------------------------------------------------------- /src/get-current-workspace.js: -------------------------------------------------------------------------------- 1 | const findRoot = require("find-root"); 2 | 3 | /** 4 | * Return the current workspace path. 5 | * @param {object} params - Input parameters 6 | * @param {string} [params.cwd] - Current working dir (defaults to process.cwd()). 7 | * @returns {string | undefined} Current workspace path. 8 | */ 9 | module.exports = function getCurrentWorkspace(params = {}) { 10 | const { cwd = process.cwd() } = params; 11 | return findRoot(cwd); 12 | }; 13 | -------------------------------------------------------------------------------- /src/get-metro-android-assets-resolution-fix.js: -------------------------------------------------------------------------------- 1 | // Unfortunately, there's an issue with assets resolution on android when 2 | // importing assets from paths outside of the project's root directory. 3 | // To fix it, we can patch metro's `publicPath` and `enhanceMiddleware` to 4 | // allow reading from `n` depths below the project directory. 5 | // For our use case, "4" is enough (to account for `../core/src`) but you might 6 | // wanna bump it up if you need to shuffle the assets location. 7 | // For more info, see this metro comment: 8 | // https://github.com/facebook/metro/issues/290#issuecomment-543746458 9 | 10 | /** 11 | * @typedef {Object} MetroAndroidAssetFix 12 | * @prop {string} publicPath - Metro's `publicPath`. 13 | * @prop {function} applyMiddleware - Function that applies the patch middleware to metro. 14 | */ 15 | 16 | /** 17 | * Return the Metro Android assets resolution fix. 18 | * @param {object} params - Input parameters 19 | * @param {number} [params.depth = 4] - `n` depth below the project directory. 20 | * @returns {MetroAndroidAssetFix} Metro Android assets resolution fix. 21 | */ 22 | module.exports = function getMetroAndroidAssetsResolutionFix(params = {}) { 23 | const { depth = 4 } = params; 24 | let publicPath = generateAssetsPath(depth, "dir"); 25 | const applyMiddleware = (middleware) => { 26 | return (req, res, next) => { 27 | for (let currentDepth = depth; currentDepth >= 0; currentDepth--) { 28 | const pathToReplace = generateAssetsPath(currentDepth, "dir"); 29 | const replacementPath = generateAssetsPath(depth - currentDepth, ".."); 30 | if (currentDepth === depth) { 31 | publicPath = pathToReplace; 32 | } 33 | if (req.url.startsWith(pathToReplace)) { 34 | req.url = req.url.replace(pathToReplace, replacementPath); 35 | break; 36 | } 37 | } 38 | return middleware(req, res, next); 39 | }; 40 | }; 41 | return { 42 | publicPath, 43 | applyMiddleware, 44 | }; 45 | }; 46 | 47 | function generateAssetsPath(depth, subpath) { 48 | return `/assets`.concat( 49 | Array.from({ length: depth }) 50 | .map(() => `/${subpath}`) 51 | .join("") 52 | ); 53 | } 54 | -------------------------------------------------------------------------------- /src/get-metro-tools.js: -------------------------------------------------------------------------------- 1 | const path = require("path"); 2 | const getCurrentWorkspace = require("./get-current-workspace"); 3 | const getMonorepoRoot = require("./get-monorepo-root"); 4 | const getNohoist = require("./get-nohoist"); 5 | const getWorkspaces = require("./get-workspaces"); 6 | 7 | /** 8 | * @typedef {Object} MonorepoMetroConfig 9 | * @prop {string[]} watchFolders - Directories watched by metro. 10 | * @prop {Regex[]} blockList - List of regexes resolving to paths ignored by metro. 11 | * @prop {string[]} extraNodeModules - List of required modules outside of the workspace directory. 12 | */ 13 | 14 | /** 15 | * Return Metro tools to make it compatible with Yarn workspaces. 16 | * @param {object} params - Input parameters 17 | * @param {string} [params.cwd] - Current working dir (defaults to process.cwd()). 18 | * @param {string} [params.reactNativeAlias] - Alias for the react-native lib (e.g., react-native-macos). 19 | * @returns {MonorepoMetroConfig} Metro config for this monorepo. 20 | */ 21 | module.exports = function getMetroConfig(params = {}) { 22 | const { cwd = process.cwd(), reactNativeAlias } = params; 23 | const currentWorkspace = getCurrentWorkspace({ cwd }); 24 | 25 | // extraNodeModules + blockList 26 | const currentWorkspaceName = path.basename(currentWorkspace); 27 | const nohoistLibNames = getNohoist({ 28 | cwd, 29 | currentWorkspaceOnly: true, 30 | libNamesOnly: true, 31 | }); 32 | const blockList = []; 33 | const extraNodeModules = {}; 34 | nohoistLibNames.forEach((nohoistLibName) => { 35 | extraNodeModules[nohoistLibName] = 36 | reactNativeAlias && nohoistLibName === "react-native" 37 | ? path.resolve(cwd, `./node_modules/${reactNativeAlias}`) 38 | : path.resolve(cwd, `./node_modules/${nohoistLibName}`); 39 | const regexSafeNohoistLibName = nohoistLibName.replace("/", "\\/"); 40 | blockList.push( 41 | new RegExp( 42 | `^((?!${currentWorkspaceName}).)*\\/node_modules\\/${regexSafeNohoistLibName}\\/.*$` 43 | ) 44 | ); 45 | }); 46 | 47 | // watchFolders 48 | const monorepoRoot = getMonorepoRoot({ cwd }); 49 | const watchFolders = [ 50 | path.join(monorepoRoot, "/node_modules"), 51 | ...getWorkspaces({ cwd }), 52 | ]; 53 | 54 | return { extraNodeModules, blockList, watchFolders }; 55 | }; 56 | -------------------------------------------------------------------------------- /src/get-monorepo-root.js: -------------------------------------------------------------------------------- 1 | const path = require("path"); 2 | const fs = require("fs"); 3 | const findRoot = require("find-root"); 4 | 5 | /** 6 | * Return the root's path of this monorepo. 7 | * @param {object} params - Input parameters 8 | * @param {string} [params.cwd] - Current working dir (defaults to process.cwd()). 9 | * @returns {string} Monorepo's root path. 10 | */ 11 | module.exports = function getMonorepoRoot(params = {}) { 12 | const { cwd = process.cwd() } = params; 13 | const root = findRoot(cwd, function (dir) { 14 | const packageJsonPath = path.join(dir, "package.json"); 15 | if (fs.existsSync(packageJsonPath)) { 16 | const packageJson = require(packageJsonPath); 17 | return ( 18 | packageJson.workspaces && 19 | (Array.isArray(packageJson.workspaces) || 20 | packageJson.workspaces.packages) 21 | ); 22 | } 23 | return false; 24 | }); 25 | return root; 26 | }; 27 | -------------------------------------------------------------------------------- /src/get-nohoist.js: -------------------------------------------------------------------------------- 1 | // Extract the libraries added to the "nohoist" section of the monorepo's root 2 | const path = require("path"); 3 | const glob = require("glob"); 4 | const getWorkspaces = require("./get-workspaces"); 5 | const getCurrentWorkspace = require("./get-current-workspace"); 6 | const getMonorepoRoot = require("./get-monorepo-root"); 7 | 8 | /** 9 | * Return the nothoist libraries of this monorepo (as paths or names). 10 | * @param {object} params - Input parameters 11 | * @param {string} [params.cwd] - Current working dir (defaults to process.cwd()). 12 | * @param {string} [params.currentWorkspaceOnly = false] - Limit to nohoist used in the current workspace? 13 | * @param {string} [params.libNamesOnly = false] - Return the nohoist lib names (instead of full paths)? 14 | * @returns {string[]} Nohoist libraries. 15 | */ 16 | module.exports = function getNohoist(params = {}) { 17 | const { 18 | cwd = process.cwd(), 19 | currentWorkspaceOnly = false, 20 | libNamesOnly = false, 21 | } = params; 22 | const workspaces = currentWorkspaceOnly 23 | ? [getCurrentWorkspace({ cwd })] 24 | : getWorkspaces({ cwd }); 25 | const monorepoRoot = getMonorepoRoot({ cwd }); 26 | const packageJson = require(path.join(monorepoRoot, "package.json")); 27 | const nohoistGlobs = packageJson.workspaces.nohoist || []; 28 | 29 | // Also add nohoist values of "workspaces.nohoist" of the current workspace' 30 | // package.json (if any). 31 | const currentWorkspacePackageJson = require(path.join(cwd, "package.json")); 32 | if ( 33 | currentWorkspacePackageJson && 34 | currentWorkspacePackageJson.workspaces && 35 | currentWorkspacePackageJson.workspaces.nohoist 36 | ) { 37 | nohoistGlobs.push(...currentWorkspacePackageJson.workspaces.nohoist); 38 | } 39 | 40 | return nohoistGlobs 41 | .map((nohoistGlob) => 42 | nohoistGlob.endsWith("/**") 43 | ? nohoistGlob.substring(0, nohoistGlob.lastIndexOf("/**")) 44 | : nohoistGlob 45 | ) 46 | .map((nohoistGlob) => { 47 | return workspaces.map((workspace) => { 48 | return glob 49 | .sync(`${nohoistGlob}/`, { 50 | noglobstar: true, 51 | cwd: workspace, 52 | }) 53 | .map((relativeNohoistPath) => { 54 | return path.join(workspace, relativeNohoistPath); 55 | }); 56 | }); 57 | }) 58 | .flat(2) 59 | .map((nohoistPath) => { 60 | if (process.platform === "win32" && libNamesOnly) { 61 | nohoistPath = nohoistPath.replace(/\\/g, "/"); 62 | } 63 | return libNamesOnly 64 | ? nohoistPath.substring( 65 | nohoistPath.lastIndexOf("node_modules/") + `node_modules/`.length, 66 | nohoistPath.length - 1 67 | ) 68 | : nohoistPath; 69 | }); 70 | }; 71 | -------------------------------------------------------------------------------- /src/get-webpack-tools.js: -------------------------------------------------------------------------------- 1 | const path = require("path"); 2 | const getNohoist = require("./get-nohoist"); 3 | const getWorkspaces = require("./get-workspaces"); 4 | 5 | /** 6 | * @typedef {Object} MonorepoWebpackConfig 7 | * @prop {Function} addNohoistAliases - Updates a webpack config to ensure nohoisted libraries are resolved correctly. 8 | * @prop {Function} enableWorkspacesResolution - Updates a webpack config allowing to import from external workspaces. 9 | */ 10 | 11 | /** 12 | * Return Webpack tools to make it compatible with Yarn workspaces. 13 | * @param {object} params - Input parameters 14 | * @param {string} [params.cwd] - Current working dir (defaults to process.cwd()). 15 | * @returns {MonorepoWebpackConfig} Webpack config for this monorepo. 16 | */ 17 | module.exports = function getWebpackTools(params = {}) { 18 | const { cwd = process.cwd() } = params; 19 | 20 | // Ensure nohoisted libraries are resolved from the current workspace 21 | const nohoistLibNames = getNohoist({ 22 | cwd, 23 | currentWorkspaceOnly: true, 24 | libNamesOnly: true, 25 | }); 26 | const nohoistAlias = {}; 27 | nohoistLibNames.forEach((nohoistLibName) => { 28 | nohoistAlias[nohoistLibName] = 29 | nohoistLibName === "react-native" 30 | ? path.resolve(cwd, "./node_modules/react-native-web") 31 | : path.resolve(cwd, `./node_modules/${nohoistLibName}`); 32 | }); 33 | function addNohoistAliases(webpackConfig) { 34 | webpackConfig.resolve.alias = { 35 | ...webpackConfig.resolve.alias, 36 | ...nohoistAlias, 37 | }; 38 | } 39 | 40 | // Allow importing from external workspaces. 41 | const workspaces = getWorkspaces({ cwd }); 42 | function enableWorkspacesResolution(webpackConfig) { 43 | let targetIndex = 1; 44 | if (webpackConfig.module.rules.length === 1) { 45 | targetIndex = 0; // CRACO 7 / CRA 5 has only one rule 46 | } 47 | 48 | const babelLoader = webpackConfig.module.rules[targetIndex].oneOf.find((rule) => 49 | rule.loader && rule.loader.includes("babel-loader") 50 | ); 51 | babelLoader.include = Array.isArray(babelLoader.include) 52 | ? babelLoader.include 53 | : [babelLoader.include]; 54 | for (const workspace of workspaces) { 55 | babelLoader.include.push(workspace); 56 | } 57 | } 58 | 59 | return { 60 | addNohoistAliases, 61 | enableWorkspacesResolution, 62 | alias: nohoistAlias // Deprecated 63 | }; 64 | }; 65 | -------------------------------------------------------------------------------- /src/get-workspaces.js: -------------------------------------------------------------------------------- 1 | const path = require("path"); 2 | const glob = require("glob"); 3 | const getMonorepoRoot = require("./get-monorepo-root"); 4 | 5 | /** 6 | * Return the Yarn workspaces of this monorepo (as paths). 7 | * @param {object} params - Input parameters 8 | * @param {string} [params.cwd] - Current working dir (defaults to process.cwd()). 9 | * @returns {string[]} Monorepo's Yarn workspaces. 10 | */ 11 | module.exports = function getWorkspaces(params = {}) { 12 | const { cwd = process.cwd() } = params; 13 | const monorepoRoot = getMonorepoRoot({ cwd }); 14 | const packageJson = require(path.join(monorepoRoot, "package.json")); 15 | const workspaceGlobs = Array.isArray(packageJson.workspaces) 16 | ? packageJson.workspaces 17 | : packageJson.workspaces.packages; 18 | return workspaceGlobs 19 | .map((workspaceGlob) => { 20 | return glob.sync(path.join(monorepoRoot, `${workspaceGlob}/`), { realpath: true }); 21 | }) 22 | .flat(); 23 | }; 24 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | const getMonorepoRoot = require("./get-monorepo-root"); 2 | const getWorkspaces = require("./get-workspaces"); 3 | const getNohoist = require("./get-nohoist"); 4 | const getMetroTools = require("./get-metro-tools"); 5 | const getWebpackTools = require("./get-webpack-tools"); 6 | const getMetroAndroidAssetsResolutionFix = require("./get-metro-android-assets-resolution-fix"); 7 | 8 | module.exports = { 9 | getMonorepoRoot, 10 | getWorkspaces, 11 | getNohoist, 12 | getMetroTools, 13 | getWebpackTools, 14 | getMetroConfig: getMetroTools, // Deprecated 15 | getWebpackConfig: getWebpackTools, // Deprecated 16 | getMetroAndroidAssetsResolutionFix, 17 | }; 18 | --------------------------------------------------------------------------------