feat!: restructure tools entry points

Instead of publishing tools separately as /config and /tools/dist, unify
the tsc builds so that everything ends up in /dist.

BREAKING CHANGE: consuming apps need to modify their imports
accordingly.

Co-authored-by: ChatGPT 5.2 <noreply@openai.com>

Author: arbrandes

.gitignore

@@ -2,8 +2,8 @@ node_modules
 npm-debug.log
 coverage
 module.config.js
+/.tsbuildinfo.*
 dist/
-/config
 scss
 docs/api
 

Makefile

@@ -10,23 +10,13 @@ transifex_temp = ./temp/babel-plugin-formatjs
 doc_command = ./node_modules/.bin/documentation build src -g -c ./docs/documentation.config.yml -f md -o ./docs/_API-body.md --sort-order alpha
 cat_docs_command = cat ./docs/_API-header.md ./docs/_API-body.md > ./docs/API.md
 
-build:
-	rm -rf ./config ./tools/dist ./dist
+clean:
+	rm -rf dist .tsbuildinfo.*
+
+build: clean
 	tsc --project ./tsconfig.json
-	tsc --project ./tsconfig.build.json
-	mkdir -p ./dist/shell
+	tsc --build ./tsconfig.build.json
 	cp ./shell/app.scss ./dist/shell/app.scss
-	mkdir -p ./config
-	cp tools/typescript/tsconfig.json config/tsconfig.json
-	tsc --project ./tools/tsconfig.json
-	cp -prf ./tools/dist/config-helpers ./config/config-helpers
-	cp -prf ./tools/dist/defaultConfigPaths.js ./config/defaultConfigPaths.js
-	cp -prf ./tools/dist/types.js ./config/types.js
-	cp -prf ./tools/dist/eslint ./config/eslint
-	cp -prf ./tools/dist/jest ./config/jest
-	cp -prf ./tools/dist/webpack ./config/webpack
-	cp -prf ./tools/dist/babel ./config/babel
-	cp -prf ./tools/dist/index.js ./config/index.js
 
 docs-build:
 	${doc_command}

docs/how_tos/migrate-frontend-app.md

@@ -128,7 +128,7 @@ With the exception of any custom scripts, replace the `scripts` section of your
 
 ```json
   "scripts": {
-    "build": "tsc --project tsconfig.build.json && tsc-alias -p tsconfig.build.json",
+    "build": "make build",
     "dev": "PORT=YOUR_PORT PUBLIC_PATH=/YOUR_APP_NAME openedx dev",
     "i18n_extract": "openedx formatjs extract",
     "lint": "openedx lint .",
@@ -138,12 +138,25 @@ With the exception of any custom scripts, replace the `scripts` section of your
   },
 ```
 
-The `build` script compiles TypeScript to JavaScript and uses `tsc-alias` to rewrite `@src` path aliases to relative paths. You'll need to install `tsc-alias` as a dev dependency:
+The `build` script invokes a Makefile target. You'll need to install `tsc-alias` as a dev dependency:
 
 ```sh
 npm install --save-dev tsc-alias
 ```
 
+Then add a `build:` target to your `Makefile`:
+
+```makefile
+build:
+	tsc --project tsconfig.build.json
+	tsc-alias -p tsconfig.build.json
+	find src -name '*.scss' -exec cp --parents {} dist/ \;
+	mv dist/src/* dist/
+	rmdir dist/src
+```
+
+This target compiles TypeScript to JavaScript, uses `tsc-alias` to rewrite `@src` path aliases to relative paths, and copies all SCSS files from `src/` into `dist/` preserving directory structure.
+
 - Replace `YOUR_PORT` with the desired port, of course.
 - Replace  `YOUR_APP_NAME` with the basename used on your site.config, not doing this will result in only the root route working.
 - Note that `fedx-scripts` no longer exists, and has been replaced with `openedx`.
@@ -185,8 +198,8 @@ This means that the code from the library can be safely tree-shaken by webpack.
 
 ```json
 "sideEffects": [
-  "*.css",
-  "*.scss"
+  "dist/**/*.css",
+  "dist/**/*.scss"
 ],
 ```
 
@@ -206,7 +219,7 @@ Finally, make sure the following fields are set properly:
 Clean up .npmignore
 ===================
 
-Since we use the `files` field in `package.json` to whitelist only `/dist`, the `.npmignore` file is largely unnecessary. You can delete it or keep a minimal version:
+Since we use the `files` field in `package.json` to whitelist only `/dist`, the `.npmignore` file is largely unnecessary. You can keep a minimal version:
 
 ```
 node_modules
@@ -262,7 +275,7 @@ Create a `tsconfig.json` file and add the following contents to it:
 
 ```json
 {
-  "extends": "@openedx/frontend-base/config/tsconfig.json",
+  "extends": "@openedx/frontend-base/dist/tools/typescript/tsconfig.json",
   "compilerOptions": {
     "baseUrl": ".",
     "rootDir": ".",
@@ -311,8 +324,6 @@ Create a `tsconfig.build.json` file for compiling your app before publishing:
     "rootDir": "src",
     "outDir": "dist",
     "noEmit": false,
-    "declaration": true,
-    "declarationMap": false,
     "sourceMap": false
   },
   "include": [
@@ -343,7 +354,7 @@ Replace the import from 'frontend-build' with 'frontend-base'.
 
 ```diff
 - const { createConfig } = require('@openedx/frontend-build');
-+ const { createConfig } = require('@openedx/frontend-base/config');
++ const { createConfig } = require('@openedx/frontend-base/dist/tools');
 ```
 
 Use 'test' instead of 'jest' as the config type for createConfig()
@@ -387,7 +398,7 @@ Resulting jest.config.js file
 An uncustomized jest.config.js looks like:
 
 ```js
-const { createConfig } = require('@openedx/frontend-base/config');
+const { createConfig } = require('@openedx/frontend-base/dist/tools');
 
 module.exports = createConfig('test', {
   // setupFilesAfterEnv is used after the jest environment has been loaded.  In general this is what you want.
@@ -414,7 +425,7 @@ Add a babel.config.js file for Jest
 Jest needs a babel.config.js file to be present in the repository.  It should look like:
 
 ```js
-const { createConfig } = require('@openedx/frontend-base/config');
+const { createConfig } = require('@openedx/frontend-base/dist/tools');
 
 module.exports = createConfig('babel');
 ```
@@ -441,7 +452,7 @@ ESLint has been upgraded to v9, which has a new 'flat' file format.  Replace the
 ```js
 // @ts-check
 
-const { createLintConfig } = require('@openedx/frontend-base/config');
+const { createLintConfig } = require('@openedx/frontend-base/dist/tools');
 
 module.exports = createLintConfig(
   {
@@ -554,14 +565,14 @@ SVGR "ReactComponent" imports have been removed
 We have removed the `@svgr/webpack` loader because it was incompatible with more modern tooling (it requires Babel).  As a result, the ability to import SVG files into JS as the `ReactComponent` export no longer works.  We know of a total of 5 places where this is happening today in Open edX MFEs - frontend-app-learning and frontend-app-profile use it.  Please replace that export with the default URL export and set the URL as the source of an `<img>` tag, rather than using `ReactComponent`.  You can see an example of normal SVG imports in `test-site/src/ExamplePage.tsx`.
 
 
-Import createConfig and getBaseConfig from @openedx/frontend-base/config
+Import createConfig and getBaseConfig from @openedx/frontend-base/dist/tools
 ========================================================================
 
 In frontend-build, `createConfig` and `getBaseConfig` could be imported from the root package (`@openedx/frontend-build`).  They have been moved to a sub-directory to make room for runtime exports from the root package (`@openedx/frontend-base`).
 
 ```diff
 - const { createConfig, getBaseConfig } = require('@openedx/frontend-build');
-+ const { createConfig, getBaseConfig } = require('@openedx/frontend-base/config');
++ const { createConfig, getBaseConfig } = require('@openedx/frontend-base/dist/tools');
 ```
 
 You may have handled this in steps 4 and 5 above (jest.config.js and .eslintrc.js)

nodemon.pack.json

@@ -1,7 +1,7 @@
 {
   "watch": ["runtime", "shell", "tools", "index.ts", "types.ts"],
   "ext": "ts,tsx,js,jsx,json,scss,css",
-  "ignore": ["node_modules/**", ".git/**", "pack/**", "config/**", "tools/dist/**"],
+  "ignore": ["node_modules/**", ".git/**", "pack/**"],
   "delay": "250ms",
   "exec": "npm run build:pack"
 }

package-lock.json

@@ -8,19 +8,17 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
-    "/config",
-    "/dist",
-    "/tools/dist"
+    "/dist"
   ],
   "bin": {
-    "intl-imports.js": "tools/dist/cli/intl-imports.js",
-    "openedx": "tools/dist/cli/openedx.js",
-    "transifex-utils.js": "tools/dist/cli/transifex-utils.js"
+    "intl-imports.js": "dist/tools/cli/intl-imports.js",
+    "openedx": "dist/tools/cli/openedx.js",
+    "transifex-utils.js": "dist/tools/cli/transifex-utils.js"
   },
   "scripts": {
     "build": "make build",
-    "clean": "rm -rf dist",
-    "dev": "npm run build && node ./tools/dist/cli/openedx.js dev:shell",
+    "clean": "make clean",
+    "dev": "npm run build && node ./dist/tools/cli/openedx.js dev:shell",
     "docs": "jsdoc -c jsdoc.json",
     "docs:watch": "nodemon -w runtime -w docs/template -w README.md -e js,jsx,ts,tsx --exec npm run docs",
     "lint": "eslint .; npm run lint:tools; npm --prefix ./test-site run lint",
@@ -41,8 +39,8 @@
     "url": "https://github.com/openedx/frontend-base/issues"
   },
   "sideEffects": [
-    "*.css",
-    "*.scss"
+    "dist/**/*.css",
+    "dist/**/*.scss"
   ],
   "homepage": "https://github.com/openedx/frontend-base#readme",
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 // @ts-check
 
-const { createLintConfig } = require('@openedx/frontend-base/config');
+const { createLintConfig } = require('@openedx/frontend-base/dist/tools');
 
 module.exports = createLintConfig(
   {

test-site/eslint.config.js

@@ -1,4 +1,4 @@
-@use '@openedx/frontend-base/shell/app.scss';
+@use '@openedx/frontend-base/dist/shell/app.scss';
 
 .red-text {
   color: var(--pgn-color-red);

test-site/package-lock.json

@@ -1,12 +1,9 @@
 {
-  "extends": "@openedx/frontend-base/config/tsconfig.json",
+  "extends": "@openedx/frontend-base/dist/tools/typescript/tsconfig.json",
   "compilerOptions": {
     "baseUrl": ".",
     "rootDir": ".",
-    "outDir": "dist",
-    "paths": {
-      "@src/*": ["./src/*"]
-    }
+    "outDir": "dist"
   },
   "include": [
     "eslint.config.js",