feat: Force build before publishing

To avoid the common mistake of publishing before building, add `npm run
build` to the `prepack` stage.  This takes care of building before both
`npm publish` and `npm pack`.

Also rename the pack/nodemon npm scripts for consistency.

Author: arbrandes

.github/workflows/ci.yml

@@ -23,8 +23,7 @@ jobs:
     - name: Install dependencies
       run: |
         npm ci
-        npm run build
-        npm run pack:local
+        npm run pack
         cd test-site
         npm i ../pack/openedx-frontend-base.tgz
         npm ci

docs/decisions/0010-typescript-compilation-and-local-dev-workflow.rst

@@ -121,8 +121,8 @@ Local development workflow
 To develop a local dependency (e.g., ``@openedx/frontend-base``) against a
 consuming project:
 
-1. In the dependency: ``npm run build`` (or use a watcher like ``nodemon`` with
-   ``npm run pack:local``)
+1. In the dependency: ``npm run pack`` (or use a watcher like ``nodemon`` with
+   ``npm run pack:watch``)
 2. In the consumer: install from the tarball and run the dev server (or use the
    `autoinstall tool`_ from the ``frontend-dev-utils`` package)
 

docs/how_tos/migrate-frontend-app.md

@@ -129,10 +129,12 @@ With the exception of any custom scripts, replace the `scripts` section of your
 ```json
   "scripts": {
     "build": "make build",
+    "clean": "make clean",
     "dev": "PORT=YOUR_PORT PUBLIC_PATH=/YOUR_APP_NAME openedx dev",
     "i18n_extract": "openedx formatjs extract",
     "lint": "openedx lint .",
     "lint:fix": "openedx lint --fix .",
+    "prepack": "npm run build",
     "snapshot": "openedx test --updateSnapshot",
     "test": "openedx test --coverage --passWithNoTests"
   },
@@ -154,10 +156,13 @@ Also:
 > **Why change `fedx-scripts` to `openedx`?**
 > A few reasons.  One, the Open edX project shouldn't be using the name of an internal community of practice at edX for its frontend tooling.  Two, some dependencies of your MFE invariably still use frontend-build for their own build needs.  This means that they already installed `fedx-scripts` into your `node_modules/.bin` folder.  Only one version can be in there, so we need a new name.  Seemed like a great time for a naming refresh. |
 
-Last but not least, add a `build:` target to your `Makefile`.  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:
+Last but not least, add `clean:` and `build:` targets to your `Makefile`.  The build 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:
 
 ```makefile
-build:
+clean:
+	rm -rf dist
+
+build: clean
 	tsc --project tsconfig.build.json
 	tsc-alias -p tsconfig.build.json
 	find src -type f -name '*.scss' -exec sh -c '\

nodemon.pack.json

@@ -3,5 +3,5 @@
   "ext": "ts,tsx,js,jsx,json,scss,css",
   "ignore": ["node_modules/**", ".git/**", "pack/**"],
   "delay": "250ms",
-  "exec": "npm run build:pack"
+  "exec": "npm run pack"
 }

package.json

@@ -28,10 +28,10 @@
     "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",
     "lint:tools": "cd ./tools && eslint . && cd ..",
-    "test": "jest",
-    "pack:local": "mkdir -p pack && npm pack --silent --pack-destination pack >/dev/null && mv \"$(ls -t pack/*.tgz | head -n 1)\" pack/openedx-frontend-base.tgz",
-    "build:pack": "make build && npm run pack:local",
-    "dev:pack": "nodemon --config nodemon.pack.json"
+    "pack": "mkdir -p pack && npm pack --silent --pack-destination pack >/dev/null && mv \"$(ls -t pack/*.tgz | head -n 1)\" pack/openedx-frontend-base.tgz",
+    "pack:watch": "nodemon --config nodemon.pack.json",
+    "prepack": "npm run build",
+    "test": "jest"
   },
   "repository": {
     "type": "git",

test-site/package.json

@@ -5,10 +5,10 @@
   "main": "src/index.jsx",
   "scripts": {
     "build": "openedx build",
-    "lint": "openedx lint .",
     "dev": "openedx dev",
-    "serve": "openedx serve",
-    "dev:autoinstall": "node ./tools/autoinstall/dev-with-autoinstall.mjs"
+    "dev:autoinstall": "node ./tools/autoinstall/dev-with-autoinstall.mjs",
+    "lint": "openedx lint .",
+    "serve": "openedx serve"
   },
   "keywords": [],
   "author": "Open edX Community",