@plone/volto 18.0.0-alpha.2 → 18.0.0-alpha.21

package/packages/scripts/README.md

@@ -1,128 +0,0 @@
-# @plone/scripts package
-
-This package is a library of scripts that are useful to automate certain tasks when developing Volto core or Volto projects.
-
-## i18n
-
-It scans and detects i18n messages from the code and adds them to the i18n machinery.
-
-See https://6.docs.plone.org/volto/recipes/i18n.html for more information.
-
-This script is installed in the `node_modules/.bin` directory and can be called via `yarn i18n` or directly in the `scripts` `package.json` part.
-
-## changelogupdater
-
-It updates the change log according the current defaults in the Volto project.
-
-See how Volto core uses it, along with `release-it`, to automate the release process:
-
-https://github.com/plone/volto/blob/4f52bf61062d1e34e3391ed0a36781b8df98a316/package.json#L173-L192
-
-### Bump
-
-Given the version, you can update the first `unreleased` literal. `release-it` provides it as a `version` variable.
-
-```shell
-yarn changelogupdater bump ${version}
-```
-
-### Excerpt
-
-It generates the change log of the version to be released. This is useful when creating the Release information and sending it to GitHub.
-
-```shell
-yarn changelogupdater.js excerpt
-```
-
-### Back
-
-It creates the blank placeholder for the next release. Given the (next) version, it will be added to the placeholder.
-
-```shell
-yarn changelogupdater.js back ${version}
-```
-
-## addon
-
-This script creates and configures a vanilla project using the Volto generator.
-The project is configured to have the current add-on installed and ready to work with.
-This script is useful to bootstrap an isolated environment that can be used to quickly develop the add-on or for demo purposes.
-It's also useful when testing an add-on in a CI environment.
-
-**Note:** It's quite similar when you develop a Plone backend add-on in the Python side, and embed a ready to use Plone build (using buildout or pip) in order to develop and test the package.
-
-Unfortunately, the NodeJS tooling does not work well with symlinks or outside the root of the project.
-This script proceeds in the following way:
-
-1. Generates a vanilla project using the official Volto Yo Generator (@plone/generator-volto)
-2. Configures it to use the add-on with the name stated in the `package.json`
-3. Copies over the root of the add-on (`src` and essential files) inside the created project
-
-After this, you can change directory to the created project, by default `addon-testing-project`.
-The name of the created project is parameterizable.
-
-After that you can use the full fledged project, and run any standard Volto command for linting, acceptance test or unit tests.
-
-### clone (git)
-
-Given the add-on remote git repository, it pulls and configures it into the vanilla project generated by the script.
-
-`npx -p @plone/scripts addon clone [options] <source> [destination]`
-
-```console
-    Usage: addon clone [options] <source> [destination]
-
-    clone a repository into a newly created directory
-
-    Options:
-      -p, --private          set if the repo is private, then GITHUB_TOKEN is used
-      -b, --branch <branch>  set the repo branch, defaults to main
-      -c, --canary           downloads latest Volto canary (alpha) version
-      -h, --help             display help for command
-```
-
-This next command downloads the `volto-blocks-grid` add-on from its git repository's `main` branch, and will generate a project with the latest Volto canary (alpha) version.
-
-```shell
-npx -p @plone/scripts addon clone https://github.com/kitconcept/volto-blocks-grid.git --branch main --canary
-```
-
-This will create a directory named `addon-testing-project`, and will bootstrap a new project using Volto's standard project generator.
-It will adjust the configuration of this project to setup the add-on in the project using `mrs-developer`, and the git URL given to fetch the add-on contents.
-You can specify the branch to be used, if the project should use the latest alpha available.
-For private repositories, it uses the `GITHUB_TOKEN` present in your environment variables to fetch it.
-
-After this, as a developer you can use the usual project commands to run tests (unit, linting, acceptance) inside the generated `addon-testing-project`.
-You can configure the CI of your choice for automated testing, you can take a look at how it's done in: https://github.com/kitconcept/volto-blocks-grid/tree/main/.github/workflows
-
-The idea is to issue commands inside the generated `addon-testing-project` project and do your checks.
-Take special care on how to pass down to the `npx` command the current pull request branch.
-Depending on your CI system, this might be different.
-
-### clone local
-
-You can also clone the local add-on using:
-
-```shell
-npx -p @plone/scripts addon clone .
-```
-
-This only works if you execute the command from the root of your add-on directory.
-
-### consolidate
-
-While developing, you might have done changes inside the generated project, and you most probably want to consolidate them, back into the root of the repository.
-By running this script, it copies over from `addon-testing-project/src/addons/<my-addon>` to the root of your repository.
-
-It should be run at the root of the add-on, and it gets an optional `source` argument in case you have specified a directory other than `addon-testing-project`.
-
-`npx -p @plone/scripts addon consolidate --help`
-
-```console
-    Usage: addon consolidate [options] [source]
-
-    Consolidate a cloned project
-
-    Options:
-      -h, --help  display help for command
-```

package/packages/scripts/addon/consolidate.js

@@ -1,28 +0,0 @@
-/* eslint no-console: 0 */
-import fs from 'fs';
-import fse from 'fs-extra';
-import { getLocalAddonInfo } from './getAddonInfo.js';
-
-export async function consolidateAddon({ source = 'addon-testing-project' }) {
-  const { name } = await getLocalAddonInfo({
-    source: '.',
-  });
-
-  try {
-    const filterFunc = (filenames) => {
-      const IGNORE_FILES = ['node_modules', '.git'];
-      return filenames.filter((item) => !IGNORE_FILES.includes(item));
-    };
-    const filenames = filterFunc(
-      fs.readdirSync(`${source}/src/addons/${name}`),
-    );
-
-    filenames.forEach((filename) => {
-      fse.copySync(`${source}/src/addons/${name}/${filename}`, `${filename}`, {
-        overwrite: true,
-      });
-    });
-  } catch (err) {
-    console.error(err);
-  }
-}

package/packages/scripts/addon/generators.js

@@ -1,213 +0,0 @@
-/* eslint no-console: 0 */
-import fs from 'fs';
-import fse from 'fs-extra';
-import { execSync } from 'child_process';
-import { develop } from 'mrs-developer';
-import chalk from 'chalk';
-import { getGitAddonInfo, getLocalAddonInfo } from './getAddonInfo.js';
-import {
-  amendPackageJSON,
-  createLocalMrsDeveloperConfig,
-  createMrsDeveloperConfig,
-} from './utils.js';
-
-export async function runGitGenerator({
-  source,
-  destination = 'addon-testing-project',
-  isPrivate = false,
-  branch = 'main',
-  isCanary = false,
-}) {
-  if (isPrivate) {
-    console.log(
-      chalk.green(
-        `Retrieving private package info from branch ${chalk.yellow(
-          branch,
-        )} repo ${chalk.yellow(source)}`,
-      ),
-    );
-  } else {
-    console.log(
-      chalk.blue(
-        `Retrieving package info from branch ${chalk.yellow(
-          branch,
-        )} repo ${chalk.yellow(source)}`,
-      ),
-    );
-  }
-
-  const { fullname, name, version } = await getGitAddonInfo({
-    source,
-    branch,
-    isPrivate,
-  });
-
-  console.log(
-    chalk.green(
-      `The package name is ${chalk.yellow(
-        fullname || name,
-      )} pulling version ${chalk.yellow(version)}`,
-    ),
-  );
-
-  const GENERATOR_CLI = `yo --force --no-insight @plone/volto ${destination} --no-interactive --skip-install --workspace src/addons/${name} --addon ${
-    fullname || name
-  } ${isCanary ? '--canary' : ''}`;
-
-  execSync(GENERATOR_CLI, (error, stdout, stderr) => {
-    if (error) {
-      console.log(`error: ${error.message}`);
-      return;
-    }
-    if (stderr) {
-      console.log(`stderr: ${stderr}`);
-      return;
-    }
-  });
-
-  createMrsDeveloperConfig({
-    fullname,
-    name,
-    version,
-    source,
-    destination,
-    branch,
-  });
-
-  // BBB: Maintains compatibility with
-  // @plone/generator-volto < 7.0.0-alpha.7
-  // In new versions of @plone/generator-volto we do not have jsconfig.json but tsconfig.json
-  let configFile;
-  if (fs.existsSync(`${destination}/jsconfig.json`)) {
-    configFile = 'jsconfig.json';
-  } else {
-    configFile = 'tsconfig.json';
-  }
-
-  await develop({
-    root: destination,
-    configFile: configFile,
-    output: 'addons',
-  });
-
-  execSync(
-    `cd ${destination} && yarn config set enableImmutableInstalls false && yarn install`,
-    { stdio: 'inherit' },
-    (error, stdout, stderr) => {
-      if (error) {
-        console.log(`error: ${error.message}`);
-        return;
-      }
-      if (stderr) {
-        console.log(`stderr: ${stderr}`);
-        return;
-      }
-    },
-  );
-
-  console.log(
-    chalk.green(
-      `Preparing and amending testing project ${chalk.yellow('package.json')}`,
-    ),
-  );
-  amendPackageJSON(name, destination, isCanary);
-}
-
-export async function runLocalGenerator({
-  source,
-  destination = 'addon-testing-project',
-  isCanary = false,
-}) {
-  const { fullname, name, version } = await getLocalAddonInfo({
-    source,
-  });
-
-  console.log(
-    chalk.green(
-      `The package name is ${chalk.yellow(
-        fullname || name,
-      )} pulling version ${chalk.yellow(version)}`,
-    ),
-  );
-
-  const GENERATOR_CLI = `yo --force --no-insight @plone/volto ${destination} --no-interactive --skip-install --workspace src/addons/${name} --addon ${
-    fullname || name
-  } ${isCanary ? '--canary' : ''}`;
-
-  execSync(GENERATOR_CLI, (error, stdout, stderr) => {
-    if (error) {
-      console.log(`error: ${error.message}`);
-      return;
-    }
-    if (stderr) {
-      console.log(`stderr: ${stderr}`);
-      return;
-    }
-  });
-
-  try {
-    const filterFunc = (filenames) => {
-      const IGNORE_FILES = ['node_modules', '.git', destination];
-      return filenames.filter((item) => !IGNORE_FILES.includes(item));
-    };
-    const filenames = filterFunc(fs.readdirSync(source));
-
-    filenames.forEach((filename) => {
-      fse.copySync(
-        `${source}/${filename}`,
-        `${destination}/src/addons/${name}/${filename}`,
-        {
-          overwrite: false,
-        },
-      );
-    });
-  } catch (err) {
-    console.error(err);
-  }
-
-  createLocalMrsDeveloperConfig({
-    fullname,
-    name,
-    version,
-    source,
-    destination,
-  });
-
-  // BBB: Maintains compatibility with
-  // @plone/generator-volto < 7.0.0-alpha.7
-  // In new versions of @plone/generator-volto we do not have jsconfig.json but tsconfig.json
-  let configFile;
-  if (fs.existsSync(`${destination}/jsconfig.json`)) {
-    configFile = 'jsconfig.json';
-  } else {
-    configFile = 'tsconfig.json';
-  }
-
-  await develop({
-    root: destination,
-    configFile: configFile,
-    output: 'addons',
-  });
-
-  execSync(
-    `cd ${destination} && yarn config set enableImmutableInstalls false && yarn install`,
-    { stdio: 'inherit' },
-    (error, stdout, stderr) => {
-      if (error) {
-        console.log(`error: ${error.message}`);
-        return;
-      }
-      if (stderr) {
-        console.log(`stderr: ${stderr}`);
-        return;
-      }
-    },
-  );
-
-  console.log(
-    chalk.green(
-      `Preparing and amending testing project ${chalk.yellow('package.json')}`,
-    ),
-  );
-  amendPackageJSON(name, destination, isCanary);
-}

package/packages/scripts/addon/getAddonInfo.js

@@ -1,65 +0,0 @@
-/* eslint no-console: 0 */
-import fs from 'fs';
-import https from 'https';
-import GitUrlParse from 'git-url-parse';
-
-/*
- * Retrieves latest Volto released version from NPM registry
- */
-export async function getGitAddonInfo({ source, branch = 'main', isPrivate }) {
-  const sourceParse = GitUrlParse(source);
-  const packageJSONURL = isPrivate
-    ? `https://api.github.com/repos/${sourceParse.full_name}/contents/package.json`
-    : `https://raw.githubusercontent.com/${sourceParse.full_name}/${branch}/package.json`;
-
-  return new Promise((resolve, reject) => {
-    https
-      .get(
-        packageJSONURL,
-        {
-          headers: {
-            ...(isPrivate
-              ? {
-                  Authorization: `token ${process.env.GITHUB_TOKEN}`,
-                  'User-Agent': 'node.js',
-                  Accept: 'application/vnd.github.VERSION.raw',
-                }
-              : {}),
-          },
-        },
-        (resp) => {
-          let data = [];
-          resp.on('data', (chunk) => {
-            data.push(chunk);
-          });
-          resp.on('end', () => {
-            const res = JSON.parse(data.join(''));
-            resolve({
-              name: res.name,
-              version: res.version,
-              ...(res.name.includes('@')
-                ? { fullname: res.name, name: res.name.split('/')[1] }
-                : {}),
-            });
-          });
-        },
-      )
-      .on('error', (err) => {
-        reject(err.message);
-      });
-  });
-}
-
-export async function getLocalAddonInfo({ source }) {
-  const packageJSON = JSON.parse(
-    fs.readFileSync(`${source}/package.json`, 'utf8'),
-  );
-
-  return {
-    name: packageJSON.name,
-    version: packageJSON.version,
-    ...(packageJSON.name.includes('@')
-      ? { fullname: packageJSON.name, name: packageJSON.name.split('/')[1] }
-      : {}),
-  };
-}

package/packages/scripts/addon/index.js

@@ -1,88 +0,0 @@
-#!/usr/bin/env node
-/* eslint no-console: 0 */
-/**
- * addon testing setup convenience script
- * @module scripts/addon
- */
-import { program } from 'commander';
-import chalk from 'chalk';
-import { runGitGenerator, runLocalGenerator } from './generators.js';
-import { consolidateAddon } from './consolidate.js';
-
-function cloneAddon({
-  source,
-  destination = 'addon-testing-project',
-  branch = 'main',
-  isPrivate,
-  isCanary = false,
-}) {
-  const isLocal = source === '.';
-
-  if (isLocal) {
-    console.log(
-      chalk.yellow(
-        'Using local configuration, remember to run this command at the root of your add-on',
-      ),
-      chalk.green(
-        `Copying current add-on data into the project ${chalk.yellow(
-          destination,
-        )}`,
-      ),
-    );
-
-    runLocalGenerator({
-      source,
-      destination,
-      branch,
-      isPrivate,
-      isCanary,
-      isLocal,
-    }).then();
-  } else {
-    console.log(
-      chalk.green(
-        `Cloning addon from ${chalk.yellow(
-          source,
-        )} and creating a testing environment in ${chalk.yellow(destination)}`,
-      ),
-    );
-
-    runGitGenerator({
-      source,
-      destination,
-      branch,
-      isPrivate,
-      isCanary,
-      isLocal,
-    }).then();
-  }
-}
-
-program
-  .command('clone <source> [destination]')
-  .description('clone a repository into a newly created directory')
-  .option(
-    '-p, --private',
-    'set if the repo is private, then GITHUB_TOKEN is used',
-  )
-  .option('-b, --branch <branch>', 'set the repo branch, defaults to main')
-  .option('-c, --canary', 'downloads latest Volto canary (alpha) version')
-  .action((source, destination, options) => {
-    cloneAddon({
-      source,
-      destination,
-      isPrivate: options.private,
-      isCanary: options.canary,
-      branch: options.branch,
-    });
-  });
-
-program
-  .command('consolidate [source]')
-  .description('Consolidate a cloned project')
-  .action((source = 'addon-testing-project') => {
-    consolidateAddon({
-      source,
-    });
-  });
-program.parse(process.argv);

package/packages/scripts/addon/utils.js

@@ -1,44 +0,0 @@
-import fs from 'fs';
-
-export function amendPackageJSON(name, destination, isCanary) {
-  const packageJSON = JSON.parse(
-    fs.readFileSync(`${destination}/package.json`, 'utf8'),
-  );
-  packageJSON.scripts = {
-    ...packageJSON.scripts,
-    test: `RAZZLE_JEST_CONFIG=src/addons/${name}/jest-addon.config.js razzle test --passWithNoTests`,
-    'cypress:open': `make test-acceptance-addon ADDONPATH=src/addons/${name}`,
-    'cypress:run': `make test-acceptance-addon-headless ADDONPATH=src/addons/${name}`,
-    'cypress:ci:full': `make full-test-acceptance-addon ADDONPATH=src/addons/${name}`,
-  };
-  fs.writeFileSync(
-    `${destination}/package.json`,
-    `${JSON.stringify(packageJSON, null, 2)}`,
-  );
-}
-
-export function createMrsDeveloperConfig(config) {
-  const template = { [config.name]: {} };
-  const packageName = config.fullname || config.name;
-  template[config.name].package = packageName;
-  template[config.name].url = config.source;
-  template[config.name].path = 'src';
-  template[config.name].branch = config.branch || 'main';
-
-  fs.writeFileSync(
-    `${config.destination}/mrs.developer.json`,
-    `${JSON.stringify(template, null, 2)}`,
-  );
-}
-
-export function createLocalMrsDeveloperConfig(config) {
-  const template = { [config.name]: {} };
-  const packageName = config.fullname || config.name;
-  template[config.name].package = packageName;
-  template[config.name].local = `addons/${config.name}/src`;
-
-  fs.writeFileSync(
-    `${config.destination}/mrs.developer.json`,
-    `${JSON.stringify(template, null, 2)}`,
-  );
-}

package/packages/scripts/backportpr.js

@@ -1,75 +0,0 @@
-/* eslint no-console: 0 */
-import https from 'https';
-import { execSync, exec } from 'child_process';
-
-if (process.argv.length < 2) {
-  console.log(process.argv.length);
-  process.exit(1);
-}
-
-const pr = process.argv[2];
-const URL = `https://api.github.com/repos/plone/volto/pulls/${pr}`;
-
-function getPRInfo(pr) {
-  return new Promise((resolve, reject) => {
-    https
-      .get(
-        URL,
-        {
-          headers: {
-            Authorization: `token ${process.env.GITHUB_TOKEN}`,
-            'User-Agent': 'node.js',
-            Accept: 'application/vnd.github+json',
-          },
-        },
-        (resp) => {
-          let data = [];
-          resp.on('data', (chunk) => {
-            data.push(chunk);
-          });
-          resp.on('end', () => {
-            const res = JSON.parse(data.join(''));
-            resolve({
-              branchName: res.head.ref,
-              mergeCommit: res.merge_commit_sha,
-            });
-          });
-        },
-      )
-      .on('error', (err) => {
-        reject(err.message);
-      });
-  });
-}
-
-function execCommand(command) {
-  return execSync(command, (error, stdout, stderr) => {
-    console.log(stdout);
-    if (error) {
-      console.log(`error: ${error.message}`);
-      return;
-    }
-    if (stderr) {
-      console.log(`stderr: ${stderr}`);
-      return;
-    }
-    return stdout;
-  });
-}
-
-async function main(params) {
-  const PRInfo = await getPRInfo(pr);
-
-  // const currentBranch = execCommand(
-  //   `git rev-parse --abbrev-ref HEAD`,
-  // ).toString();
-  // execCommand(`git co -b ${PRInfo.branchName}__${currentBranch.split('.')[0]}`);
-
-  // Now we do that in the same PR
-  execCommand(`git cherry-pick ${PRInfo.mergeCommit}`);
-
-  // execCommand(`git push`);
-  // execCommand(`git co $(git rev-parse --abbrev-ref HEAD)`);
-}
-
-main();