Goal-oriented target field name schema

[thejcannon]

We're starting to add (or want to add) more fields to targets that are single-goal oriented. Without some formal schema I can see us reeeeeally splatting the names here (much like our env field/option handling), so I want us to discuss and decide on a schema.

As a noodle-tickler, I'd love to add plugin fields to targets for skipping them in the multi-tool goals. E.g. python_source has skip_fmt or fmt_skip, etc...

There is (AFAIK) one single existing art: python_source's run_goal_use_sandbox.
So the current de-facto standard is <goal_name>_goal_<behavior>.

[thejcannon]

My own 2c is that run_goal_use_sandbox is too terse, and limits itself to only one goal. I think we should name fields "generically" even if we have a goal in mind. In that case the schema would be to not include the goal name anywhere and find a better, more generic name.

In the case of run_goal_use_sandbox, it'd be like interactive_execution_use_sandbox. That'd also cover repl or notebooks (if supported).

[kaos]

+2

[cognifloyd]

run_goal_use_sandbox -> sandbox_adhoc_execution
I don't think terseness is the problem with run_goal_use_sandbox. The problem is that it is difficult to read as a hierarchical thing: "run goal: use sandbox". Instead, it needs to be more sentence-like.

For behavioral field names, I'd like to see the verb come first: <verb>_<noun>
This follows the precedent of skip_<tool> fields (skip_black, skip_flake8, ...).

There are ALSO namespaced tool options --<tool>-skip (--black-skip, --flake8-skip, ...). But we are talking about fields here, not the CLI args. For config options and cli options, the namespacing happens automatically. Sub-namespacing the option under the goal name here really makes this option difficult to grok without reading the docs. For example, compare --[no-]python-enable-resolves vs --[no-]python-default-run-goal-use-sandbox. So, the precedent to follow for cli/options is <subsystem>-<verb>-<noun> where subsystem is added automatically as a side-effect of the config system architecture.