microsoft / microsoft/vscode-makefile-tools

Add support for cpptools-api v6 - Use compilerFragments instead of compilerArgs

Open
#352 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
242
Forks
78
PR merge metrics
No merged PRs in 30d

Description

In cpptools-api v6, a new field was added (compilerFragments) to disambiguate whether shell quoting/escaping is expected or not in compiler arguments. compilerFragments is used specifically for command line fragments (potentially containing shell quoting and/or escaping), with compilerArgs intended for compiler arguments that do not contain any shell quoting or escaping.

In the case of makefile tools, that should remove the necessity of having to parse the command line into separate arguments to send in compilerArgs. compilerFragments can accept multiple arguments in a single entry, and cpptools will parse them as the shell would to divide them into arguments.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the makefile-tools integration that currently parses command lines and populates compilerArgs. Read the cpptools-api v6 definitions and trace how compiler arguments are sent; done means makefile command fragments are passed through compilerFragments without unnecessary argument parsing, with existing tests updated or added if available.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, typescript
Domain
build-system, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.