php-cs-fixer.coffee

{CompositeDisposable} = require 'atom'
{BufferedProcess} = require 'atom'
fs = require 'fs'
path = require 'path'

module.exports = PhpCsFixer =
  subscriptions: null
  config:
    phpExecutablePath:
      title: 'PHP executable path'
      type: 'string'
      default: 'php'
      description: 'The path to the `php` executable.'
      order: 10
    phpArguments:
      title: 'Add PHP arguments'
      type: 'array'
      default: []
      description: 'Add arguments, like for example
                    `-n`, to the PHP executable.'
      order: 11
    executablePath:
      title: 'PHP-CS-fixer executable path'
      type: 'string'
      default: 'php-cs-fixer'
      description: 'The path to the `php-cs-fixer` executable.'
      order: 20
    rules:
      title: 'PHP-CS-Fixer Rules'
      type: 'string'
      default: '@PSR2'
      description: 'A list of rules (based on php-cs-fixer 2.0),
                    for example: `@PSR2,no_short_echo_tag,indentation_type`.
                    See <https://github.com/FriendsOfPHP/PHP-CS-Fixer#usage>
                    for a complete list.
                    Will be ignored if a config file is used.'
      order: 21
    allowRisky:
      title: 'Allow risky'
      type: 'boolean'
      default: false
      description: 'Option allows you to set whether risky rules may run.
                    Will be ignored if a config file is used.'
      order: 22
    pathMode:
      title: 'PHP-CS-Fixer Path-Mode'
      type: 'string'
      default: 'override'
      enum: ['override', 'intersection']
      description: 'Specify path mode (can be override or intersection).'
      order: 23
    fixerArguments:
      title: 'PHP-CS-Fixer arguments'
      type: 'array'
      default: ['--using-cache=no', '--no-interaction']
      description: 'Add arguments, like for example `--using-cache=false`,
                    to the PHP-CS-Fixer executable. Run `php-cs-fixer help fix`
                    in your command line,
                    to get a full list of all supported arguments.'
      order: 24
    configPath:
      title: 'PHP-CS-fixer config file path'
      type: 'string'
      default: ''
      description: 'Optionally provide the path to the `.php_cs` config file,
                    if the path is not provided it will be loaded from the root
                    path of the current project.'
      order: 25
    executeOnSave:
      title: 'Execute on save'
      type: 'boolean'
      default: false
      description: 'Execute PHP CS fixer on save'
      order: 30
    showInfoNotifications:
      title: 'Show notifications'
      type: 'boolean'
      default: false
      description: 'Show some status informations from the last "fix".'
      order: 31

  activate: (state) ->
    atom.config.observe 'php-cs-fixer.executeOnSave', =>
      @executeOnSave = atom.config.get 'php-cs-fixer.executeOnSave'

    atom.config.observe 'php-cs-fixer.phpExecutablePath', =>
      @phpExecutablePath = atom.config.get 'php-cs-fixer.phpExecutablePath'

    atom.config.observe 'php-cs-fixer.executablePath', =>
      @executablePath = atom.config.get 'php-cs-fixer.executablePath'

    atom.config.observe 'php-cs-fixer.configPath', =>
      @configPath = atom.config.get 'php-cs-fixer.configPath'

    atom.config.observe 'php-cs-fixer.allowRisky', =>
      @allowRisky = atom.config.get 'php-cs-fixer.allowRisky'

    atom.config.observe 'php-cs-fixer.rules', =>
      @rules = atom.config.get 'php-cs-fixer.rules'

    atom.config.observe 'php-cs-fixer.showInfoNotifications', =>
      @showInfoNotifications = atom
                                .config.get 'php-cs-fixer.showInfoNotifications'

    atom.config.observe 'php-cs-fixer.phpArguments', =>
      @phpArguments = atom.config.get 'php-cs-fixer.phpArguments'

    atom.config.observe 'php-cs-fixer.fixerArguments', =>
      @fixerArguments = atom.config.get 'php-cs-fixer.fixerArguments'

    atom.config.observe 'php-cs-fixer.pathMode', =>
      @pathMode = atom.config.get 'php-cs-fixer.pathMode'

    # Events subscribed to in atom's system can be easily cleaned up
    # with a CompositeDisposable
    @subscriptions = new CompositeDisposable

    # Register command that toggles this view
    fixer = 'php-cs-fixer:fix': => @fix()
    @subscriptions.add atom.commands.add 'atom-workspace', fixer

    # Add workspace observer and save handler
    @subscriptions.add atom.workspace.observeTextEditors (editor) =>
      @subscriptions.add editor.getBuffer().onWillSave =>
        if editor.getGrammar().name == "PHP" and @executeOnSave
          @fix()

  deactivate: ->
    @subscriptions.dispose()

  fix: ->
    editor = atom.workspace.getActiveTextEditor()

    filePath = editor.getPath() if editor && editor.getPath

    command = @phpExecutablePath

    args = []

    if @phpArguments.length
      if @phpArguments.length > 1
        args = @phpArguments
      else
        args = @phpArguments[0].split(' ')
        
    fileSearchStartPath = path.dirname(filePath.toString())
    
    unless @executablePath and @fileExists(@executablePath)
      vendorBinary = 'vendor/bin/php-cs-fixer'
      @executablePath = @findFile(fileSearchStartPath, vendorBinary)
    args = args.concat [@executablePath, 'fix', filePath]
    
    configFiles = ['.php_cs', '.php_cs.dist']
    unless @configPath
      @configPath = @findFile(fileSearchStartPath, configFiles)

    if @configPath
      args.push '--config=' + @configPath

    # add optional options
    if not @configPath
      args.push '--allow-risky=yes' if @allowRisky
      args.push '--rules=' + @rules if @rules

    args.push '--path-mode=' + @pathMode if @pathMode

    if @fixerArguments.length and not @configPath
      if @fixerArguments.length > 1
        fixerArgs = @fixerArguments
      else
        fixerArgs = @fixerArguments[0].split(' ')

      args = args.concat fixerArgs

    stdout = (output) ->
      if PhpCsFixer.showInfoNotifications
        if (/^\s*\d*[)]/.test(output))
          atom.notifications.addSuccess(output)
        else
          atom.notifications.addInfo(output)
      console.log(output)

    stderr = (output) ->
      if PhpCsFixer.showInfoNotifications
        if (output.replace(/\s/g,"") == "")
          # do nothing
          
        # temporary fixing:
        # https://github.com/pfefferle/atom-php-cs-fixer/issues/35
        else if (/^Loaded config/.test(output))
          atom.notifications.addInfo(output)
        else
          atom.notifications.addError(output)
          console.error(output)

    exit = (code) -> console.log("#{command} exited with code: #{code}")

    process = new BufferedProcess({
      command: command,
      args: args,
      stdout: stdout,
      stderr: stderr,
      exit: exit
    }) if filePath

  # copied from the AtomLinter li
  # see:
  # https://github.com/AtomLinter/atom-linter/blob/master/lib/helpers.coffee#L112
  #
  # The AtomLinter is licensed under "The MIT License (MIT)"
  #
  # Copyright (c) 2015 AtomLinter
  #
  # See the full license here:
  # https://github.com/AtomLinter/atom-linter/blob/master/LICENSE
  findFile: (startDir, names) ->
    throw new Error "Specify a filename to find" unless arguments.length
    unless names instanceof Array
      names = [names]
    startDir = startDir.split(path.sep)
    while startDir.length
      currentDir = startDir.join(path.sep)
      for name in names
        filePath = path.join(currentDir, name)
        try
          console.log("!!!Looking in #{filePath}")
          fs.accessSync(filePath, fs.R_OK)
          return filePath
      startDir.pop()
    return null
    
  fileExists: (path) ->
    try
      fs.accessSync(filePath, fs.R_OK)
      return true
    catch
      return false