Add option to specify formatter command

Your environment

vscode-ruby version: 0.25.3
Ruby version: 2.6.5
Ruby version manager (if any): RVM
VS Code version: 1.39.2
Operating System: Ubuntu 18.04 via Remote:SSH extension on Win10
Using language server? (eg useLanguageServer is true?) Yes

Expected behavior

I have a rails project setup with rubocop as the linter & formatter, and the spring-commands-rubocop gem to try and speed things up. The linter portion of the extension for this setup works great, but there's no option to use the formatter with it. It'd be nice to have the same options for running formatters that there is for linters so this way I can specify my spring binstub for the rubocop formatter. Here's an example config of what I'd like:

{
  "ruby.lint": {
    "rubocop": {
      "command": "bin/rubocop"
    }
  },
  "ruby.format": {
    "rubocop": {
      "command": "bin/rubocp"
    }
  }
}

And what the output of "Ruby Language Server" would show:

Lint: executing bin/rubocop -s /path/to/project/app/controllers/sessions_controller.rb -f json...
Running via Spring preloader in process XXXXX
Format: executing bin/rubocop -s /path/to/project/app/controllers/sessions_controller.rb -a...
Running via Spring preloader in process XXXXX

Actual behavior

The current behavior doesn't allow selecting a command path for the formatter, instead only supporting a toggle of running through bundle exec. This doesn't allow for formatters to be ran through spring, which could potentially save time on formatter execution.

Current config:

{
  "ruby.lint": {
    "rubocop": {
      "command": "bin/rubocop"
    }
  },
  "ruby.format": "rubocop",
  "ruby.useBundler": true
}

Current output:

Lint: executing bin/rubocop -s /path/to/project/app/controllers/sessions_controller.rb -f json...
Running via Spring preloader in process 27599
Format: executing bundle exec rubocop -s /path/to/project/app/controllers/sessions_controller.rb -a...

Would like to see this as well. Perhaps just an option for rubocop path which the linter and formatter can use.

I would also like this.
I think the change just has to happen here.

vscode-ruby/server/src/formatters/RuboCop.ts

Line 9 in 9e1f537

const command = 'rubocop';

Also interested. Assuming you're using the language server the relevant code difference is:

vscode-ruby/packages/language-server-ruby/src/Linter.ts

Lines 27 to 48 in b232cfd

    
           function getLinter( 
        
           	name: string, 
        
           	document: TextDocument, 
        
           	env: RubyEnvironment, 
        
           	config: RubyConfiguration 
        
           ): ILinter { 
        
           	if (!config.workspaceFolderUri) { 
        
           		return new NullLinter( 
        
           			`unable to lint ${document.uri} with ${name} as its workspace root folder could not be determined` 
        
           		); 
        
           	} 
        
           	const linter = LINTER_MAP[name]; 
        
           	if (!linter) return new NullLinter(`attempted to lint with unsupported linter: ${name}`); 
        
           	const lintConfig: RubyCommandConfiguration = 
        
           		typeof config.lint[name] === 'object' ? config.lint[name] : {}; 
        
           	const linterConfig: LinterConfig = { 
        
           		env, 
        
           		executionRoot: URI.parse(config.workspaceFolderUri).fsPath, 
        
           		config: lintConfig, 
        
           	}; 
        
           	return new linter(document, linterConfig); // eslint-disable-line new-cap 
        
           }

vs.

vscode-ruby/packages/language-server-ruby/src/Formatter.ts

Lines 29 to 54 in b232cfd

    
           function getFormatter( 
        
           	document: TextDocument, 
        
           	env: RubyEnvironment, 
        
           	config: RubyConfiguration, 
        
           	range?: Range 
        
           ): IFormatter { 
        
           	// Only format if we have a formatter to use and an execution root 
        
           	if (typeof config.format === 'string' && config.workspaceFolderUri) { 
        
           		const formatterConfig: FormatterConfig = { 
        
           			env, 
        
           			executionRoot: URI.parse(config.workspaceFolderUri).fsPath, 
        
           			config: { 
        
           				command: config.format, 
        
           				useBundler: config.useBundler, 
        
           			}, 
        
           		}; 
        
           		if (range) { 
        
           			formatterConfig.range = range; 
        
           		} 
        
           		return new FORMATTER_MAP[config.format](document, formatterConfig); 
        
           	} else { 
        
           		return new NullFormatter(); 
        
           	} 
        
           }

@wingrunr21

@wingrunr21 hi, just wondering if this is something you'd like to implement in the future? :) Could really help with rubocop-daemon integration.

What are the issues that prevent rubocop from being fed a different or custom path for linting vs. formatting?

Navigation Menu

Repository navigation

Add option to specify formatter command #548

Your environment

Expected behavior

Actual behavior

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	function getLinter(
	name: string,
	document: TextDocument,
	env: RubyEnvironment,
	config: RubyConfiguration
	): ILinter {
	if (!config.workspaceFolderUri) {
	return new NullLinter(
	`unable to lint ${document.uri} with ${name} as its workspace root folder could not be determined`
	);
	}
	const linter = LINTER_MAP[name];
	if (!linter) return new NullLinter(`attempted to lint with unsupported linter: ${name}`);
	const lintConfig: RubyCommandConfiguration =
	typeof config.lint[name] === 'object' ? config.lint[name] : {};
	const linterConfig: LinterConfig = {
	env,
	executionRoot: URI.parse(config.workspaceFolderUri).fsPath,
	config: lintConfig,
	};
	return new linter(document, linterConfig); // eslint-disable-line new-cap
	}

	function getFormatter(
	document: TextDocument,
	env: RubyEnvironment,
	config: RubyConfiguration,
	range?: Range
	): IFormatter {
	// Only format if we have a formatter to use and an execution root
	if (typeof config.format === 'string' && config.workspaceFolderUri) {
	const formatterConfig: FormatterConfig = {
	env,
	executionRoot: URI.parse(config.workspaceFolderUri).fsPath,
	config: {
	command: config.format,
	useBundler: config.useBundler,
	},
	};

	if (range) {
	formatterConfig.range = range;
	}

	return new FORMATTER_MAP[config.format](document, formatterConfig);
	} else {
	return new NullFormatter();
	}
	}

Add option to specify formatter command #548

Description

Your environment

Expected behavior

Actual behavior

Activity

mill1000 commented on Oct 30, 2019

Overload119 commented on Nov 28, 2019

MikeMcQuaid commented on Dec 11, 2019

gstokkink-bex commented on Apr 14, 2021

fiveNinePlusR commented on Oct 6, 2021

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions