Module: ImmosquareCleaner

Defined in:
lib/immosquare-cleaner.rb,
lib/immosquare-cleaner/railtie.rb,
lib/immosquare-cleaner/version.rb,
lib/immosquare-cleaner/markdown.rb,
lib/immosquare-cleaner/configuration.rb

Overview

##

Importing the ‘English’ library allows us to use more human-readable global variables, such as $INPUT_RECORD_SEPARATOR instead of $/, which enhances code clarity and makes it easier to understand the purpose of these variables in our code.

##

Defined Under Namespace

Modules: Markdown Classes: Configuration, Railtie

Constant Summary collapse

SHEBANG =
##

Constants

##
"#!/usr/bin/env ruby".freeze
RUBY_FILES = 
[".rb", ".rake", "Gemfile", "Rakefile", ".axlsx", ".gemspec", ".ru", ".podspec", ".jbuilder", ".rabl", ".thor", "config.ru", "Berksfile", "Capfile", "Guardfile", "Podfile", "Thorfile", "Vagrantfile"].freeze
VERSION = 
"0.1.51".freeze

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Object 



30
31
32
 
# File 'lib/immosquare-cleaner.rb', line 30

def configuration
  @configuration ||= Configuration.new
end

Class Method Details

.clean(file_path, **options) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/immosquare-cleaner.rb', line 38

def clean(file_path, **options)
  ##============================================================##
  ## Default options
  ##============================================================##
  options = {}.merge(options)

  begin
    ##============================================================##
    ## .html.erb files
    ##============================================================##
    if file_path.end_with?(".html.erb", ".html")
      cmds = []
      cmds << "bundle exec htmlbeautifier #{file_path} #{ImmosquareCleaner.configuration.htmlbeautifier_options || "--keep-blank-lines 4"}"
      cmds << "bundle exec erblint --config #{gem_root}/linters/erb-lint.yml #{file_path} #{ImmosquareCleaner.configuration.erblint_options || "--autocorrect"}"
      launch_cmds(cmds)
      File.normalize_last_line(file_path)
      return
    end

    ##============================================================##
    ## Ruby Files
    ## We create a rubocop config file with the ruby version
    ## if it does not exist...Normally rubocop does it alone
    ## of this based on .ruby-version file but it doesn't work
    ## in our case where rubocop is in a gem which is called
    ## in a project...
    ##============================================================##
    if file_path.end_with?(*RUBY_FILES) || File.open(file_path, &:gets)&.include?(SHEBANG)
      rubocop_config_with_version_path = "#{gem_root}/linters/rubocop-#{RUBY_VERSION}.yml"

      if !File.exist?(rubocop_config_with_version_path)
        rubocop_config = YAML.load_file("#{gem_root}/linters/rubocop.yml")
        rubocop_config["AllCops"] ||= {}
        rubocop_config["AllCops"]["TargetRubyVersion"] = RUBY_VERSION
        File.write(rubocop_config_with_version_path, rubocop_config.to_yaml)
      end

      cmds = ["bundle exec rubocop -c #{rubocop_config_with_version_path} #{file_path} #{ImmosquareCleaner.configuration.rubocop_options || "--autocorrect-all"}"]
      launch_cmds(cmds)
      File.normalize_last_line(file_path)
      return
    end

    ##============================================================##
    ## Yml translations files
    ##============================================================##
    if file_path =~ %r{locales/.*\.yml$}
      ImmosquareYaml.clean(file_path)
      return
    end

    ##============================================================##
    ## JS files
    ## 16/05/2024
    ## Depuis eslint V9 (acutellement en V9.2.0), il y a des
    ## erreurs/warnings
    ## File ignored because of a matching ignore pattern. Use "--no-ignore" to disable file ignore settings or use "--no-warn-ignored" to suppress this warning
    ## alors que le fichier ne devrait pas être ignoré...
    ## Cela se produit quand le fichier est dans un dossier supérieur
    ## à celui de la racine du gem. Pour éviter ce problème on
    ## met le fichier dans un dossier temporaire et on le supprime
    ## par la suite.
    ##============================================================##
    begin
      temp_folder_path = "#{gem_root}/tmp"
      temp_file_path   = "#{temp_folder_path}/#{File.basename(file_path)}"
      FileUtils.mkdir_p(temp_folder_path)
      File.write(temp_file_path, File.read(file_path))
      cmds = [
        "bun eslint --config #{gem_root}/linters/eslint.config.mjs  #{temp_file_path} --fix",
        "bun jscodeshift --silent --transform #{gem_root}/linters/jscodeshift/arrow-function-transform.js #{temp_file_path}"
      ]
      launch_cmds(cmds)
      File.normalize_last_line(temp_file_path)
      File.write(file_path, File.read(temp_file_path))
    rescue StandardError => e
    ensure
      FileUtils.rm_f(temp_file_path)
      return
    end if file_path.end_with?(".js") || file_path.end_with?(".mjs")

    ##============================================================##
    ## JSON files
    ##============================================================##
    if file_path.end_with?(".json")
      json_str    = File.read(file_path)
      parsed_data = JSON.parse(json_str)
      formated    = parsed_data.to_beautiful_json
      File.write(file_path, formated)
      File.normalize_last_line(file_path)
      return
    end

    ##============================================================##
    ## Markdown files
    ##============================================================##
    if file_path.end_with?(".md", ".md.erb")
      formatted_md = ImmosquareCleaner::Markdown.clean(file_path)
      File.write(file_path, formatted_md)
      File.normalize_last_line(file_path)
      return
    end

    ##============================================================##
    ## Autres formats
    ##============================================================##
    prettier_parser = nil
    prettier_parser = "--parser markdown" if file_path.end_with?(".md.erb")
    cmds = ["bun prettier --write #{file_path} #{prettier_parser} --config #{gem_root}/linters/prettier.yml"]
    launch_cmds(cmds)
  rescue StandardError => e
    puts(e.message)
    puts(e.backtrace)
  end
end

.config {|configuration| ... } ⇒ Object

Yields:



34
35
36
 
# File 'lib/immosquare-cleaner.rb', line 34

def config
  yield(configuration)
end