Cannot name a decorator flags lib linter or onEmit (special exports)

[timotheeguerin]

Problem

Cannot name a decorator flags lib linter or onEmit (special exports)
Due to how to use certain reserved name in JS we cannot name a decorator with those names

Add a new $decorators export

export const $decorators = {
  Azure.Core: {
    flags: $flags,
    "foo-bar": fooBarDecorator
  }
}

we can additionally provide a typed helper

function defineDecorators(decorators: Record<string, Record<string, DecoratorFunction>>) {
   return decorators;
}

export const $decorators = defineDecorators({
  Azure.Core: {
    flags: $flags,
    "foo-bar": fooBarDecorator
  }
})

Additional items

• Update docs to recommend this approach
• Update tspd to only support this new approach. This isn't breaking as tspd is not published yet.

[timotheeguerin]

Option 1: USe $$ for known configs

This would reserve $ for decorators. For back compat we would still check if the $ variant of $lib, $flags, etc. is a config object and use that instead.

Issues with this approach:

1. Still cannot exports reserved js names or non js identifiers that could technically be valid decorator names(e.g. foo-bar)
2. Subset of above How do I name a decorator @$flags

Option 2: Dedicated $decorators export

this allows to exports all decorators

export const $decorators = {
  flags: $flags,
  "foo-bar": fooBarDecorator
}

this could even solve the confusing way namespace are defined in JS

export const $decorators = {
  Azure.Core: {
    flags: $flags,
    "foo-bar": fooBarDecorator
  }
}

[markcowl]

• Need to triage for scheduled changes

[markcowl]

est: 5