[RFC][1/2] Change .oss imports from relative to absolute + lint rule disallowing relative import of .oss modules + remove InjectedComponentContext.
#23417
Conversation
|
Deploy preview for dagit-core-storybook ready! ✅ Preview Built with commit d1fa335. |
| @@ -78,6 +78,7 @@ module.exports = { | |||
| '\\.(css|less)$': 'identity-obj-proxy', | |||
| '^worker-loader(.*)/workers/(.*)$': '<rootDir>/jest/mocks/$2', | |||
| '^@dagster-io/ui-components$': '<rootDir>/../ui-components/src/index', | |||
| '^src/(.*)$': '<rootDir>/src/$1', | |||
There was a problem hiding this comment.
What if we create an empty shared directory in the codebase, move the custom tsconfig.json file in there, and map shared to the appropriate src directory?
We'd essentially require that you explicitly import .oss.tsx files from the "shared" path? Remapping a random+specific name like shared seems a bit less confusing than overriding src? Curious what you think
There was a problem hiding this comment.
I feel like src makes sense because the folder actually exists. But the concern about using an absolute path in some cases vs relative path in others being confusing is legit... so maybe making the import statement more special is justified... One nice thing about "src/..." is that autocomplete works.
Summary & Motivation
We are moving from a run time solution for injecting dependencies into OSS to a compile/build time solution.
The way our solution works is by using typescript
pathsin order to override.oss.tsxfiles with their.cloud.tsxcounterpart of the same name. However, typescript paths doesn't work with relative paths, only absolute paths, so to make sure our.ossmodules are imported as absolute paths I added a lint rule with an auto-fixer (which I used to update all these imports).How I Tested These Changes
yarn lint --fixyarn ts