Naming Conventions

Naming Conventions Overview

At its core, naming conventions is about doing one thing well inside your single-spa project. Once you understand the pattern, you can apply it consistently across features and teams.

Good naming conventions pays off across the whole codebase: fewer surprises, easier testing, and smoother onboarding. The snippet below is a solid starting point.

import { registerApplication, start } from 'single-spa';

registerApplication({
  name: '@org/app',
  app: () => System.import('@org/app'),
  activeWhen: ['/app'],
});

start();

single-spa orchestrates multiple framework apps on one page through a root config.

Naming Conventions Example

registerApplication({
  name: '@org/app',
  app: () => System.import('@org/app'),
  activeWhen: ['/app'],
});
start();

• Start from a minimal Naming Conventions example and grow it only as needed.
• Keep configuration explicit so Naming Conventions behaves the same in every environment.
• Name things clearly so teammates understand your Naming Conventions at a glance.
• Add tests around Naming Conventions early to lock in expected behaviour.

Single-SPA Cheatsheet

Core single-spa APIs related to naming conventions.

How Naming Conventions Works in Single-SPA

Naming Conventions is part of how single-spa lets multiple applications — even in different frameworks — coexist on one page. A root config registers each app and controls when it is active.

single-spa orchestrates multiple framework apps on one page through a root config.

• A root config registers apps and calls start().
• Each app exports bootstrap, mount, and unmount lifecycles.
• activeWhen decides which routes each app owns.
• Import maps resolve each app's bundle at runtime.

Practical Guidance for Naming Conventions

For reliable micro frontends, naming conventions should isolate failures and keep shared state minimal. Let each team own its app end to end while agreeing on a few shared contracts.

Common Mistakes

• Skipping error handling and edge cases when wiring up naming conventions.
• Leaving naming conventions untested, so regressions slip into production.
• Over-engineering naming conventions before you actually need the extra flexibility.
• Ignoring documentation, which makes naming conventions hard for the next developer to change.

Key Takeaways

• Naming Conventions is a core part of working effectively with single-spa.
• Start small and keep naming conventions focused on a single responsibility.
• Apply consistent patterns so naming conventions scales across your project.
• Test and document naming conventions to keep it maintainable over time.