Eslint naming conventions #19880

iOvergaard · 2025-08-07T13:53:45Z

Description

Tries to mimic the existing code base whilst fixing a few inconsistencies to make sure we have correct naming, and most importantly, that we do not expose properties that are supposed to be private (i.e., leading underscore).

This also removes the need for a few of the "local rules" as this plugin now handles them: import/naming-conventions.

Fixes AB#52379

Classes/interfaces

// 🔴  NOT OK
export class SomeClass {}

// ✅ OK
export class UmbSomeClass {}
export class UfmSomeClass {}
export interface ManifestSomeType {}
export interface MetaElement {}
export class ExampleClass {}

Members of "something", including class methods

// 🔴  NOT OK
private someProperty; // No leading _underscore
public _someProperty; // Leading underscore
#_someMethod() // Leading underscore

// ✅ OK
private _someProperty; // Leading _underscore
protected _someProperty; // (Optional) leading _underscore
public someProperty; // No leading underscore
#someMethod() // No leading underscore

Quoted members

// ✅  STILL OK
declare global {
  interface HTMLElementTagNameMap {
    'umb-some-element': UmbSomeElement
  }
}

Exported constants

// 🔴  NOT OK
export const all_lowercase = 'test'; // Lowercase and no leading UMB_

// ✅ OK
export const UMB_MY_VALUE = 'test'; // UPPER_CASE and leading UMB_

Caveats

Have to ignore all language files due to weird keys
Have to ignore umbraco-package.ts files (also ignored before) due to convention around exports
Have to allow certain prefixes such as "Manifest" and "Meta" because of established convention around the extension API
Have to allow a special property called _host because it is used as a public property in all controllers (= all over the system which makes it massively breaking to change.

…kage.ts)

… it is too harsh

github-actions · 2025-08-07T14:27:46Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://orange-sea-0c7411a03-19880.westeurope.6.azurestaticapps.net

github-actions · 2025-08-07T14:27:51Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://victorious-ground-017b08103-19880.westeurope.6.azurestaticapps.net

github-actions · 2025-08-08T07:34:38Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://victorious-ground-017b08103-19880.westeurope.6.azurestaticapps.net

github-actions · 2025-08-08T07:34:46Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://orange-sea-0c7411a03-19880.westeurope.6.azurestaticapps.net

github-actions · 2025-08-08T07:45:10Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://orange-sea-0c7411a03-19880.westeurope.6.azurestaticapps.net

github-actions · 2025-08-08T07:45:14Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://victorious-ground-017b08103-19880.westeurope.6.azurestaticapps.net

github-actions · 2025-08-08T07:46:26Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://orange-sea-0c7411a03-19880.westeurope.6.azurestaticapps.net

github-actions · 2025-08-08T07:46:35Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://victorious-ground-017b08103-19880.westeurope.6.azurestaticapps.net

github-actions · 2025-08-08T07:48:45Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://orange-sea-0c7411a03-19880.westeurope.6.azurestaticapps.net

github-actions · 2025-08-08T07:48:50Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://victorious-ground-017b08103-19880.westeurope.6.azurestaticapps.net

github-actions · 2025-08-08T07:50:53Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://victorious-ground-017b08103-19880.westeurope.6.azurestaticapps.net

github-actions · 2025-08-08T07:50:57Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://orange-sea-0c7411a03-19880.westeurope.6.azurestaticapps.net

github-actions · 2025-08-08T08:08:08Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://orange-sea-0c7411a03-19880.westeurope.6.azurestaticapps.net

github-actions · 2025-08-08T08:08:09Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://victorious-ground-017b08103-19880.westeurope.6.azurestaticapps.net

nielslyngsoe

Beautiful, I've read through and added a few more deprecated proxy types or properties.

Some I have taken the risk of concluding no one would be using or should be using. In general, i would say we are generous with these changes. accommodating various hacks as many of these properties should never have been used by external code. But lets see time will tell.

github-actions · 2025-08-08T08:11:44Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://victorious-ground-017b08103-19880.westeurope.6.azurestaticapps.net

github-actions · 2025-08-08T08:11:57Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://orange-sea-0c7411a03-19880.westeurope.6.azurestaticapps.net

github-actions · 2025-08-08T08:18:21Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://victorious-ground-017b08103-19880.westeurope.6.azurestaticapps.net

github-actions · 2025-08-08T08:18:29Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://orange-sea-0c7411a03-19880.westeurope.6.azurestaticapps.net

iOvergaard added 30 commits August 7, 2025 11:38

build(eslint): replace local rules with naming conventions

c949bf3

revert relative js extension imports

cf47838

remove unused local rule

8337192

build(eslint): uses recommended setup for import plugin

10e75cf

chore(eslint): conver const to function to follow naming conventions

b298101

chore: removes old file

dc59ddd

build(eslint): allows Ufm as prefix

dc73dac

build(eslint): allows 'name' and 'extensions' as exports (umbraco-pac…

5c4ad31

…kage.ts)

build(eslint): typescript rules should ignore storybook

813f366

chore(eslint): ignores eslint for vite definitions

62c35ed

build(eslint): allows UPPER_CASE for properties

f74bd3b

build(eslint): ignores umbraco-package.ts files (unconventional exports)

3d610ed

chore(storybook): fixes property editor stylesheet picker

411685f

build(eslint): allows Manifest as prefix on interfaces

e19007a

build(eslint): allows underscore on protected members

6f5247c

build(eslint): allows Meta as prefix on interfaces

d0fae4b

build(eslint): allows PascalCase for public members

b7ba94a

build(eslint): disables enforcement of booleans with verbs for now as…

d15e8a3

… it is too harsh

chore(eslint): add private modifiers as required

d9c89b1

deprecates invalid constant name to replace with Umb prefix

a40a1e0

renames MediaValueType to comply with naming conventions

2ac08a9

chore(eslint): disable naming conventions for local router-slot package

10bbb49

chore(eslint): follow naming conventions

ad8cc75

chore(eslint): disable naming conventions for property editor interfaces

ecdfa89

chore(eslint): follow naming conventions

25ca728

chore(storybook): fix story

7ce7af8

chore(eslint): follow naming conventions

d281cc2

build(eslint): allows _host as public variable

5a8b855

chore(eslint): follow naming conventions

d042c6a

build(eslint): allows double leading underscore on public members

58c144f

proxy type for UrlParametersRecord

07a1b4c

nielslyngsoe added 2 commits August 8, 2025 09:42

_items deprecated property

3ee209b

bring back ConditionTypes type

5b0e842

bring back _items for trash bulk action

53208a3

ignorer deprecated proxies

86eee33

keep settingsDataContentTypeKey for satefy

7ae9026

nielslyngsoe approved these changes Aug 8, 2025

View reviewed changes

Merge branch 'main' into v16/chore/eslint-naming-conventions

dbd92da

nielslyngsoe enabled auto-merge (squash) August 8, 2025 08:09

fix disable line

5d07422

nielslyngsoe merged commit 2def046 into main Aug 8, 2025
27 checks passed

nielslyngsoe deleted the v16/chore/eslint-naming-conventions branch August 8, 2025 08:52

Eslint naming conventions #19880

Eslint naming conventions #19880

Uh oh!

Conversation

iOvergaard commented Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Caveats

Uh oh!

github-actions bot commented Aug 7, 2025

Uh oh!

github-actions bot commented Aug 7, 2025

Uh oh!

github-actions bot commented Aug 8, 2025

Uh oh!

github-actions bot commented Aug 8, 2025

Uh oh!

github-actions bot commented Aug 8, 2025

Uh oh!

github-actions bot commented Aug 8, 2025

Uh oh!

github-actions bot commented Aug 8, 2025

Uh oh!

github-actions bot commented Aug 8, 2025

Uh oh!

github-actions bot commented Aug 8, 2025

Uh oh!

github-actions bot commented Aug 8, 2025

Uh oh!

github-actions bot commented Aug 8, 2025

Uh oh!

github-actions bot commented Aug 8, 2025

Uh oh!

github-actions bot commented Aug 8, 2025

Uh oh!

github-actions bot commented Aug 8, 2025

Uh oh!

nielslyngsoe left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Aug 8, 2025

Uh oh!

github-actions bot commented Aug 8, 2025

Uh oh!

github-actions bot commented Aug 8, 2025

Uh oh!

github-actions bot commented Aug 8, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

iOvergaard commented Aug 7, 2025 •

edited

Loading