piral-cli/src/rules/pilet-uses-latest-piral.ts

The standard CLI for creating and building a Piral instance or a Pilet.

import { isMonorepoPackageRef, findLatestVersion, determineNpmClient } from '../common';
import { PiletRuleContext } from '../types';

export type Options = 'suggest' | 'required' | 'ignore';

/**
 * Checks if the used Piral instance is used at its latest version.
 */
export default async function (context: PiletRuleContext, options: Options = 'suggest') {
  if (options !== 'ignore') {
    const { name, version } = context.apps[0].appPackage;
    const demanded = (context.devDependencies && context.devDependencies[name]) || '';
    const isfixed = demanded.startsWith('git+') || demanded.startsWith('file:');

    if (!isfixed) {
      const npmClient = await determineNpmClient(context.root);
      const isMonorepoRef = await isMonorepoPackageRef(name, npmClient);

      // either we are not in a monorepo or the app shell is not part of the monorepo
      if (!isMonorepoRef) {
        const latestVersion = await findLatestVersion(name).catch((err) => {
          context.warning(`
  The used version of "${name}" could not be determined: ${err}.
          `);
          return version;
        });

        if (version !== latestVersion) {
          const notify = options === 'required' ? context.error : context.warning;
          notify(
            `
  The used version of "${name}" is outdated.
    Expected: v${latestVersion}.
    Received: v${version}.
  `,
          );
        }
      }
    }
  }
}