Merge branch 'main' into STRIPES-861

Author: JohnC-80

CHANGELOG.md

@@ -3,7 +3,7 @@
 ## 4.1.0 IN PROGRESS
 
 * Populate module descriptor's `name` field with module-name if `description` is missing. Refs STCLI-272.
-* Use node-native glob functionality in `translate compile`. Refs STCLI-273.
+* Populate module descriptor's `metadata` field with remaining `stripes` properties. Refs STCLI-274.
 
 ## [4.0.0](https://github.com/folio-org/stripes-cli/tree/v4.0.0) (2025-02-24)
 [Full Changelog](https://github.com/folio-org/stripes-cli/compare/v3.2.0...v4.0.0)

lib/cli/generate-module-descriptor.js

@@ -1,5 +1,5 @@
-// Logic borrowed from stripes-core's package2md.js excluding file load and console output
-// $ node ../stripes-core/util/package2md.js package.json > MD.json
+const { omit } = require('lodash');
+
 module.exports = function generateModuleDescriptor(packageJson, isStrict) {
   const stripes = packageJson.stripes || {};
   const moduleDescriptor = {
@@ -12,6 +12,9 @@ module.exports = function generateModuleDescriptor(packageJson, isStrict) {
     moduleDescriptor.requires = Object.keys(interfaces).map(key => ({ id: key, version: interfaces[key] }));
     const optional = stripes.optionalOkapiInterfaces || [];
     moduleDescriptor.optional = Object.keys(optional).map(key => ({ id: key, version: optional[key] }));
+    moduleDescriptor.metadata = {
+      stripes: omit(stripes, ['okapiInterfaces', 'optionalOkapiInterfaces', 'permissionSets']),
+    };
   }
   return moduleDescriptor;
 };

lib/commands/mod/descriptor.js

@@ -14,7 +14,8 @@ function moduleDescriptorCommand(argv) {
     DescriptorService.writeModuleDescriptorsToDirectory(descriptors, argv.output);
     console.log(`${descriptors.length} module descriptors written to ${argv.output}`);
   } else if (argv.full) {
-    console.log(JSON.stringify(descriptors, null, 2));
+    const output = argv.single && descriptors.length === 1 ? descriptors[0] : descriptors;
+    console.log(JSON.stringify(output, null, 2));
   } else {
     descriptors.forEach(descriptor => console.log(descriptor.id));
   }
@@ -40,6 +41,11 @@ module.exports = {
         type: 'boolean',
         default: false,
       })
+      .option('single', {
+        describe: 'Full JSON descriptor for a single module in the current working directory',
+        type: 'boolean',
+        default: false,
+      })
       .option('output', {
         describe: 'Directory to write descriptors to as JSON files',
         type: 'string',

lib/commands/translate/compile.js

@@ -10,10 +10,10 @@ const importLazy = require('import-lazy')(require);
 const fs = importLazy('fs');
 const path = importLazy('path');
 const process = importLazy('process');
+const fg = importLazy('fast-glob');
 const { compile } = importLazy('@formatjs/cli-lib');
 
 const { contextMiddleware } = importLazy('../../cli/context-middleware');
-const { globSync } = fs;
 
 /**
  * createOutDir
@@ -42,8 +42,8 @@ function formatjsCompileCommand(argv) {
     ast: true,
     format: 'simple',
   };
-  const globSelect = path.join(txPath, '*.json');
-  const files = globSync(globSelect);
+
+  const files = fg.globSync(path.join(txPath, '*.json'));
   if (fs.existsSync(txPath) && files.length > 0) {
     createOutDir(outDir);
     Promise.all(files.map(f => compile([f], opts)))

package.json

@@ -31,6 +31,7 @@
     "configstore": "^3.1.1",
     "debug": "^4.0.1",
     "express": "^4.17.1",
+    "fast-glob": "^3.3.1",
     "fast-xml-parser": "^4.2.4",
     "find-up": "^2.1.0",
     "fs-extra": "^11.1.1",

test/okapi/descriptor-service.spec.js

@@ -130,7 +130,8 @@ describe('The descriptor-service', function () {
             id: 'backend2',
             version: '3.1'
           }
-        ]
+        ],
+        metadata: { stripes: { type: packageJsonStub.stripes.type } }
       }];
 
       const output = this.sut.getUiModuleDescriptor(true);
@@ -189,7 +190,8 @@ describe('The descriptor-service', function () {
               id: 'backend2',
               version: '3.1'
             }
-          ]
+          ],
+          metadata: { stripes: { type: packageJsonStub.stripes.type } }
         };
       });