piral-cli/src/rules/piral-has-valid-scripts.ts

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

import { PiralRuleContext } from '../types';

export type Options = void;

/**
 * Checks that the scripts defined for pilets are valid.
 */
export default function (context: PiralRuleContext, options: Options = undefined) {
  const { scripts } = context.info;

  if (typeof scripts !== 'object') {
    context.error(
      `
The scripts in pilets.scripts are invalid.
  Expected: <object>.
  Received: <${typeof scripts}>.
`,
    );
  } else {
    const invalidScripts = Object.keys(scripts).filter((key) => typeof scripts[key] !== 'string');

    if (invalidScripts.length > 0) {
      context.error(
        `
The scripts in pilets.scripts are invalid.
  Expected: Only commands (<string>) in the array.
  Received: Found ${invalidScripts.length} invalid entries.
  `,
      );
    }
  }
}