website/src/data/__tests__/user.test.ts - main - githubmirror/docusaurus

website/src/data/__tests__/user.test.ts
142 строки5 KB
Sébastien Lorber
refactor(test): use explicit Vitest imports, disable globals (#12019)
15 май 2026, 11:01
15 май 2026, 11:01057ab88
/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

import {describe, expect, it} from 'vitest';
import fs from 'fs-extra';
import path from 'path';
import _ from 'lodash';
import {imageSizeFromFile} from 'image-size/fromFile';
import {Joi} from '@docusaurus/utils-validation';
import {TagList, sortedUsers, type User} from '../users';

describe('users data', () => {
  it.each(sortedUsers)('$title', (user: User) => {
    Joi.attempt(
      user,
      Joi.object<User>({
        title: Joi.string().required(),
        description: Joi.string()
          .required()
          .max(120)
          .message(
            'Please constrain your description text to maximum 120 characters.',
          ),
        website: Joi.string()
          .pattern(/^https?:\/\//)
          .message('')
          .required(),
        // The preview should be null
        // See "test/setup.ts"
        preview: Joi.object({default: Joi.any()})
          .unknown(false)
          .allow(null)
          .required()
          .messages({
            'object.base':
              'The image should be hosted on Docusaurus site, and not use remote HTTP or HTTPS URLs. It must be imported with require().',
          }),
        tags: Joi.array()
          .items(...TagList)
          .required(),
        source: Joi.string().allow(null).required().messages({
          'any.required':
            "The source attribute is required.\nIf your Docusaurus site is not open-source, please make it explicit with 'source: null'.",
        }),
      }).unknown(false),
    );
    // cSpell:ignore opensource
    if (user.tags.includes('opensource') && user.source === null) {
      throw new Error(
        "You can't add the 'opensource' tag to a site that does not have a link to source code. Please add your source code, or remove this tag.",
      );
    } else if (user.source !== null && !user.tags.includes('opensource')) {
      throw new Error(
        "For open-source sites, please add the 'opensource' tag.",
      );
    }
  });

  it('does not contain duplicates', () => {
    function normalizeUrl(url: string | null) {
      if (url === null) {
        return null;
      }
      if (!url.endsWith('/')) {
        return `${url}/`;
      }
      return url;
    }

    function duplicatesBy(mapper: (user: User) => string | null) {
      const grouped: {[key: string]: User[]} = _.groupBy(sortedUsers, (user) =>
        mapper(user),
      );
      return Object.fromEntries(
        Object.entries(grouped).filter((entry) => entry[1].length > 1),
      );
    }

    let duplicatesLog = '';

    const duplicatesByTitle = duplicatesBy((user) =>
      user.title.trim().toLowerCase(),
    );
    Object.entries(duplicatesByTitle).forEach(([title, users]) => {
      duplicatesLog += `Showcase site title '${title}' is used ${users.length} times! Duplicates are not allowed!\n`;
    });

    const duplicatesByDescription = duplicatesBy((user) =>
      user.description.trim().toLowerCase(),
    );
    Object.entries(duplicatesByDescription).forEach(([description, users]) => {
      duplicatesLog += `Showcase site description '${description}' is used ${users.length} times! Duplicates are not allowed!\n`;
    });

    const duplicatesByWebsite = duplicatesBy((user) =>
      normalizeUrl(user.website),
    );
    Object.entries(duplicatesByWebsite).forEach(([website, users]) => {
      duplicatesLog += `Showcase site website url '${website}' is used ${users.length} times! Duplicates are not allowed!\n`;
    });

    const duplicatesBySource = duplicatesBy((user) =>
      normalizeUrl(user.source),
    );
    Object.entries(duplicatesBySource).forEach(([source, users]) => {
      // source is allowed to be null for multiple sites
      // "null", see Lodash groupBy issue: https://github.com/lodash/lodash/issues/3060
      if (source && source !== 'null') {
        duplicatesLog += `Showcase site source url '${source}' is used ${users.length} times! Duplicates are not allowed!\n`;
      }
    });

    if (duplicatesLog) {
      throw new Error(duplicatesLog);
    }
  });
});

describe('preview images have good dimensions', () => {
  const imageDir = path.join(__dirname, '../showcase');
  // eslint-disable-next-line no-restricted-properties
  const files = fs
    .readdirSync(imageDir)
    .filter((file) => ['.png', 'jpg', '.jpeg'].includes(path.extname(file)));

  it.each(files)('%s', async (file: string) => {
    const {width, height} = await imageSizeFromFile(path.join(imageDir, file));
    const aspectRatio = width / height;
    expect(
      aspectRatio,
      `The preview image's aspect ratio (aspectRatio=${aspectRatio}, width=${width}, height=${height})`,
    ).toBeLessThanOrEqual(2);
    expect(
      width,
      `The preview image's width (${width})`,
    ).toBeGreaterThanOrEqual(640);
  });
});