apache / apache/daffodil-vscode

package.json:contributes/configuration should have namespaced properties

Open
#713 0 comments 0 reactions 0 assignees View on GitHub
code quality configuration typescript
Dominant language
TypeScript
Stars
18
Forks
33
Avg merge
3d 6h
Merged PRs (30d)
7

Description

Our configuration contribution of the extension, which holds extension property settings, doesn't namespace the property names, which seems [to go against recommendations](https://code.visualstudio.com/api/references/contribution-points#contributes.configuration). At runtime all settings are stored in a shared property map, so we could be accidentally clobbering properties by not having a namespace.

We can also load only our settings via:
```diff
- const defaultConf = vscode.workspace.getConfiguration()
+ const defaultConf = vscode.workspace.getConfiguration('daffodil')
```

At the same time, we seem to use the pseudo-namespace `dfdl` in places, and perhaps we should use the more readable `daffodil`. But also, the extension itself uses the id `apache-daffodil-vscode`, so perhaps that should be the namespace we use in all configuration.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with package.json's contributes/configuration entry and search the extension for getConfiguration, including the shown defaultConf call and uses of the dfdl or daffodil pseudo-namespaces. Determine which namespace should be standard and identify every affected setting reference. Done means the contribution names and runtime lookups consistently use the agreed namespace without changing unrelated settings.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, vscode
Domain
developer-experience, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.