Merge branch 'master' of https://github.com/Glavin001/atom-beautify
This commit is contained in:
commit
eccf9f9c47
|
@ -1766,6 +1766,30 @@ Indentation size/length (Supported by Rubocop, Ruby Beautify)
|
|||
}
|
||||
```
|
||||
|
||||
#### [Ruby - Rubocop Path](#ruby---rubocop-path)
|
||||
|
||||
**Namespace**: `ruby`
|
||||
|
||||
**Key**: `rubocop_path`
|
||||
|
||||
**Type**: `string`
|
||||
|
||||
**Supported Beautifiers**: [`Rubocop`](#rubocop)
|
||||
|
||||
**Description**:
|
||||
|
||||
Path to the `rubocop` CLI executable (Supported by Rubocop)
|
||||
|
||||
**Example `.jsbeautifyrc` Configuration**
|
||||
|
||||
```json
|
||||
{
|
||||
"ruby": {
|
||||
"rubocop_path": ""
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### [Ruby - Indent char](#ruby---indent-char)
|
||||
|
||||
**Namespace**: `ruby`
|
||||
|
@ -6447,6 +6471,30 @@ Indentation size/length (Supported by Rubocop, Ruby Beautify)
|
|||
}
|
||||
```
|
||||
|
||||
#### [Ruby - Rubocop Path](#ruby---rubocop-path)
|
||||
|
||||
**Namespace**: `ruby`
|
||||
|
||||
**Key**: `rubocop_path`
|
||||
|
||||
**Type**: `string`
|
||||
|
||||
**Supported Beautifiers**: [`Rubocop`](#rubocop)
|
||||
|
||||
**Description**:
|
||||
|
||||
Path to the `rubocop` CLI executable (Supported by Rubocop)
|
||||
|
||||
**Example `.jsbeautifyrc` Configuration**
|
||||
|
||||
```json
|
||||
{
|
||||
"ruby": {
|
||||
"rubocop_path": ""
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
### Ruby Beautify
|
||||
|
||||
|
|
|
@ -20,27 +20,27 @@ module.exports = class Beautifier
|
|||
|
||||
###
|
||||
Supported Options
|
||||
|
||||
|
||||
Enable options for supported languages.
|
||||
- <string:language>:<boolean:all_options_enabled>
|
||||
- <string:language>:<string:option_key>:<boolean:enabled>
|
||||
- <string:language>:<string:option_key>:<string:rename>
|
||||
- <string:language>:<string:option_key>:<function:transform>
|
||||
- <string:language>:<string:option_key>:<array:mapper>
|
||||
|
||||
|
||||
###
|
||||
options: {}
|
||||
|
||||
###
|
||||
Supported languages by this Beautifier
|
||||
|
||||
|
||||
Extracted from the keys of the `options` field.
|
||||
###
|
||||
languages: null
|
||||
|
||||
###
|
||||
Beautify text
|
||||
|
||||
|
||||
Override this method in subclasses
|
||||
###
|
||||
beautify: null
|
||||
|
@ -87,7 +87,7 @@ module.exports = class Beautifier
|
|||
|
||||
###
|
||||
Get Shell Environment variables
|
||||
|
||||
|
||||
Special thank you to @ioquatix
|
||||
See https://github.com/ioquatix/script-runner/blob/v1.5.0/lib/script-runner.coffee#L45-L63
|
||||
###
|
||||
|
@ -139,7 +139,7 @@ module.exports = class Beautifier
|
|||
|
||||
###
|
||||
Like the unix which utility.
|
||||
|
||||
|
||||
Finds the first instance of a specified executable in the PATH environment variable.
|
||||
Does not cache the results,
|
||||
so hash -r is not needed when the PATH changes.
|
||||
|
@ -165,7 +165,7 @@ module.exports = class Beautifier
|
|||
|
||||
###
|
||||
Add help to error.description
|
||||
|
||||
|
||||
Note: error.description is not officially used in JavaScript,
|
||||
however it is used internally for Atom Beautify when displaying errors.
|
||||
###
|
||||
|
@ -256,8 +256,8 @@ module.exports = class Beautifier
|
|||
# If return code is not 0 then error occured
|
||||
if not ignoreReturnCode and returnCode isnt 0
|
||||
err = new Error(stderr)
|
||||
windowsProgramNotFoundMsg = 'is not recognized as an \
|
||||
internal or external command'#, operable program or batch file.'
|
||||
windowsProgramNotFoundMsg = "is not recognized as an \
|
||||
internal or external command" # operable program or batch file
|
||||
@verbose(stderr, windowsProgramNotFoundMsg)
|
||||
if @isWindows and returnCode is 1 and \
|
||||
stderr.indexOf(windowsProgramNotFoundMsg) isnt -1
|
||||
|
@ -346,5 +346,3 @@ module.exports = class Beautifier
|
|||
@verbose("Options for #{@name}:", @options)
|
||||
# Set supported languages
|
||||
@languages = _.keys(@options)
|
||||
|
||||
|
||||
|
|
|
@ -11,33 +11,56 @@ module.exports = class Rubocop extends Beautifier
|
|||
options: {
|
||||
Ruby:
|
||||
indent_size: true
|
||||
rubocop_path: true
|
||||
}
|
||||
|
||||
beautify: (text, language, options) ->
|
||||
@Promise.all([
|
||||
@which(options.rubocop_path) if options.rubocop_path
|
||||
@which('rubocop')
|
||||
]).then((paths) =>
|
||||
@debug('rubocop paths', paths)
|
||||
_ = require 'lodash'
|
||||
path = require 'path'
|
||||
# Get first valid, absolute path
|
||||
rubocopPath = _.find(paths, (p) -> p and path.isAbsolute(p) )
|
||||
@verbose('rubocopPath', rubocopPath)
|
||||
@debug('rubocopPath', rubocopPath, paths)
|
||||
|
||||
path = require 'path'
|
||||
fs = require 'fs'
|
||||
configFile = path.join(atom.project.getPaths()[0], ".rubocop.yml")
|
||||
|
||||
configFile = path.join(atom.project.getPaths()[0], ".rubocop.yml")
|
||||
fs = require 'fs'
|
||||
|
||||
if fs.existsSync(configFile)
|
||||
@debug("rubocop", config, fs.readFileSync(configFile, 'utf8'))
|
||||
else
|
||||
yaml = require("yaml-front-matter")
|
||||
# Generate config file
|
||||
config = {
|
||||
"Style/IndentationWidth":
|
||||
"Width": options.indent_size
|
||||
}
|
||||
if fs.existsSync(configFile)
|
||||
@debug("rubocop", config, fs.readFileSync(configFile, 'utf8'))
|
||||
else
|
||||
yaml = require("yaml-front-matter")
|
||||
# Generate config file
|
||||
config = {
|
||||
"Style/IndentationWidth":
|
||||
"Width": options.indent_size
|
||||
}
|
||||
|
||||
configFile = @tempFile("rubocop-config", yaml.safeDump(config))
|
||||
@debug("rubocop", config, configFile)
|
||||
configFile = @tempFile("rubocop-config", yaml.safeDump(config))
|
||||
@debug("rubocop", config, configFile)
|
||||
|
||||
@run("rubocop", [
|
||||
"--auto-correct"
|
||||
"--config", configFile
|
||||
tempFile = @tempFile("temp", text)
|
||||
], {ignoreReturnCode: true})
|
||||
.then(=>
|
||||
@readFile(tempFile)
|
||||
)
|
||||
# Check if PHP-CS-Fixer path was found
|
||||
if rubocopPath?
|
||||
@run(rubocopPath, [
|
||||
"--auto-correct"
|
||||
"--config", configFile
|
||||
tempFile = @tempFile("temp", text)
|
||||
], {ignoreReturnCode: true})
|
||||
.then(=>
|
||||
@readFile(tempFile)
|
||||
)
|
||||
else
|
||||
@run("rubocop", [
|
||||
"--auto-correct"
|
||||
"--config", configFile
|
||||
tempFile = @tempFile("temp", text)
|
||||
], {ignoreReturnCode: true})
|
||||
.then(=>
|
||||
@readFile(tempFile)
|
||||
)
|
||||
)
|
||||
|
|
|
@ -32,6 +32,11 @@ module.exports = {
|
|||
default: defaultIndentSize
|
||||
minimum: 0
|
||||
description: "Indentation size/length"
|
||||
rubocop_path:
|
||||
title: "Rubocop Path"
|
||||
type: 'string'
|
||||
default: ""
|
||||
description: "Path to the `rubocop` CLI executable"
|
||||
indent_char:
|
||||
type: 'string'
|
||||
default: defaultIndentChar
|
||||
|
|
Loading…
Reference in New Issue