Back to all reviewers

Consistent Fastify Package Naming and References

fastify/fastify
Based on 2 comments
TypeScript

When implementing code using the Fastify package in TypeScript, it is important to use consistent and accurate naming conventions for Fastify-related references: always use the actual Fastify package name, use correct Fastify terminology and casing, and organize Fastify-related imports and references alphabetically.

Fastify TypeScript

Reviewer Prompt

When implementing code using the Fastify package in TypeScript, it is important to use consistent and accurate naming conventions for Fastify-related references:

  • Always use the actual Fastify package name (fastify) rather than referring to the Fastify repository or other informal names.
  • When referencing Fastify types, plugins, or other Fastify-specific concepts, use the correct Fastify terminology and casing (e.g. FastifyInstance, fastify.get()).
  • Organize Fastify-related imports and references alphabetically to maintain consistency and make the code easier to navigate.

Example:

// Preferred: Using the correct Fastify package name and terminology
import fastify, { FastifyInstance, FastifyReply, FastifyRequest } from 'fastify';

// Instead of informal references
import { createFastifyApp } from 'my-fastify-utils';

// Preferred: Alphabetized Fastify imports
import { FastifyPluginAsync } from 'fastify';
import fastifyAuth from '@fastify/auth';
import fastifyCors from '@fastify/cors';

Following these conventions will improve the maintainability of your Fastify-based codebase and make it easier for other developers to understand and work with the Fastify package correctly.

2
Comments Analyzed
TypeScript
Primary Language
Fastify
Category

Source Discussions