Convert scripts to ES modules

Signed-off-by: Jon Koops <[email protected]>

.github/split.js → .github/split.mjs

@@ -1,8 +1,8 @@
 /* eslint-disable no-console */
-const fs = require('fs');
-const path = require('path');
+import fs from 'node:fs';
+import path from 'node:path';
 
-const BASE_DIR = path.join(__dirname, '../packages/react-integration/cypress/integration');
+const BASE_DIR = path.resolve(import.meta.dirname, '../packages/react-integration/cypress/integration');
 const WORKER_NUM = +process.env.WORKER_NUM;
 const WORKER_COUNT = +process.env.WORKER_COUNT;
 

.github/upload-preview.js → .github/upload-preview.mjs

@@ -1,8 +1,9 @@
 /* eslint-disable no-console, camelcase */
-const path = require('path');
-const { Octokit } = require('@octokit/rest');
+import { Octokit } from '@octokit/rest';
+import path from 'node:path';
+import surge from 'surge';
+
 const octokit = new Octokit({ auth: process.env.GH_PR_TOKEN });
-const surge = require('surge');
 const publishFn = surge().publish();
 
 // From github actions

.github/workflows/documentation.yml

@@ -39,11 +39,11 @@ jobs:
 
       - name: Upload documentation
         if: always()
-        run: node .github/upload-preview.js packages/react-docs/public
+        run: node .github/upload-preview.mjs packages/react-docs/public
 
       - name: Run accessibility tests
         run: yarn serve:docs & yarn test:a11y
 
       - name: Upload accessibility results
         if: always()
-        run: node .github/upload-preview.js packages/react-docs/coverage
+        run: node .github/upload-preview.mjs packages/react-docs/coverage

.github/workflows/main.yml

@@ -93,7 +93,7 @@ jobs:
         run: printenv
 
       - name: Run Cypress tests
-        run: yarn serve:integration & yarn test:integration -s $(node .github/split.js)
+        run: yarn serve:integration & yarn test:integration -s $(node .github/split.mjs)
         env:
           WORKER_NUM: ${{ matrix.worker }}
           WORKER_COUNT: 5

packages/react-core/package.json

@@ -43,7 +43,7 @@
     "build:single:packages": "node ../../scripts/build-single-packages.js --config single-packages.config.json",
     "clean": "rimraf dist components layouts helpers next deprecated",
     "generate": "node scripts/copyStyles.js",
-    "subpaths": "node ../../scripts/exportSubpaths.js --config subpaths.config.json",
+    "subpaths": "node ../../scripts/exportSubpaths.mjs --config subpaths.config.json",
     "clean:exports": "node scripts/cleanDistExports.js"
   },
   "dependencies": {

packages/react-table/package.json

@@ -37,7 +37,7 @@
     "build:umd": "rollup -c --environment IS_PRODUCTION",
     "build:single:packages": "node ../../scripts/build-single-packages.js --config single-packages.config.json",
     "clean": "rimraf dist components deprecated",
-    "subpaths": "node ../../scripts/exportSubpaths.js --config subpaths.config.json"
+    "subpaths": "node ../../scripts/exportSubpaths.mjs --config subpaths.config.json"
   },
   "dependencies": {
     "@patternfly/react-core": "workspace:^",

packages/react-templates/package.json

@@ -30,7 +30,7 @@
     "build:umd": "rollup -c --environment IS_PRODUCTION",
     "build:single:packages": "node ../../scripts/build-single-packages.js --config single-packages.config.json",
     "clean": "rimraf dist components deprecated",
-    "subpaths": "node ../../scripts/exportSubpaths.js --config subpaths.config.json"
+    "subpaths": "node ../../scripts/exportSubpaths.mjs --config subpaths.config.json"
   },
   "dependencies": {
     "@patternfly/react-core": "workspace:^",

plopfile.mjs

@@ -0,0 +1,12 @@
+import { setActionTypes } from './scripts/generators/actionTypes.mjs';
+import { setHelpers } from './scripts/generators/helpers.mjs';
+import setPFGenerators from './scripts/generators/patternfly-component/index.mjs';
+import setPackageGenerators from './scripts/generators/package/index.mjs';
+
+export default function (plop) {
+  setHelpers(plop);
+  setActionTypes(plop);
+
+  setPFGenerators(plop);
+  setPackageGenerators(plop);
+}

scripts/exportSubpaths.js → scripts/exportSubpaths.mjs

@@ -1,16 +1,16 @@
 /* eslint-disable no-console */
-const fse = require('fs-extra');
-const path = require('path');
+import fse from 'fs-extra';
+import path from 'node:path';
 
 const root = process.cwd();
-const packageJson = require(`${root}/package.json`);
+const packageJson = (await import(`${root}/package.json`, { with: { type: 'json' } })).default;
 
 if (!(process.argv.includes('--config') && process.argv.indexOf('--config') + 1 < process.argv.length)) {
   console.log('--config is required followed by the config file name');
   process.exit(1);
 }
 
-const configJson = require(`${root}/${process.argv[process.argv.indexOf('--config') + 1]}`);
+const configJson = (await import(`${root}/${process.argv[process.argv.indexOf('--config') + 1]}`, { with: { type: 'json' } })).default;
 
 if (!configJson.paths || configJson.paths.length === 0) {
   console.log('directories are required');

scripts/generators/actionTypes.js → scripts/generators/actionTypes.mjs

@@ -1,9 +1,9 @@
-const path = require('path');
-const fs = require('fs-extra');
+import path from 'node:path';
+import fs from 'fs-extra';
 
-const ADD_TO_BARREL_FILE = 'addToBarrelFile';
+export const ADD_TO_BARREL_FILE = 'addToBarrelFile';
 
-function setActionTypes(plop) {
+export function setActionTypes(plop) {
   plop.setActionType(ADD_TO_BARREL_FILE, addToBarrelFile);
 }
 
@@ -29,8 +29,3 @@ async function addToBarrelFile(answers, config, plop) {
   await fs.outputFile(pathToFile, updatedLines.join('\n'));
   return `-> ${pathToFile}`;
 }
-
-module.exports = {
-  setActionTypes,
-  ADD_TO_BARREL_FILE
-};

scripts/generators/helpers.mjs

@@ -0,0 +1,5 @@
+export const REMOVE_NPM_SCOPE = 'removeNPMScope';
+
+export function setHelpers(plop) {
+  plop.setHelper(REMOVE_NPM_SCOPE, (text) => text.replace(/^@patternfly\//i, ''));
+}

scripts/generators/package/index.js → scripts/generators/package/index.mjs

@@ -1,9 +1,9 @@
-const { join, resolve } = require('path');
-const { REMOVE_NPM_SCOPE } = require('../helpers');
+import { join, resolve } from 'node:path';
+import { REMOVE_NPM_SCOPE } from '../helpers.mjs';
 
-const packagesRoot = resolve(__dirname, '../../../packages');
+const packagesRoot = resolve(import.meta.dirname, '../../../packages');
 
-function setPackageGenerators(plop) {
+export default function setPackageGenerators(plop) {
   plop.setGenerator('Package', {
     description: 'A new package for the monorepo',
     prompts: [
@@ -30,7 +30,7 @@ function setPackageGenerators(plop) {
         {
           type: 'add',
           path: join(packageBaseTemplate, `package.json`),
-          templateFile: resolve(__dirname, './package.json.hbs')
+          templateFile: resolve(import.meta.dirname, './package.json.hbs')
         },
         {
           type: 'add',
@@ -42,17 +42,17 @@ function setPackageGenerators(plop) {
         answers.buildsWithTypescript && {
           type: 'add',
           path: join(packageBaseTemplate, `.npmignore`),
-          templateFile: resolve(__dirname, './.npmignore')
+          templateFile: resolve(import.meta.dirname, './.npmignore')
         },
         answers.buildsWithTypescript && {
           type: 'add',
           path: join(packageBaseTemplate, `tsconfig.json`),
-          templateFile: resolve(__dirname, './tsconfig.json')
+          templateFile: resolve(import.meta.dirname, './tsconfig.json')
         },
         answers.buildsWithTypescript && {
           type: 'add',
           path: join(packageBaseTemplate, `tsconfig.cjs.json`),
-          templateFile: resolve(__dirname, './tsconfig.cjs.json')
+          templateFile: resolve(import.meta.dirname, './tsconfig.cjs.json')
         },
         {
           type: 'add',
@@ -63,5 +63,3 @@ function setPackageGenerators(plop) {
     }
   });
 }
-
-module.exports = setPackageGenerators;

scripts/generators/patternfly-component/index.js → scripts/generators/patternfly-component/index.mjs

@@ -1,16 +1,16 @@
-const { join, resolve } = require('path');
-const { ADD_TO_BARREL_FILE } = require('../actionTypes');
+import { join, resolve } from 'node:path';
+import { ADD_TO_BARREL_FILE } from '../actionTypes.mjs';
 
-const templatesDir = resolve(__dirname, './templates');
-const reactCoreRoot = resolve(__dirname, '../../../packages/react-core');
+const templatesDir = resolve(import.meta.dirname, './templates');
+const reactCoreRoot = resolve(import.meta.dirname, '../../../packages/react-core');
 
 const componentTypes = new Map([
   ['component', 'components'],
   ['layout', 'layouts'],
   ['internal', 'internal']
 ]);
 
-function setPFGenerators(plop) {
+export default function setPFGenerators(plop) {
   plop.setGenerator('PatternFly Component', {
     description: 'Component or Layout for PatternFly react-core package',
     prompts: [
@@ -62,5 +62,3 @@ function setPFGenerators(plop) {
     }
   });
 }
-
-module.exports = setPFGenerators;