chore: publish correct README.md for the angular package

Fixes #3
AmadeusITGroup · Feb 19, 2025 · 5e639a5 · 5e639a5
1 parent 8612893
commit 5e639a5
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 39 deletions.
diff --git a/packages/angular/README.md b/packages/angular/README.md
@@ -1,3 +1,3 @@
 # Amadeus Toolkit for Micro Frontends (Angular)
 
-> TODO: description
+An Angular wrapper for the `@amadeus-it-group/microfrontends` library.
diff --git a/packages/angular/lib/README.md b/packages/angular/lib/README.md
diff --git a/scripts/prepare-packages.js b/scripts/prepare-packages.js
@@ -6,33 +6,42 @@ import { fileURLToPath } from 'url';
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const PUBLISH_DIR = path.resolve(__dirname, '../.publish');
 
-function packPackage(cwd, { cleanPackageJson } = { cleanPackageJson: true }) {
+function packCore() {
+	const cwd = path.resolve(__dirname, '../packages/core');
 	const packageJsonPath = path.join(cwd, 'package.json');
 	const backupPath = path.join(cwd, `package.json.backup`);
 
 	try {
 		// `npm pkg delete`
-		if (cleanPackageJson) {
-			fs.copySync(packageJsonPath, backupPath);
-			console.log(`Cleaning package.json in ${cwd}...`);
-			execSync('npm pkg delete wireit scripts devDependencies', { cwd, encoding: 'utf8' });
-		}
+		fs.copySync(packageJsonPath, backupPath);
+		console.log(`Cleaning package.json in ${cwd}...`);
+		execSync('npm pkg delete wireit scripts devDependencies', { cwd, encoding: 'utf8' });
 
 		// `npm pack`
 		execSync(`npm pack --pack-destination "${PUBLISH_DIR}"`, { cwd, encoding: 'utf8' });
 	} catch (err) {
 		console.error(`Error packing ${cwd}:`, err);
 	} finally {
-		if (cleanPackageJson) {
-			fs.moveSync(backupPath, packageJsonPath, { overwrite: true });
-		}
+		fs.moveSync(backupPath, packageJsonPath, { overwrite: true });
+	}
+}
+
+function packAngular() {
+	const cwd = path.resolve(__dirname, '../packages/angular/dist');
+
+	try {
+		// copy README.md
+		fs.copySync(path.join(cwd, '..', 'README.md'), path.join(cwd, 'README.md'));
+
+		// `npm pack`
+		execSync(`npm pack --pack-destination "${PUBLISH_DIR}"`, { cwd, encoding: 'utf8' });
+	} catch (err) {
+		console.error(`Error packing ${cwd}:`, err);
 	}
 }
 
 fs.removeSync(PUBLISH_DIR);
 fs.ensureDirSync(PUBLISH_DIR);
 
-packPackage(path.resolve(__dirname, '../packages/core'));
-packPackage(path.resolve(__dirname, '../packages/angular/dist'), {
-	cleanPackageJson: false,
-});
+packCore();
+packAngular();