@openedx/frontend-base 1.0.0-alpha.16 → 1.0.0-alpha.18

package/README.md

@@ -78,7 +78,7 @@ This watches for changes in `frontend-base` and rebuilds the packaged tarball on
 ```sh
 nvm use
 npm ci
-npm run pack:watch
+npm run watch:pack
 ```
 
 #### In the consuming application

package/dist/tools/cli/openedx.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const chalk_1 = __importDefault(require("chalk"));
+const child_process_1 = require("child_process");
 const fs_1 = require("fs");
 const path_1 = __importDefault(require("path"));
 const types_1 = require("../types");
@@ -15,13 +16,31 @@ const printUsage_1 = __importDefault(require("./utils/printUsage"));
 const commandName = process.argv[2];
 // remove 'openedx' from process.argv to allow subcommands to read options properly
 process.argv.splice(1, 1);
-let version;
-if ((0, fs_1.existsSync)(path_1.default.resolve(__dirname, '../../package.json'))) {
-    version = require('../../package.json').version;
-}
-else if ((0, fs_1.existsSync)(path_1.default.resolve(__dirname, '../../../package.json'))) {
-    version = require('../../../package.json').version;
+function getVersion() {
+    // Read the version from package.json.  The compiled CLI lives at
+    // dist/tools/cli/openedx.js, so the package root is always three levels up.
+    const pkgJsonPath = path_1.default.resolve(__dirname, '../../../package.json');
+    if (!(0, fs_1.existsSync)(pkgJsonPath)) {
+        return '(unknown)';
+    }
+    const { version: pkgVersion } = require(pkgJsonPath);
+    if (!pkgVersion) {
+        return '(unknown)';
+    }
+    if (!/^0\.0\.0-.+$/.test(pkgVersion)) {
+        return pkgVersion;
+    }
+    // Placeholder version found — likely a local git checkout.  Append the
+    // git hash so the exact checkout is identifiable.
+    try {
+        const hash = (0, child_process_1.execSync)('git rev-parse --short HEAD', { encoding: 'utf-8' }).trim();
+        return `${pkgVersion} (${hash})`;
+    }
+    catch {
+        return pkgVersion;
+    }
 }
+const version = getVersion();
 (0, prettyPrintTitle_1.default)(`Open edX CLI v${version}`);
 switch (commandName) {
     case types_1.CommandTypes.LINT:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openedx/frontend-base",
-  "version": "1.0.0-alpha.16",
+  "version": "1.0.0-alpha.18",
   "description": "Build tools, setup and config for frontend apps",
   "publishConfig": {
     "access": "public"
@@ -25,13 +25,14 @@
     "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",
     "lint:tools": "cd ./tools && eslint . && cd ..",
     "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"
+    "test": "jest",
+    "watch:build": "nodemon --exec 'npm run build'",
+    "watch:docs": "nodemon --watch docs/template --watch README.md --exec npm run docs",
+    "watch:pack": "nodemon --exec 'npm run pack'"
   },
   "repository": {
     "type": "git",