diff options
Diffstat (limited to 'packages/turbo-utils')
29 files changed, 980 insertions, 0 deletions
diff --git a/packages/turbo-utils/LICENSE b/packages/turbo-utils/LICENSE new file mode 100644 index 0000000..fa0086a --- /dev/null +++ b/packages/turbo-utils/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0.
\ No newline at end of file diff --git a/packages/turbo-utils/README.md b/packages/turbo-utils/README.md new file mode 100644 index 0000000..7eb2bad --- /dev/null +++ b/packages/turbo-utils/README.md @@ -0,0 +1,3 @@ +# `@turbo/utils` + +Internal package of generic utilities shared between [turborepo/packages/](https://github.com/vercel/turbo/tree/main/packages) diff --git a/packages/turbo-utils/__fixtures__/common/single-package/child/child.js b/packages/turbo-utils/__fixtures__/common/single-package/child/child.js new file mode 100644 index 0000000..9e799a2 --- /dev/null +++ b/packages/turbo-utils/__fixtures__/common/single-package/child/child.js @@ -0,0 +1,2 @@ +process.env.NONEXISTENT; +process.env.CI; diff --git a/packages/turbo-utils/__fixtures__/common/single-package/package.json b/packages/turbo-utils/__fixtures__/common/single-package/package.json new file mode 100644 index 0000000..b2a0927 --- /dev/null +++ b/packages/turbo-utils/__fixtures__/common/single-package/package.json @@ -0,0 +1,3 @@ +{ + "name": "single-package" +} diff --git a/packages/turbo-utils/__fixtures__/common/single-package/turbo.json b/packages/turbo-utils/__fixtures__/common/single-package/turbo.json new file mode 100644 index 0000000..8079eb2 --- /dev/null +++ b/packages/turbo-utils/__fixtures__/common/single-package/turbo.json @@ -0,0 +1,34 @@ +{ + "$schema": "https://turbo.build/schema.json", + "globalEnv": ["UNORDERED", "CI"], + "pipeline": { + "build": { + // A workspace's `build` task depends on that workspace's + // topological dependencies' and devDependencies' + // `build` tasks being completed first. The `^` symbol + // indicates an upstream dependency. + "dependsOn": ["^build"] + }, + "test": { + // A workspace's `test` task depends on that workspace's + // own `build` task being completed first. + "dependsOn": ["build"], + "outputs": [], + // A workspace's `test` task should only be rerun when + // either a `.tsx` or `.ts` file has changed. + "inputs": ["src/**/*.tsx", "src/**/*.ts", "test/**/*.ts", "test/**/*.tsx"] + }, + "lint": { + // A workspace's `lint` task has no dependencies and + // can be run whenever. + "outputs": [] + }, + "deploy": { + // A workspace's `deploy` task depends on the `build`, + // `test`, and `lint` tasks of the same workspace + // being completed. + "dependsOn": ["build", "test", "lint"], + "outputs": [] + } + } +} diff --git a/packages/turbo-utils/__fixtures__/common/workspace-configs/apps/docs/index.js b/packages/turbo-utils/__fixtures__/common/workspace-configs/apps/docs/index.js new file mode 100644 index 0000000..5030114 --- /dev/null +++ b/packages/turbo-utils/__fixtures__/common/workspace-configs/apps/docs/index.js @@ -0,0 +1,6 @@ +export default function docs() { + if (!process.env.ENV_1) { + return "bar"; + } + return "foo"; +} diff --git a/packages/turbo-utils/__fixtures__/common/workspace-configs/apps/docs/package.json b/packages/turbo-utils/__fixtures__/common/workspace-configs/apps/docs/package.json new file mode 100644 index 0000000..82f9a44 --- /dev/null +++ b/packages/turbo-utils/__fixtures__/common/workspace-configs/apps/docs/package.json @@ -0,0 +1,4 @@ +{ + "name": "docs", + "version": "1.0.0" +} diff --git a/packages/turbo-utils/__fixtures__/common/workspace-configs/apps/web/index.js b/packages/turbo-utils/__fixtures__/common/workspace-configs/apps/web/index.js new file mode 100644 index 0000000..bfd3ab8 --- /dev/null +++ b/packages/turbo-utils/__fixtures__/common/workspace-configs/apps/web/index.js @@ -0,0 +1,6 @@ +export default function web() { + if (!process.env.ENV_2) { + return "bar"; + } + return "foo"; +} diff --git a/packages/turbo-utils/__fixtures__/common/workspace-configs/apps/web/package.json b/packages/turbo-utils/__fixtures__/common/workspace-configs/apps/web/package.json new file mode 100644 index 0000000..d8a83ed --- /dev/null +++ b/packages/turbo-utils/__fixtures__/common/workspace-configs/apps/web/package.json @@ -0,0 +1,4 @@ +{ + "name": "web", + "version": "1.0.0" +} diff --git a/packages/turbo-utils/__fixtures__/common/workspace-configs/apps/web/turbo.json b/packages/turbo-utils/__fixtures__/common/workspace-configs/apps/web/turbo.json new file mode 100644 index 0000000..0d1b80f --- /dev/null +++ b/packages/turbo-utils/__fixtures__/common/workspace-configs/apps/web/turbo.json @@ -0,0 +1,9 @@ +{ + "$schema": "https://turbo.build/schema.json", + "extends": ["//"], + "pipeline": { + "build": { + "env": ["ENV_2"] + } + } +} diff --git a/packages/turbo-utils/__fixtures__/common/workspace-configs/package.json b/packages/turbo-utils/__fixtures__/common/workspace-configs/package.json new file mode 100644 index 0000000..c6616a6 --- /dev/null +++ b/packages/turbo-utils/__fixtures__/common/workspace-configs/package.json @@ -0,0 +1,14 @@ +{ + "private": true, + "workspaces": [ + "apps/*", + "packages/*" + ], + "scripts": { + "build": "turbo run build" + }, + "devDependencies": { + "turbo": "latest" + }, + "packageManager": "yarn@1.22.19" +} diff --git a/packages/turbo-utils/__fixtures__/common/workspace-configs/packages/ui/index.js b/packages/turbo-utils/__fixtures__/common/workspace-configs/packages/ui/index.js new file mode 100644 index 0000000..dee5e80 --- /dev/null +++ b/packages/turbo-utils/__fixtures__/common/workspace-configs/packages/ui/index.js @@ -0,0 +1,6 @@ +export default function foo() { + if (!process.env.IS_SERVER) { + return "bar"; + } + return "foo"; +} diff --git a/packages/turbo-utils/__fixtures__/common/workspace-configs/packages/ui/package.json b/packages/turbo-utils/__fixtures__/common/workspace-configs/packages/ui/package.json new file mode 100644 index 0000000..7cb7cf1 --- /dev/null +++ b/packages/turbo-utils/__fixtures__/common/workspace-configs/packages/ui/package.json @@ -0,0 +1,4 @@ +{ + "name": "ui", + "version": "1.0.0" +} diff --git a/packages/turbo-utils/__fixtures__/common/workspace-configs/packages/ui/turbo.json b/packages/turbo-utils/__fixtures__/common/workspace-configs/packages/ui/turbo.json new file mode 100644 index 0000000..8bff09e --- /dev/null +++ b/packages/turbo-utils/__fixtures__/common/workspace-configs/packages/ui/turbo.json @@ -0,0 +1,9 @@ +{ + "$schema": "https://turbo.build/schema.json", + "extends": ["//"], + "pipeline": { + "build": { + "env": ["IS_SERVER"] + } + } +} diff --git a/packages/turbo-utils/__fixtures__/common/workspace-configs/packages/utils/index.js b/packages/turbo-utils/__fixtures__/common/workspace-configs/packages/utils/index.js new file mode 100644 index 0000000..dee5e80 --- /dev/null +++ b/packages/turbo-utils/__fixtures__/common/workspace-configs/packages/utils/index.js @@ -0,0 +1,6 @@ +export default function foo() { + if (!process.env.IS_SERVER) { + return "bar"; + } + return "foo"; +} diff --git a/packages/turbo-utils/__fixtures__/common/workspace-configs/packages/utils/package.json b/packages/turbo-utils/__fixtures__/common/workspace-configs/packages/utils/package.json new file mode 100644 index 0000000..39308ba --- /dev/null +++ b/packages/turbo-utils/__fixtures__/common/workspace-configs/packages/utils/package.json @@ -0,0 +1,4 @@ +{ + "name": "utils", + "version": "1.0.0" +} diff --git a/packages/turbo-utils/__fixtures__/common/workspace-configs/packages/utils/turbo.json b/packages/turbo-utils/__fixtures__/common/workspace-configs/packages/utils/turbo.json new file mode 100644 index 0000000..fcb2aa7 --- /dev/null +++ b/packages/turbo-utils/__fixtures__/common/workspace-configs/packages/utils/turbo.json @@ -0,0 +1,9 @@ +{ + "$schema": "https://turbo.build/schema.json", + // invalid config - missing extends + "pipeline": { + "build": { + "env": ["IS_SERVER"] + } + } +} diff --git a/packages/turbo-utils/__fixtures__/common/workspace-configs/turbo.json b/packages/turbo-utils/__fixtures__/common/workspace-configs/turbo.json new file mode 100644 index 0000000..cb4fb20 --- /dev/null +++ b/packages/turbo-utils/__fixtures__/common/workspace-configs/turbo.json @@ -0,0 +1,9 @@ +{ + "$schema": "https://turbo.build/schema.json", + "globalEnv": ["CI"], + "pipeline": { + "build": { + "env": ["ENV_1"] + } + } +} diff --git a/packages/turbo-utils/__tests__/getTurboConfigs.test.ts b/packages/turbo-utils/__tests__/getTurboConfigs.test.ts new file mode 100644 index 0000000..e61e630 --- /dev/null +++ b/packages/turbo-utils/__tests__/getTurboConfigs.test.ts @@ -0,0 +1,112 @@ +import path from "path"; +import getTurboConfigs from "../src/getTurboConfigs"; +import { setupTestFixtures } from "@turbo/test-utils"; + +describe("getTurboConfigs", () => { + const { useFixture } = setupTestFixtures({ + directory: path.join(__dirname, "../"), + test: "common", + }); + + it("single-package", async () => { + const { root } = useFixture({ fixture: `single-package` }); + const configs = getTurboConfigs(root); + expect(configs).toHaveLength(1); + expect(configs[0].isRootConfig).toBe(true); + expect(configs[0].config).toMatchInlineSnapshot(` + Object { + "$schema": "https://turbo.build/schema.json", + "globalEnv": Array [ + "UNORDERED", + "CI", + ], + "pipeline": Object { + "build": Object { + "dependsOn": Array [ + "^build", + ], + }, + "deploy": Object { + "dependsOn": Array [ + "build", + "test", + "lint", + ], + "outputs": Array [], + }, + "lint": Object { + "outputs": Array [], + }, + "test": Object { + "dependsOn": Array [ + "build", + ], + "inputs": Array [ + "src/**/*.tsx", + "src/**/*.ts", + "test/**/*.ts", + "test/**/*.tsx", + ], + "outputs": Array [], + }, + }, + } + `); + }); + + it("workspace-configs", async () => { + const { root } = useFixture({ fixture: `workspace-configs` }); + const configs = getTurboConfigs(root); + + expect(configs).toHaveLength(3); + expect(configs[0].isRootConfig).toBe(true); + expect(configs[0].config).toMatchInlineSnapshot(` + Object { + "$schema": "https://turbo.build/schema.json", + "globalEnv": Array [ + "CI", + ], + "pipeline": Object { + "build": Object { + "env": Array [ + "ENV_1", + ], + }, + }, + } + `); + expect(configs[1].isRootConfig).toBe(false); + expect(configs[1].config).toMatchInlineSnapshot(` + Object { + "$schema": "https://turbo.build/schema.json", + "extends": Array [ + "//", + ], + "pipeline": Object { + "build": Object { + "env": Array [ + "ENV_2", + ], + }, + }, + } + `); + + expect(configs[2].isRootConfig).toBe(false); + expect(configs[2].config).toMatchInlineSnapshot(` + Object { + "$schema": "https://turbo.build/schema.json", + "extends": Array [ + "//", + ], + "pipeline": Object { + "build": Object { + "env": Array [ + "IS_SERVER", + ], + }, + }, + } + `); + }); +}); diff --git a/packages/turbo-utils/__tests__/getTurboRoot.test.ts b/packages/turbo-utils/__tests__/getTurboRoot.test.ts new file mode 100644 index 0000000..acfb0ce --- /dev/null +++ b/packages/turbo-utils/__tests__/getTurboRoot.test.ts @@ -0,0 +1,33 @@ +import path from "path"; +import getTurboRoot from "../src/getTurboRoot"; +import { setupTestFixtures } from "@turbo/test-utils"; + +describe("getTurboConfigs", () => { + const { useFixture } = setupTestFixtures({ + directory: path.join(__dirname, "../"), + test: "common", + }); + + test.each([[""], ["child"]])( + "finds the root in a non-monorepo (%s)", + (repoPath) => { + const { root } = useFixture({ fixture: `single-package` }); + const turboRoot = getTurboRoot(path.join(root, repoPath)); + expect(turboRoot).toEqual(root); + } + ); + + test.each([ + [""], + ["apps"], + ["apps/docs"], + ["apps/web"], + ["packages"], + ["packages/ui"], + ["not-a-real/path"], + ])("finds the root in a monorepo with workspace configs (%s)", (repoPath) => { + const { root } = useFixture({ fixture: `workspace-configs` }); + const turboRoot = getTurboRoot(path.join(root, repoPath)); + expect(turboRoot).toEqual(root); + }); +}); diff --git a/packages/turbo-utils/jest.config.js b/packages/turbo-utils/jest.config.js new file mode 100644 index 0000000..bbe7825 --- /dev/null +++ b/packages/turbo-utils/jest.config.js @@ -0,0 +1,7 @@ +/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */ +module.exports = { + preset: "ts-jest/presets/js-with-ts", + testEnvironment: "node", + modulePathIgnorePatterns: ["<rootDir>/node_modules", "<rootDir>/dist"], + transformIgnorePatterns: ["/node_modules/(?!(ansi-regex)/)"], +}; diff --git a/packages/turbo-utils/package.json b/packages/turbo-utils/package.json new file mode 100644 index 0000000..fdaf5f2 --- /dev/null +++ b/packages/turbo-utils/package.json @@ -0,0 +1,45 @@ +{ + "name": "@turbo/utils", + "version": "0.0.0", + "private": true, + "description": "", + "homepage": "https://turbo.build/repo", + "keywords": [], + "author": "Vercel", + "license": "MPL-2.0", + "repository": { + "type": "git", + "url": "https://github.com/vercel/turbo", + "directory": "packages/turbo-utils" + }, + "bugs": { + "url": "https://github.com/vercel/turbo/issues" + }, + "module": "dist/index.mjs", + "main": "dist/index.js", + "types": "dist/index.d.ts", + "scripts": { + "build": "tsup", + "test": "jest", + "lint": "eslint src/**/*.ts", + "check-types": "tsc --noEmit" + }, + "devDependencies": { + "@manypkg/find-root": "^1.1.0", + "@types/jest": "^27.4.0", + "@types/js-yaml": "^4.0.5", + "@types/node": "^16.11.12", + "eslint": "^8.23.0", + "execa": "5.1.1", + "fast-glob": "^3.2.12", + "jest": "^27.4.3", + "js-yaml": "^4.1.0", + "json5": "^2.2.3", + "ts-jest": "^27.1.1", + "@turbo/tsconfig": "workspace:*", + "tsup": "^5.12.1", + "@turbo/test-utils": "workspace:*", + "@turbo/types": "workspace:*", + "typescript": "^4.7.4" + } +} diff --git a/packages/turbo-utils/src/getTurboConfigs.ts b/packages/turbo-utils/src/getTurboConfigs.ts new file mode 100644 index 0000000..df15a56 --- /dev/null +++ b/packages/turbo-utils/src/getTurboConfigs.ts @@ -0,0 +1,106 @@ +import fs from "fs"; +import path from "path"; +import getTurboRoot from "./getTurboRoot"; +import yaml from "js-yaml"; +import { sync } from "fast-glob"; +import { Schema } from "@turbo/types"; +import JSON5 from "json5"; + +const ROOT_GLOB = "turbo.json"; + +export type TurboConfigs = Array<{ + config: Schema; + turboConfigPath: string; + workspacePath: string; + isRootConfig: boolean; +}>; + +interface Options { + cache?: boolean; +} + +const configsCache: Record<string, TurboConfigs> = {}; + +// A quick and dirty workspace parser +// TODO: after @turbo/workspace-convert is merged, we can leverage those utils here +function getWorkspaceGlobs(root: string): Array<string> { + try { + if (fs.existsSync(path.join(root, "pnpm-workspace.yaml"))) { + const workspaceConfig = yaml.load( + fs.readFileSync(path.join(root, "pnpm-workspace.yaml"), "utf8") + ) as Record<"packages", Array<string>>; + + return workspaceConfig?.packages || []; + } else { + const packageJson = JSON.parse( + fs.readFileSync(path.join(root, "package.json"), "utf8") + ); + return packageJson?.workspaces || []; + } + } catch (e) { + return []; + } +} + +function getTurboConfigs(cwd?: string, opts?: Options): TurboConfigs { + const turboRoot = getTurboRoot(cwd, opts); + const configs: TurboConfigs = []; + + const cacheEnabled = opts?.cache ?? true; + if (cacheEnabled && cwd && configsCache[cwd]) { + return configsCache[cwd]; + } + + // parse workspaces + if (turboRoot) { + const workspaceGlobs = getWorkspaceGlobs(turboRoot); + const workspaceConfigGlobs = workspaceGlobs.map( + (glob) => `${glob}/turbo.json` + ); + + const configPaths = sync([ROOT_GLOB, ...workspaceConfigGlobs], { + cwd: turboRoot, + onlyFiles: true, + followSymbolicLinks: false, + // avoid throwing when encountering permission errors or unreadable paths + suppressErrors: true, + }).map((configPath) => path.join(turboRoot, configPath)); + + configPaths.forEach((configPath) => { + try { + const raw = fs.readFileSync(configPath, "utf8"); + const turboJsonContent: Schema = JSON5.parse(raw); + // basic config validation + let isRootConfig = path.dirname(configPath) === turboRoot; + if (isRootConfig) { + // invalid - root config with extends + if ("extends" in turboJsonContent) { + return; + } + } else { + // invalid - workspace config with no extends + if (!("extends" in turboJsonContent)) { + return; + } + } + configs.push({ + config: turboJsonContent, + turboConfigPath: configPath, + workspacePath: path.dirname(configPath), + isRootConfig, + }); + } catch (e) { + // if we can't read or parse the config, just ignore it with a warning + console.warn(e); + } + }); + } + + if (cacheEnabled && cwd) { + configsCache[cwd] = configs; + } + + return configs; +} + +export default getTurboConfigs; diff --git a/packages/turbo-utils/src/getTurboRoot.ts b/packages/turbo-utils/src/getTurboRoot.ts new file mode 100644 index 0000000..64a37be --- /dev/null +++ b/packages/turbo-utils/src/getTurboRoot.ts @@ -0,0 +1,49 @@ +import { findRootSync } from "@manypkg/find-root"; +import searchUp from "./searchUp"; +import JSON5 from "json5"; + +interface Options { + cache?: boolean; +} + +function contentCheck(content: string): boolean { + const result = JSON5.parse(content); + return !result.extends; +} + +const configCache: Record<string, string> = {}; + +function getTurboRoot(cwd?: string, opts?: Options): string | null { + const cacheEnabled = opts?.cache ?? true; + const currentDir = cwd || process.cwd(); + + if (cacheEnabled && configCache[currentDir]) { + return configCache[currentDir]; + } + + // Turborepo root can be determined by a turbo.json without an extends key + let root = searchUp({ + target: "turbo.json", + cwd: currentDir, + contentCheck, + }); + + if (!root) { + try { + root = findRootSync(currentDir); + if (!root) { + return null; + } + } catch (err) { + return null; + } + } + + if (cacheEnabled) { + configCache[currentDir] = root; + } + + return root; +} + +export default getTurboRoot; diff --git a/packages/turbo-utils/src/index.ts b/packages/turbo-utils/src/index.ts new file mode 100644 index 0000000..2d86559 --- /dev/null +++ b/packages/turbo-utils/src/index.ts @@ -0,0 +1,8 @@ +// utils +export { default as getTurboRoot } from "./getTurboRoot"; +export { default as getTurboConfigs } from "./getTurboConfigs"; +export { default as searchUp } from "./searchUp"; +export { getAvailablePackageManagers } from "./managers"; + +// types +export type { PackageManagerAvailable } from "./managers"; diff --git a/packages/turbo-utils/src/managers.ts b/packages/turbo-utils/src/managers.ts new file mode 100644 index 0000000..ab9c53d --- /dev/null +++ b/packages/turbo-utils/src/managers.ts @@ -0,0 +1,53 @@ +import execa from "execa"; +import os from "os"; + +export type PackageManager = "npm" | "yarn" | "pnpm"; +export type PackageManagerAvailable = { available: boolean; version?: string }; + +async function getVersion( + packageManager: string +): Promise<PackageManagerAvailable> { + // run the check from tmpdir to avoid corepack conflicting - + // this is no longer needed as of https://github.com/nodejs/corepack/pull/167 + // but we'll keep the behavior for those on older versions) + const execOptions = { + cwd: os.tmpdir(), + env: { COREPACK_ENABLE_STRICT: "0" }, + }; + + let available = false; + try { + const userAgent = process.env.npm_config_user_agent; + if (userAgent && userAgent.startsWith(packageManager)) { + available = true; + } + + const result = await execa(packageManager, ["--version"], execOptions); + return { + available: true, + version: result.stdout.trim(), + }; + } catch (e) { + return { + available, + }; + } +} + +async function getAvailablePackageManagers(): Promise< + Record<PackageManager, PackageManagerAvailable> +> { + const [yarn, npm, pnpm] = await Promise.all([ + getVersion("yarnpkg"), + getVersion("npm"), + getVersion("pnpm"), + ]); + + return { + yarn, + pnpm, + npm, + }; +} + +export { getAvailablePackageManagers }; diff --git a/packages/turbo-utils/src/searchUp.ts b/packages/turbo-utils/src/searchUp.ts new file mode 100644 index 0000000..57f92e4 --- /dev/null +++ b/packages/turbo-utils/src/searchUp.ts @@ -0,0 +1,44 @@ +import fs from "fs"; +import path from "path"; + +function searchUp({ + target, + cwd, + contentCheck, +}: { + target: string; + cwd: string; + contentCheck?: (content: string) => boolean; +}): string | null { + const root = path.parse(cwd).root; + + let found = false; + while (!found && cwd !== root) { + if (contentCheck) { + try { + const content = fs.readFileSync(path.join(cwd, target)).toString(); + if (contentCheck(content)) { + found = true; + break; + } + } catch { + // keep looking + } + } else { + if (fs.existsSync(path.join(cwd, target))) { + found = true; + break; + } + } + + cwd = path.dirname(cwd); + } + + if (found) { + return cwd; + } + + return null; +} + +export default searchUp; diff --git a/packages/turbo-utils/tsconfig.json b/packages/turbo-utils/tsconfig.json new file mode 100644 index 0000000..0620a3c --- /dev/null +++ b/packages/turbo-utils/tsconfig.json @@ -0,0 +1,6 @@ +{ + "extends": "@turbo/tsconfig/library.json", + "compilerOptions": { + "rootDir": "." + } +} diff --git a/packages/turbo-utils/tsup.config.ts b/packages/turbo-utils/tsup.config.ts new file mode 100644 index 0000000..716b7a5 --- /dev/null +++ b/packages/turbo-utils/tsup.config.ts @@ -0,0 +1,12 @@ +import { defineConfig, Options } from "tsup"; + +export default defineConfig((options: Options) => ({ + entry: ["src/**/*.ts"], + treeshake: true, + splitting: true, + format: ["esm", "cjs"], + dts: true, + minify: true, + clean: true, + ...options, +})); |