#Naming Convention

0 Followers · 3 Posts

Naming Convention is an agreement across the ecosystem or the technology stack on how to name classes, packages, files, package names, resources names, etc.

Article Evgeny Shvarov · Nov 12, 2019 3m read

Hi Developers!

Suppose you want to create your ObjectScript library to be distributed via ObjectScript Package Manager. And there is an obvious question: what is the naming convention on the packages and class names?

Naming packages and classnames

There is already some accepted practice with package managers and we will follow the best practices in this field. The most reasonable and simple looks the approach with having company as the first package then project as the second and then classes and subpackages of the project.

The folder structure in this case looks like:

6
2 1068
Discussion Evgeny Shvarov · Nov 29, 2021

Hi, Community!

Open Exchange (OEX) is getting more and more popular and more and more developers consider publishing their apps in the public package managerregistry.

This is really great!

So the topic of thoughtful naming convention is getting more important and even critical.  Let's discuss?

6
1 556
Discussion Evgeny Shvarov · Jun 11, 2020

Hi Devs!

A few months ago I raised a discussion on the naming convention for ZPM modules.

And you free to put your name or your organization name for the packages you want to have your personal or company's brand.

But if you contribute to community, we suggested to have "community." package for all such libraries.

But the name is too long.

What if we use "isc." instead?  Which can be read as "isc ->InterSystemsCommunity". Short and unique.

What do you think?

 
19
1 579