build: refine project references #699

johnhooks · 2022-12-12T03:28:13Z

After reading an article from Shopify and how they implemented ts project references, I learned a few things I wanted to apply. It should specifically speed up VSCode, and possibly any program using the ts lsp. reference

The big suggestion from the article was that the top level tsconfig.json should be able to build the whole project, thats how VSCode will use it. I moved everything shared to a tsconfig.base.json and removed the tsconfig.declaration.json because that didn't have a purpose with a shared base between root level and leaf level tsconfig.json files. It also required a tsconfig.json inside the packages directory, and some modifications to the one in the test directory.

vercel · 2022-12-12T03:28:18Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
dinerojs	❌ Failed (Inspect)		Dec 31, 2022 at 5:56PM (UTC)

codesandbox-ci · 2022-12-12T03:29:13Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 23e4e56:

Sandbox	Source
@dinero.js/example-cart-react	Configuration
@dinero.js/example-cart-vue	Configuration
@dinero.js/example-pricing-react	Configuration
@dinero.js/example-starter	Configuration

johnhooks · 2022-12-12T04:48:22Z

.eslintrc.js

      },
    },
    {
      files: ['**/__tests__/**'],
      rules: {
        'functional/no-expression-statement': ['off'],
        'import/no-extraneous-dependencies': ['off'],
+        'import/no-named-as-default': 'off',


Fixing the project references and including project: ['./'] in .eslint.js (so it could find the tsconfig paths) must have let the eslint-plugin-import better analyze the import statements, because it started failing this import.

import Big from 'big.js`;

The rule import/no-named-as-default prefers:

import { Big } from 'big.js';

So we can change it or disable the rule.

I'd prefer fixing the imports and keeping the rule on. If there are imports that can't be fixed, we can ignore the rule locally.

I will change it.

@johnhooks This should be the last change before we can merge.

I don't know why I periodically had this error happening. But I'll look locally for the solution because it isn't in CI.

It is hard jumping between this and #667, I hadn't removed the rule as you suggested. THAT made the error come back lol.

package.json

website/pages/docs/[[...slug]].tsx

test/tsconfig.json

website/pages/docs/[[...slug]].tsx

sarahdayan

Overall it looks great to me. I'll let you handle the final comments @johnhooks and we'll be good to merge.

tsconfig.base.json

test/tsconfig.json

johnhooks · 2022-12-21T03:05:34Z

@sarahdayan I made one last edit to packages/dinero.js/src/api/__tests__/config.json. Importing test-utils in the tests was raising an ESLint import/no-unresolved error. I think some of the configOptions in package level config caused the problem. I extended tsconfig.base.json in the root directory and everything works correctly.

Edit: That actually didn't resolve the issue... I'm looking into it. Do you that error in VSCode? What is weird yarn lint doesn't flag it as a problem.

Edit 2: I walked that back, it wasn't necessary, just an issue with my setup.

sarahdayan · 2022-12-21T08:00:44Z

@johnhooks Not seeing any issue locally, and the build seems fine in CI.

johnhooks · 2022-12-21T12:30:19Z

Thanks I'll start trying to figure out what is wrong on my system and stop looking in the code.

Edit: I was from jumping between this branch and #667 and not running yarn install 🤦. The newer version of eslint-import-resolver-typescript is definitely necessary for this config to work lol.

johnhooks · 2022-12-21T12:48:01Z

There are some changes that need to happen in #667 for this to work. Once this is merged, I'll resolve them.

johnhooks · 2022-12-21T13:14:41Z

.eslintrc.js

      },
    },
    {
      files: ['**/__tests__/**'],
      rules: {
        'functional/no-expression-statement': ['off'],
        'import/no-extraneous-dependencies': ['off'],
-        'import/no-named-as-default': 'off',


@sarahdayan with was the last edit from a previous comment. To fix this ESLint issue rather than ignore it.

johnhooks · 2022-12-31T14:01:02Z

@sarahdayan I'm having some trouble with getting ESLint to recognize the paths property in tsconfig.base.json. From what I've learned, tsc can compile everything in the current mono repo structure, though it isn't the ideal setup. Ideally the tsconfig.json property rootDir would be the top of the mono repo, but that complicates outputting the files correctly into the packages/*/lib because it will add path of the rootDir to the build output location, like packages/*/lib/packages/*/lib/. There are some hacky solutions I have found, but I don't like any of them.

The simplest solution would be to create a separate packages/test-utils and then import it though the name @dinero.js/test-utils. This would import in ESLint okay because Yarn would have linked the package into node_modules and ESLint can easily find it.

Otherwise we can hold off on this. I am still learning a lot about tsconfig.json setups. I'm currently setting up a few other projects and using a different project structure.

After reading an article from Shopify and how they implemented ts project references, I learned a few things I wanted to apply. It should specifically speed up VSCode, and possibly any program using the ts lsp. [reference](https://shopify.engineering/migrating-large-typescript-codebases-project-references) build(tsc): update test:types script To use the project references the command `tsc -b` needs to be used, not `tsc --noEmit`. It will build the declarations, but will output to the lib folders in all the relevant packages, which are ignored from git build: add eslint-import-resolver-typescript

The new tsconfig file in the packages directory was causing an error because the docs route was trying to load it as a package. This fixes the issue, but not very elegantly.

johnhooks · 2022-12-31T18:24:55Z

@sarahdayan I'm going to rework this. Do you want me to close it and open it back up when it's ready?

sarahdayan · 2023-02-18T18:46:39Z

@johnhooks Yes, feel free to close and reopen when you're ready so we can keep the PR list clear 🙂

vercel bot had a problem deploying to Preview December 12, 2022 03:32 Failure

vercel bot had a problem deploying to Preview December 12, 2022 03:39 Failure

johnhooks force-pushed the build/refine-project-references branch from cfd672a to 3ef5ebb Compare December 12, 2022 04:11

vercel bot had a problem deploying to Preview December 12, 2022 04:16 Failure

johnhooks force-pushed the build/refine-project-references branch from 3ef5ebb to e12462e Compare December 12, 2022 04:38

vercel bot had a problem deploying to Preview December 12, 2022 04:42 Failure

johnhooks commented Dec 12, 2022

View reviewed changes

johnhooks force-pushed the build/refine-project-references branch from e12462e to f3019e2 Compare December 12, 2022 04:50

johnhooks commented Dec 12, 2022

View reviewed changes

package.json Show resolved Hide resolved

johnhooks force-pushed the build/refine-project-references branch from f3019e2 to 999e020 Compare December 12, 2022 04:52

vercel bot had a problem deploying to Preview December 12, 2022 04:57 Failure

johnhooks force-pushed the build/refine-project-references branch from 82559e9 to 68c84d1 Compare December 12, 2022 17:40

vercel bot had a problem deploying to Preview December 12, 2022 17:43 Failure

johnhooks commented Dec 12, 2022

View reviewed changes

website/pages/docs/[[...slug]].tsx Show resolved Hide resolved

vercel bot deployed to Preview December 12, 2022 18:16 View deployment

vercel bot deployed to Preview December 12, 2022 18:30 View deployment

johnhooks force-pushed the build/refine-project-references branch from a6a8b9b to bd9a77b Compare December 13, 2022 21:52

vercel bot deployed to Preview December 13, 2022 21:57 View deployment

johnhooks force-pushed the build/refine-project-references branch from bd9a77b to 25e2ab5 Compare December 19, 2022 13:44

vercel bot deployed to Preview December 19, 2022 13:53 View deployment

sarahdayan reviewed Dec 19, 2022

View reviewed changes

test/tsconfig.json Outdated Show resolved Hide resolved

website/pages/docs/[[...slug]].tsx Show resolved Hide resolved

sarahdayan reviewed Dec 20, 2022

View reviewed changes

tsconfig.base.json Outdated Show resolved Hide resolved

test/tsconfig.json Outdated Show resolved Hide resolved

vercel bot deployed to Preview December 21, 2022 03:05 View deployment

johnhooks force-pushed the build/refine-project-references branch from 82739f1 to 25e2ab5 Compare December 21, 2022 12:43

johnhooks commented Dec 21, 2022

View reviewed changes

vercel bot deployed to Preview December 21, 2022 13:17 View deployment

johnhooks force-pushed the build/refine-project-references branch from bfa49d9 to 79caf63 Compare December 31, 2022 13:08

vercel bot deployed to Preview December 31, 2022 13:13 View deployment

johnhooks force-pushed the build/refine-project-references branch from 79caf63 to 6933851 Compare December 31, 2022 13:38

vercel bot had a problem deploying to Preview December 31, 2022 13:38 Failure

sarahdayan force-pushed the build/refine-project-references branch from 6933851 to e92cdf6 Compare December 31, 2022 14:51

vercel bot deployed to Preview December 31, 2022 14:56 View deployment

johnhooks added 3 commits December 31, 2022 07:56

refactor: prevent docs route from loading tsconfig

4065266

The new tsconfig file in the packages directory was causing an error because the docs route was trying to load it as a package. This fixes the issue, but not very elegantly.

fix: re-enable import/no-named-as-default in tests

4a76029

johnhooks force-pushed the build/refine-project-references branch from e92cdf6 to 4a76029 Compare December 31, 2022 15:56

vercel bot deployed to Preview December 31, 2022 15:58 View deployment

build: move test-utils to package

23e4e56

vercel bot had a problem deploying to Preview December 31, 2022 17:56 Failure

johnhooks closed this Feb 18, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

build: refine project references #699

build: refine project references #699

johnhooks commented Dec 12, 2022 •

edited

vercel bot commented Dec 12, 2022 •

edited

codesandbox-ci bot commented Dec 12, 2022 •

edited

johnhooks Dec 12, 2022 •

edited

sarahdayan Dec 19, 2022

johnhooks Dec 19, 2022

sarahdayan Dec 21, 2022

johnhooks Dec 21, 2022

johnhooks Dec 21, 2022

sarahdayan left a comment

johnhooks commented Dec 21, 2022 •

edited

sarahdayan commented Dec 21, 2022 •

edited

johnhooks commented Dec 21, 2022 •

edited

johnhooks commented Dec 21, 2022 •

edited

johnhooks Dec 21, 2022

johnhooks commented Dec 31, 2022 •

edited

johnhooks commented Dec 31, 2022

sarahdayan commented Feb 18, 2023

build: refine project references #699

build: refine project references #699

Conversation

johnhooks commented Dec 12, 2022 • edited

vercel bot commented Dec 12, 2022 • edited

codesandbox-ci bot commented Dec 12, 2022 • edited

johnhooks Dec 12, 2022 • edited

Choose a reason for hiding this comment

sarahdayan Dec 19, 2022

Choose a reason for hiding this comment

johnhooks Dec 19, 2022

Choose a reason for hiding this comment

sarahdayan Dec 21, 2022

Choose a reason for hiding this comment

johnhooks Dec 21, 2022

Choose a reason for hiding this comment

johnhooks Dec 21, 2022

Choose a reason for hiding this comment

sarahdayan left a comment

Choose a reason for hiding this comment

johnhooks commented Dec 21, 2022 • edited

sarahdayan commented Dec 21, 2022 • edited

johnhooks commented Dec 21, 2022 • edited

johnhooks commented Dec 21, 2022 • edited

johnhooks Dec 21, 2022

Choose a reason for hiding this comment

johnhooks commented Dec 31, 2022 • edited

johnhooks commented Dec 31, 2022

sarahdayan commented Feb 18, 2023

johnhooks commented Dec 12, 2022 •

edited

vercel bot commented Dec 12, 2022 •

edited

codesandbox-ci bot commented Dec 12, 2022 •

edited

johnhooks Dec 12, 2022 •

edited

johnhooks commented Dec 21, 2022 •

edited

sarahdayan commented Dec 21, 2022 •

edited

johnhooks commented Dec 21, 2022 •

edited

johnhooks commented Dec 21, 2022 •

edited

johnhooks commented Dec 31, 2022 •

edited