@pega/custom-dx-components 26.1.12-alpha.0.5 → 26.1.12-alpha.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pega/custom-dx-components",
-  "version": "26.1.12-alpha.0.5",
+  "version": "26.1.12-alpha.0.6",
   "description": "Utility for building custom UI components",
   "bin": {
     "custom-dx-components": "./bin/index.js"

package/src/tasks/create/index.js

@@ -4,6 +4,9 @@ import fs from 'fs';
 
 import inquirer from 'inquirer';
 import chalk from 'chalk';
+import { execa } from 'execa';
+
+import { SHARED_DIRECTORY } from '../../constants.js';
 
 import {
   convertIntoPascalCase,
@@ -147,6 +150,25 @@ const compileMustacheTemplates = async (
   });
 };
 
+// Formats the generated files with the project's own Prettier so they pass the project's `prettier -c .` check.
+// Skipped when the project has no local Prettier. A formatting failure is reported but does not fail the create.
+const formatGeneratedFiles = async (componentDirectory) => {
+  const projectDirectory = process.cwd();
+  if (!fs.existsSync(path.join(projectDirectory, 'node_modules', 'prettier'))) return;
+
+  // The shared folder only exists in library-based mode and holds files generated by this task.
+  const directories = [componentDirectory, path.join(path.dirname(componentDirectory), SHARED_DIRECTORY)].filter((directory) =>
+    fs.existsSync(directory),
+  );
+  const result = await execa('npx', ['--no-install', 'prettier', '--write', '--log-level', 'warn', ...directories], {
+    cwd: projectDirectory,
+    reject: false,
+  });
+  if (result.exitCode !== 0) {
+    console.log(chalk.yellow(`Generated files could not be formatted with Prettier: ${result.stderr || result.stdout}`));
+  }
+};
+
 const validateCompile = async ({ componentName, componentLabel, library, version, framework, type, subtype, description, organization }, options) => {
   const isLibraryBased = getLibraryBased();
   let sSubType = subtype;
@@ -231,6 +253,7 @@ const validateCompile = async ({ componentName, componentLabel, library, version
     description,
     organization,
   });
+  await formatGeneratedFiles(targetDirectory);
 
   console.log(chalk.green(`${componentKey} component is created in ${targetDirectory}`));
 };

package/src/tasks/export-archive/index.js

@@ -40,8 +40,8 @@ export const updateConfig = async ({ oldComponentKey, newComponentKey, library,
   configData.library = library;
   configData.version = version;
 
-  // stringify "4", makes the json string look like JSON in the file, formatted instead of a single line
-  fs.writeFileSync(join(targetDirectory, '/config.json'), JSON.stringify(configData, null, 4), {
+  // stringify "2", makes the json string look like JSON in the file, formatted instead of a single line
+  fs.writeFileSync(join(targetDirectory, '/config.json'), JSON.stringify(configData, null, 2), {
     encoding: 'utf8',
     flag: 'w',
   });

package/src/tasks/import-archive/helper.js

@@ -42,8 +42,8 @@ export const setTasksConfig = async (libraryName, version, devBuild, currDir) =>
   compConfig.version = version;
 
   // update file
-  // stringify "4", makes the json string look like JSON in the file, formatted instead of a single line
-  fs.writeFileSync(pegaConfigJsonPath, JSON.stringify(configData, null, 4), { encoding: 'utf8', flag: 'w' });
+  // stringify "2", makes the json string look like JSON in the file, formatted instead of a single line
+  fs.writeFileSync(pegaConfigJsonPath, JSON.stringify(configData, null, 2), { encoding: 'utf8', flag: 'w' });
 };
 
 export const setPackageOrg = async (organization, currDir) => {
@@ -55,8 +55,8 @@ export const setPackageOrg = async (organization, currDir) => {
   packageData.organization = organization;
 
   // update file
-  // stringify "4", makes the json string look like JSON in the file, formatted instead of a single line
-  fs.writeFileSync(packageJsonPath, JSON.stringify(packageData, null, 4), { encoding: 'utf8', flag: 'w' });
+  // stringify "2", makes the json string look like JSON in the file, formatted instead of a single line
+  fs.writeFileSync(packageJsonPath, `${JSON.stringify(packageData, null, 2)}\n`, { encoding: 'utf8', flag: 'w' });
 };
 
 export const updateConfig = async ({ oldComponentKey, newComponentKey, organization, library, version, currentDirectory }) => {
@@ -71,8 +71,8 @@ export const updateConfig = async ({ oldComponentKey, newComponentKey, organizat
   configData.library = library;
   configData.version = version;
 
-  // stringify "4", makes the json string look like JSON in the file, formatted instead of a single line
-  fs.writeFileSync(join(currentDirectory, '/config.json'), JSON.stringify(configData, null, 4), {
+  // stringify "2", makes the json string look like JSON in the file, formatted instead of a single line
+  fs.writeFileSync(join(currentDirectory, '/config.json'), `${JSON.stringify(configData, null, 2)}\n`, {
     encoding: 'utf8',
     flag: 'w',
   });

package/src/tasks/import-archive/index.js

@@ -62,8 +62,8 @@ export const updateConfig = async ({ oldComponentKey, newComponentKey, library,
   configData.library = library;
   configData.version = version;
 
-  // stringify "4", makes the json string look like JSON in the file, formatted instead of a single line
-  fs.writeFileSync(join(targetDirectory, '/config.json'), JSON.stringify(configData, null, 4), {
+  // stringify "2", makes the json string look like JSON in the file, formatted instead of a single line
+  fs.writeFileSync(join(targetDirectory, '/config.json'), `${JSON.stringify(configData, null, 2)}\n`, {
     encoding: 'utf8',
     flag: 'w',
   });

package/src/tasks/import-comp/index.js

@@ -48,8 +48,8 @@ export const updateConfig = async ({ oldComponentKey, newComponentKey, library,
     configData.description = newLabel;
   }
 
-  // stringify "4", makes the json string look like JSON in the file, formatted instead of a single line
-  fs.writeFileSync(join(targetDirectory, '/config.json'), JSON.stringify(configData, null, 4), { encoding: 'utf8' });
+  // stringify "2", makes the json string look like JSON in the file, formatted instead of a single line
+  fs.writeFileSync(join(targetDirectory, '/config.json'), `${JSON.stringify(configData, null, 2)}\n`, { encoding: 'utf8' });
 };
 
 export const updateFile = async (fileName, oldComponentKeyPC, newComponentKeyPC, targetDirectory) => {

package/src/tasks/init/template/.prettierignore

@@ -0,0 +1,17 @@
+# Docs and templates that are not formatted with Prettier
+**/*.md
+**/*.mustache
+**/*.txt
+**/*.npmrc
+**/*.gitignore
+**/LICENSE
+
+# CLI-managed state, rewritten by the CLI with its own formatting
+/store/
+/tasks.config.json
+
+# Library build output (one folder per org_library, e.g. PegaQa_DxTestLib/)
+/*_*/
+/build/
+/dist/
+/coverage/