Skip to content

Instantly share code, notes, and snippets.

@confused-Techie

confused-Techie/pulsar_package_conventions.md

Created May 7, 2023 21:37
Show Gist options
  • Save confused-Techie/dcbc8d917e651b9dc17c264f247f840d to your computer and use it in GitHub Desktop.
Save confused-Techie/dcbc8d917e651b9dc17c264f247f840d to your computer and use it in GitHub Desktop.
Download ZIP
Pulsar Package Docs
Raw
pulsar_package_conventions.md

This is a short document, intended to be eventually transfered to the new Pulsar Documentation site.

Package Naming Conventions

When you create a Pulsar Package, there are several package naming conventions that can assist you into making sure your package is discoverable and it's intent is easily understood.

  • SERVICE-snippets: Appending -snippets to the end of a package name indicates this package only provides snippets of the afformentioned service.
  • autocomplete-SERVICE: Prepending autocomplete- to the beginning of a package name indicates this package only provides autocompletions for this specific service.
  • NAME-ui: Appending -ui to the end of a package name indicates this package is a UI theme.
  • NAME-syntax: Appending -syntax to the end of a package name indicates this package is a Syntax Theme.
  • language-SERVICE: Prepending language- to the start of a package name indicates this package provides syntax highlighting for the specific language.
  • linter-SERVICE: Prepending linter- to the start of a package name indicates this package provides linting for the specific service.
  • SERVICE-generator: Appending -generator to the end of a package name indicates this package generates content. Such as automatically creating a file, or adding content to an existing file.
  • build-SERVICE: Prepending build- to the start of a package name indicates this package provides capabilities to build projects or platforms.
  • ide-SERVICE: Prepending ide- to the start of a package name indicates this package provides capabilities to preform as an IDE of the specific service or language.
  • service-NAME: Prepending service- to the start of a package name indicates this package provides a new Service via the Service Hub for other packages to consume.
  • SERVICE-helper: While this seems to be a widely used format by the community there does not seem to be consencious on it's purpose.
  • SERVICEsearch: The format here varies, many packages using SERVICE-search or search-SERVICE but generally used to indicate when a package provides capbilities to search content via another website or service.
  • SERVICE-tools: Provides several tools for the service.
  • SERVICE-uploader: Provides abilities to upload content to remote services.

Beyond this there are a few contenders to other community made conventions, such as possibly the usage of paste in package titles.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment