strapi/packages/strapi-generate-api/lib/before.js

'use strict';

/**
 * Module dependencies
 */

// Node.js core.
const fs = require('fs');
const path = require('path');

// Public node modules.
const _ = require('lodash');
const pluralize = require('pluralize');

// Fetch stub attribute template on initial load.
const attributeTemplate = fs.readFileSync(
  path.resolve(__dirname, '..', 'templates', 'attribute.template'),
  'utf8'
);
/* eslint-disable prefer-template */
/**
 * This `before` function is run before generating targets.
 * Validate, configure defaults, get extra dependencies, etc.
 *
 * @param {Object} scope
 * @param {Function} cb
 */

module.exports = (scope, cb) => {
  if (!scope.rootPath || !scope.id) {
    return cb.invalid('Usage: `$ strapi generate:api apiName`');
  }

  // Check `api` and `plugin` parameters
  const parent = scope.args.api || scope.args.plugin;

  // Format `id`.
  scope.id = _.trim(_.camelCase(scope.id));

  // `scope.args` are the raw command line arguments.
  _.defaults(scope, {
    idPluralized: pluralize.plural(_.trim(_.camelCase(scope.id))),
    parentId: _.isEmpty(parent) ? undefined : _.trim(_.deburr(parent)),
    parentIdPluralized: _.isEmpty(scope.parentId)
      ? undefined
      : pluralize.plural(_.trim(_.camelCase(scope.parentId))),
    environment: process.env.NODE_ENV || 'development',
  });

  // Determine default values based on the available scope.
  _.defaults(scope, {
    globalID: _.upperFirst(_.camelCase(scope.id)),
    ext: '.js',
  });

  // Take another pass to take advantage of the defaults absorbed in previous passes.
  _.defaults(scope, {
    rootPath: scope.rootPath,
    filename: `${scope.globalID}${scope.ext}`,
    filenameSettings: scope.globalID + '.settings.json',
    folderPrefix: !scope.args.api && scope.args.plugin ? 'plugins' : 'api',
    folderName: _.camelCase(scope.parentId || scope.id).toLowerCase(),
  });

  // Humanize output.
  _.defaults(scope, {
    humanizeId: _.camelCase(scope.id).toLowerCase(),
    humanizeIdPluralized: pluralize.plural(_.camelCase(scope.id).toLowerCase()),
    humanizedPath: `\`./${scope.folderPrefix}/${
      scope.parentId ? '' + scope.folderName : ''
    }\``,
  });

  // Validate optional attribute arguments.
  const invalidAttributes = [];

  // Map attributes and split them for CLI.
  scope.attributes = scope.args.attributes.map(attribute => {
    if (_.isString(attribute)) {
      const parts = attribute.split(':');

      parts[1] = parts[1] || 'string';

      // Handle invalid attributes.
      if (!parts[1] || !parts[0]) {
        invalidAttributes.push(
          'Error: Invalid attribute notation `' + attribute + '`.'
        );
        return;
      }

      return {
        name: _.trim(_.deburr(parts[0].toLowerCase())),
        params: {
          type: _.trim(_.deburr(parts[1].toLowerCase())),
        },
      };
    } else {
      return _.has(attribute, 'params.type') ? attribute : undefined;
    }
  });

  scope.attributes = _.compact(scope.attributes);

  // Handle invalid action arguments.
  // Send back invalidActions.
  if (invalidAttributes.length) {
    return cb.invalid(invalidAttributes);
  }

  // Make sure there aren't duplicates.
  if (
    _(scope.attributes.map(attribute => attribute.name))
      .uniq()
      .valueOf().length !== scope.attributes.length
  ) {
    return cb.invalid('Duplicate attributes not allowed!');
  }

  // Render some stringified code from the action template
  // and make it available in our scope for use later on.
  scope.attributes = scope.attributes
    .map(attribute => {
      const compiled = _.template(attributeTemplate);
      return _.trimEnd(
        _.unescape(
          compiled({
            name: attribute.name,
            params: attribute.params,
          })
        )
      );
    })
    .join(',\n');

  // Set collectionName
  scope.collectionName = _.has(scope.args, 'collectionName')
    ? scope.args.collectionName
    : undefined;

  // Set description
  scope.description = _.has(scope.args, 'description')
    ? scope.args.description
    : undefined;

  // Get default connection
  try {
    scope.connection =
      _.get(scope.args, 'connection') ||
      JSON.parse(
        fs.readFileSync(
          path.resolve(
            scope.rootPath,
            'config',
            'environments',
            scope.environment,
            'database.json'
          )
        )
      ).defaultConnection ||
      '';
  } catch (err) {
    return cb.invalid(err);
  }

  // Trigger callback with no error to proceed.
  return cb.success();
};