[refactor] Re-organise project files. #107
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ayc0
reviewed
Oct 31, 2024
| @@ -15,9 +15,9 @@ jobs: | |||
| runs-on: ubuntu-latest | |||
|
|
|||
| steps: | |||
| - uses: actions/checkout@v2 | |||
| - uses: actions/checkout@v4 | |||
Ayc0
reviewed
Oct 31, 2024
| @@ -13,12 +13,17 @@ | |||
| }, | |||
| "exports": { | |||
| ".": "./src/index.ts", | |||
| "./*": "./src/*" | |||
| "./*": "./src/*.ts" | |||
Ayc0
reviewed
Oct 31, 2024
| @@ -37,4 +37,4 @@ export default { | |||
|
|
|||
| ## Configuration | |||
|
|
|||
| Check the main [README](../../README.md#configuration) for the common configuration options. | |||
| Check the main [README](/README.md#configuration) for the common configuration options. | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What and why?
Project files are a bit mis-organised.
Especially in
/packages/core/src/plugins/**, these should all move as full-fledged workspaces in/packages/plugins/*.Also, having the published bundler plugins
/packages/{bundler}-pluginat the root is noisy. They should be moved into their own directory/packages/published/{bundler}-plugin.How?
/packages/core/src/plugins/*=>/packages/plugins/*./packages/*-plugin=>/packages/published/*-plugin./packages/tests/{fixtures,jest,helpers}=>/packages/tests/_jest/*.@dd/rum-plugins=>@dd/rum-pluginfor consistency.@dd/telemetry-plugins=>@dd/telemetry-pluginfor consistency.@dd/internal-context-pluginto handle the global context.New, simpler diagram:
--- title: Datadog Build Plugins Design --- stateDiagram-v2 published: Published Packages productPlugins: Product Plugins productPlugin: @dd/{product}-plugin productPlugin2: [...] esbuildplugin: @datadog/esbuild-plugin viteplugin: @datadog/vite-plugin rollupplugin: @datadog/rollup-plugin webpackplugin: @datadog/webpack-plugin tools: @dd/tools factory: @dd/factory core: @dd/core types: Shared Types sharedHelpers: Shared Helpers sharedConstants: Shared Constants helpers: Aggregated Helpers atypes: Aggregated Types aplugins: Aggregated List of Plugins contextCreation: Creation of the Global Context cli: Internal CLIs internalPlugins: Internal Plugins buildReportPlugin: @dd/internal-build-report-plugin bundlerReportPlugin: @dd/internal-bundler-report-plugin contextPlugin: @dd/internal-context-plugin injectionPlugin: @dd/internal-injection-plugin gitPlugin: @dd/internal-git-plugin state internalPlugins { buildReportPlugin bundlerReportPlugin contextPlugin gitPlugin injectionPlugin } state core { getLogger() sharedHelpers sharedConstants types } state published { esbuildplugin viteplugin rollupplugin webpackplugin } state productPlugins { productPlugin productPlugin2 } state factory { contextCreation helpers atypes aplugins } state tools { cli } internalPlugins --> factory productPlugins --> factory: CONFIG_KEY<br/>helpers<br/>types<br/>getPlugins() core --> tools core --> factory core --> internalPlugins core --> productPlugins factory --> productPlugins: Global Context factory --> published: Unplugin Factory published --> NPM: types<br/>helpers<br/>datadogBundlerPluginCompared to previous one:
--- title: Datadog Build Plugins Design --- stateDiagram-v2 published: Published Packages plugins: Custom Plugins customplugin1: @dd/*-plugins customplugin2: @dd/*-plugins customplugin3: [...] esbuildplugin: @datadog/esbuild-plugin viteplugin: @datadog/vite-plugin rollupplugin: @datadog/rollup-plugin webpackplugin: @datadog/webpack-plugin tools: @dd/tools factory: @dd/factory core: @dd/core types: Shared Types helpers: Aggregated Helpers atypes: Aggregated Types aplugins: Aggregated List of Plugins cli: Internal CLIs internalPlugins: Internal Plugins buildReportPlugin: Build Report Plugin bundlerReportPlugin: Bundler Report Plugin injectionPlugin: Injection Plugin gitPlugin: Git Plugin state internalPlugins { buildReportPlugin bundlerReportPlugin gitPlugin injectionPlugin } state core { getLogger() types internalPlugins } state published { esbuildplugin viteplugin rollupplugin webpackplugin } state plugins { customplugin1 customplugin2 customplugin3 } state factory { helpers atypes aplugins } state tools { cli } plugins --> factory: CONFIG_KEY<br/>helpers<br/>types<br/>getPlugins() core --> tools: types core --> factory: Internal Plugins<br/>types core --> plugins: getLogger()<br/>types factory --> plugins: Global Context factory --> published: Unplugin Factory published --> NPM: types<br/>helpers<br/>datadogBundlerPlugin