Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify checkers and add solhint #75

Merged
merged 3 commits into from
Oct 24, 2022
Merged

Simplify checkers and add solhint #75

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d707b10
Simplify checkers and add solhint
landakram Mar 2, 2021
d3901a3
Use unix formatter
landakram Oct 19, 2022
699d964
Fix typo
landakram Oct 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions solidity-common.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,11 @@
:type 'string
:package-version '(solidity . "0.1.4"))

(defcustom solidity-solhint-path "solhint"
"Path to the solium binary."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"Path to the solium binary."
"Path to the solhint binary."

:group 'solidity
:type 'string
:package-version '(solidity . "0.1.12"))

(provide 'solidity-common)
;;; solidity-common.el ends here
207 changes: 110 additions & 97 deletions solidity-flycheck.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,7 @@
(require 'flycheck)
(require 'solidity-common)
(require 'dash)

(defvar flycheck-solidity-checker-executable)
(defvar flycheck-solium-checker-executable)

(defcustom solidity-flycheck-solc-checker-active nil
"A boolean flag denoting if solc flycheck checker should be active."
:group 'solidity
:type 'boolean
:safe #'booleanp
:package-version '(solidity . "0.1.5"))
(require 'project)

(defcustom solidity-flycheck-chaining-error-level 'warning
"The maximum error level at which chaining of checkers will happen.
Expand Down Expand Up @@ -69,13 +60,6 @@ Possible values are:
:package-version '(solidity . "0.1.5")
:safe #'symbolp)

(defcustom solidity-flycheck-solium-checker-active nil
"A boolean flag denoting if solium flycheck checker should be active."
:group 'solidity
:type 'boolean
:safe #'booleanp
:package-version '(solidity . "0.1.5"))

(flycheck-def-option-var flycheck-solidity-solium-soliumrcfile nil solium-check
"The path to use for soliumrc.json

Expand Down Expand Up @@ -111,13 +95,15 @@ during compilation and linting. solidity-flycheck will look for a .soliumrc.json
in a parent directory. If found, this directory is considered the project root. If
no .soliumrc.json is found, `project-roots' is used.

When `solidity-flycheck-solium-checker-active' is t, the .soliumrc.json found in
the project root will be used as the solium config, rather than a .soliumrc.json
in the same directory as the file being linted.
When using solium-checker, the .soliumrc.json found in the project root will be
used as the solium config, rather than a .soliumrc.json in the same directory as
the file being linted.

When `solidity-flycheck-solc-checker-active' is t, the project root will be passed
to solc using the --allow-paths flag. This means imports to other files inside the
project will lint without erorr."
When using solhint-checker, solhint will be run at the project root.

When using solidity-checker , the project root will be passed to solc using the
--allow-paths flag. This means imports to other files inside the project will
lint without erorr."
:group 'solidity
:type 'boolean
:safe #'booleanp
Expand All @@ -136,58 +122,68 @@ no .soliumrc.json is found, `project-roots' is used."
(car roots)))))
(expand-file-name root))))

(when solidity-flycheck-solium-checker-active
;; define solium flycheck syntax checker
;; expanded the flycheck-define-checker macro in order to eval certain args, as per advice given in gitter
;; https://gitter.im/flycheck/flycheck?at=5a43b3a8232e79134d98872b
;; first try to add solium to the checker's list since if we got solc
;; it must come after it in the list due to it being chained after solc
(flycheck-def-executable-var solium-checker "solium")
(let ((solium-full-path (funcall flycheck-executable-find solidity-solium-path)))
(if solium-full-path
(let ((solium-has-reporter (string-match-p "--reporter" (shell-command-to-string (concat solium-full-path " --help")))))
(flycheck-define-command-checker 'solium-checker
"A Solidity linter using solium"
:command `("solium"
,(if solium-has-reporter "--reporter=gcc" "")
(option "--config=" flycheck-solidity-solium-soliumrcfile concat)
"-f"
source-inplace)
:error-patterns `((error line-start (zero-or-more not-newline) "[Fatal error]" (message))
,(if solium-has-reporter
'(error line-start (file-name) ":" line ":" column ": error: " (message))
'(error line-start (zero-or-more " ") line ":" column (zero-or-more " ") "error" (message)))
,(if solium-has-reporter
'(warning line-start (file-name) ":" line ":" column ": warning: " (message))
'(warning line-start (zero-or-more " ") line ":" column (zero-or-more " ") "warning" (message))))
:error-filter
;; Add fake line numbers if they are missing in the lint output
#'(lambda (errors)
(dolist (err errors)
(unless (flycheck-error-line err)
(setf (flycheck-error-line err) 1)))
errors)
:modes 'solidity-mode
:predicate #'(lambda nil (eq major-mode 'solidity-mode))
:next-checkers 'nil
:standard-input 'nil
:working-directory 'solidity-flycheck--find-working-directory)
(add-to-list 'flycheck-checkers 'solium-checker)
(setq flycheck-solium-checker-executable solidity-solium-path))
(error (format "Solidity Mode Configuration error. Requested solium flycheck integration but can't find solium at: %s" solidity-solium-path)))))
(flycheck-def-executable-var solium-checker "solium")

(defun solium-has-reporter ()
(let ((solium-full-path (funcall
flycheck-executable-find
(or flycheck-solium-checker-executable solidity-solium-path))))
(and solium-full-path
(string-match-p "--reporter" (shell-command-to-string (concat solium-full-path " --help"))))))

(flycheck-define-command-checker 'solium-checker
"A Solidity linter using solium"
:command `(,solidity-solium-path
(eval (when (solium-has-reporter) "--reporter=gcc"))
(option "--config=" flycheck-solidity-solium-soliumrcfile concat)
"-f"
source-inplace)
:error-patterns `((error line-start (zero-or-more not-newline) "[Fatal error]" (message))
(error line-start (zero-or-more " ") line ":" column (zero-or-more " ") "error" (message))
(warning line-start (zero-or-more " ") line ":" column (zero-or-more " ") "warning" (message))
;; reporter=gcc formats
(error line-start (file-name) ":" line ":" column ": error: " (message))
(warning line-start (file-name) ":" line ":" column ": warning: " (message)))

:error-filter
;; Add fake line numbers if they are missing in the lint output
#'(lambda (errors)
(dolist (err errors)
(unless (flycheck-error-line err)
(setf (flycheck-error-line err) 1)))
errors)
:modes 'solidity-mode
:predicate #'(lambda nil (eq major-mode 'solidity-mode))
:next-checkers `((,solidity-flycheck-chaining-error-level . solhint-checker))
:standard-input 'nil
:working-directory 'solidity-flycheck--find-working-directory)

;; add a solidity mode callback to set the executable of solc for flycheck
;; define solidity's flycheck syntax checker
;; expanded the flycheck-define-checker macro in order to eval certain args, as per advice given in gitter
;; https://gitter.im/flycheck/flycheck?at=5a43b3a8232e79134d98872b
(flycheck-def-executable-var solidity-checker "solc")

(defun get-solc-version ()
"Query solc executable and return its version.

The result is returned in a list with 3 elements.MAJOR MINOR PATCH.

If the solc output can't be parsed an error is returned."
(let ((output (shell-command-to-string (format "%s --version" solidity-solc-path))))
(let* ((solc-full-path (funcall
flycheck-executable-find
(or flycheck-solidity-checker-executable solidity-solc-path)))
(output (shell-command-to-string (format "%s --version" solc-full-path))))
(if (string-match "Version: \\([[:digit:]]+\\)\.\\([[:digit:]]+\\)\.\\([[:digit:]]+\\)" output)
(list (match-string 1 output)
(match-string 2 output)
(match-string 3 output))
(error "Could not parse the output of %s --version:\n %s" solidity-solc-path output))))
(error "Could not parse the output of %s --version:\n %s" solc-full-path output))))

(defun solc-gt-0.6.0 ()
"Return `t` if solc >= 0.6.0 and `nil` otherwise."
Expand Down Expand Up @@ -230,44 +226,61 @@ no .soliumrc.json is found, `project-roots' is used."
`("--allow-paths" ,allow-paths))))

(defun solidity-flycheck--solc-cmd ()
(if (solc-gt-0.6.0)
`("solc"
"--no-color"
,@(solidity-flycheck--solc-allow-paths-opt)
,@(solidity-flycheck--solc-remappings-opt)
source-inplace)
'("solc" source-inplace)))

(when solidity-flycheck-solc-checker-active
;; add a solidity mode callback to set the executable of solc for flycheck
;; define solidity's flycheck syntax checker
;; expanded the flycheck-define-checker macro in order to eval certain args, as per advice given in gitter
;; https://gitter.im/flycheck/flycheck?at=5a43b3a8232e79134d98872b
(flycheck-def-executable-var solidity-checker "solc")
(let* ((cmd (solidity-flycheck--solc-cmd)))
(if (funcall flycheck-executable-find solidity-solc-path)
(progn
(flycheck-define-command-checker 'solidity-checker
"A Solidity syntax checker using the solc compiler"
:command cmd
:error-patterns '(
;; Solidity >= 0.6.0 error formats
(error line-start "Error: " (message) "\n" (zero-or-more whitespace) "--> " (file-name) ":" line ":" column)
(warning line-start "Warning: " (message) "\n" (zero-or-more whitespace) "--> " (file-name) ":" line ":" column)

;; Solidity < 0.6.0 error formats
(error line-start (file-name) ":" line ":" column ":" " Error: " (message))
(error line-start (file-name) ":" line ":" column ":" " Compiler error: " (message))
(error line-start "Error: " (message))
(warning line-start (file-name) ":" line ":" column ":" " Warning: " (message)))
:modes 'solidity-mode
:predicate #'(lambda nil (eq major-mode 'solidity-mode))
:next-checkers `((,solidity-flycheck-chaining-error-level . solium-checker))
:standard-input 'nil
:working-directory 'solidity-flycheck--find-working-directory)
(add-to-list 'flycheck-checkers 'solidity-checker)
(setq flycheck-solidity-checker-executable solidity-solc-path))
(error (format "Solidity Mode Configuration error. Requested solc flycheck integration but can't find solc at: %s" solidity-solc-path)))))
`(,solidity-solc-path
(eval
(when (solc-gt-0.6.0)
`("--no-color"
,@(solidity-flycheck--solc-allow-paths-opt)
,@(solidity-flycheck--solc-remappings-opt))))
source-inplace))

(flycheck-define-command-checker 'solidity-checker
"A Solidity syntax checker using the solc compiler"
:command (solidity-flycheck--solc-cmd)
:error-patterns '(
;; Solidity >= 0.6.0 error formats
(error line-start "Error: " (message) "\n" (zero-or-more whitespace) "--> " (file-name) ":" line ":" column)
(warning line-start "Warning: " (message) "\n" (zero-or-more whitespace) "--> " (file-name) ":" line ":" column)

;; Solidity < 0.6.0 error formats
(error line-start (file-name) ":" line ":" column ":" " Error: " (message))
(error line-start (file-name) ":" line ":" column ":" " Compiler error: " (message))
(error line-start "Error: " (message))
(warning line-start (file-name) ":" line ":" column ":" " Warning: " (message)))
:modes 'solidity-mode
:predicate #'(lambda nil (eq major-mode 'solidity-mode))
:next-checkers
`((,solidity-flycheck-chaining-error-level . solium-checker)
(,solidity-flycheck-chaining-error-level . solhint-checker))
:standard-input 'nil
:working-directory 'solidity-flycheck--find-working-directory)

(flycheck-def-executable-var solhint-checker "solhint")
(flycheck-define-command-checker 'solhint-checker
"A Solidity linter using solhint"
:command `(,solidity-solhint-path "-f" "visualstudio" source-inplace)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:command `(,solidity-solhint-path "-f" "visualstudio" source-inplace)
:command `(,solidity-solhint-path "-f" "unix" source-inplace)

I don't see visualstudio among the formatter options. Although when it works when I run solhint -f visualstudio ./**/*.sol, would it make more sense here to use the unix formatted output?

Then the error-patterns would be something like:

  :error-patterns `((error
                     line-start (file-name) ":"  line ":" column ":" (zero-or-more " ")
                     "error" (zero-or-more " ") (message))
                    (warning
                     line-start (file-name) ":"  line ":" column ":" (zero-or-more " ")
                     "warning" (zero-or-more " ") (message)))

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to tweak your suggestion slightly to differentiate between errors and warnings. But should be good to go.

:error-patterns `((error
line-start (file-name) "(" line "," column "):" (zero-or-more " ")
"error" (zero-or-more " ") (message))
(warning
line-start (file-name) "(" line "," column "):" (zero-or-more " ")
"warning" (zero-or-more " ") (message)))
:error-filter
;; Add fake line numbers if they are missing in the lint output
#'(lambda (errors)
(dolist (err errors)
(unless (flycheck-error-line err)
(setf (flycheck-error-line err) 1)))
errors)
:modes 'solidity-mode
:predicate #'(lambda nil (eq major-mode 'solidity-mode))
:next-checkers 'nil
:standard-input 'nil
:working-directory 'solidity-flycheck--find-working-directory)

(add-to-list 'flycheck-checkers 'solhint-checker)
(add-to-list 'flycheck-checkers 'solium-checker)
(add-to-list 'flycheck-checkers 'solidity-checker)

(provide 'solidity-flycheck)
;;; solidity-flycheck.el ends here