Skip to content

Inconsistent file extensions between apm.yml and apm.lock.yaml #745

@yshrsmz

Description

@yshrsmz

Summary

APM currently uses:

  • apm.yml for the manifest
  • apm.lock.yaml for the lockfile

These two files are both YAML-based, but use different file extensions (.yml vs .yaml), which feels inconsistent.

Problem

This inconsistency can be slightly confusing for users, especially since both files are:

  • YAML 1.2 documents
  • Core project configuration files
  • Expected to be committed to version control

Most ecosystems tend to keep naming consistent across manifest and lockfile (e.g. package.json / package-lock.json, pnpm-lock.yaml, etc.).

Proposal

Unify the file extensions for consistency. For example:

Option A:

  • apm.yml
  • apm.lock.yml

Option B:

  • apm.yaml
  • apm.lock.yaml

Notes

  • The lockfile was renamed from apm.lock to apm.lock.yaml for IDE syntax highlighting (per lockfile spec).
  • However, the choice of .yaml over .yml, and the inconsistency with apm.yml, is not explained in the current documentation.

Question

Was this inconsistency intentional?

If not, would you consider aligning the extensions for better consistency and developer experience?

Metadata

Metadata

Assignees

No one assigned

    Labels

    acceptedDirection approved, safe to start workenhancementNew feature or requestgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions