wfleming / codeclimate-shellcheck Goto Github PK

Follows: #52

@Filib - Analyzing the repo for git (https://github.com/git/git) I came across an error:

Michaels-MBP-4:git mrb$ codeclimate analyze --dev contrib/mw-to-git/t/t9363-mw-to-git-export-import.sh
Starting analysis
Running shellcheck: Done!
error: (CC::Analyzer::Engine::EngineFailure) engine shellcheck failed with status 1 and stderr 
engine: contrib/mw-to-git/t/t9363-mw-to-git-export-import.sh: hGetContents: invalid argument (invalid byte sequence)
engine: thread blocked indefinitely in an MVar operation

It looks like from this issue elm-lang/elm-make#33 that we probably have to set the LOCALE to some flavor of UTF-8. Any thoughts on the best way to handle this?

Added in this commit:

koalaman/shellcheck@856d57f

This looks great! Please can you share when it will be available for use via codeclimate.com? Thanks.

Hi @Filib. Abby here from Code Climate's support team.

A user reached out to us saying that shellcheck in Code Climate skipped their blip.bash file (in https://github.com/neechbear/blip/) We tested it on our end, and shellcheck also skips this file. If we change it to blip.bash.sh it shows issues in spellcheck.

Running shellcheck manually (v 0.3.3) on the command line against https://raw.githubusercontent.com/neechbear/blip/master/blip.bash shows some shellcheck warnings.

Is skipping .bash files intended?

Any insight on this would be great! Thanks.

Hey @Filib - should we release a new version of the engine?

On line 9 of the Dockerfile a cabal.config file is moved: https://github.com/filib/codeclimate-shellcheck/blob/master/Dockerfile#L9 - but it's not checked into the repo. Can you check it in? Thanks!

Add mapping between Check constructors and remediation points

From @mrb:

Remediation points (each error should emit a number of points which is what gets rolled into a grade)

From the spec:

The baseline remediation points value is 50,000, which is the time it takes to fix a trivial code style issue like a missing semicolon on a single line, including the time for the developer to open the code, make the change, and confidently commit the fix. All other remediation points values are expressed in multiples of that Basic Remediation Point Value.

From ShellCheck source:

data Severity = ErrorC | WarningC | InfoC | StyleC deriving (Show, Eq, Ord)

https://github.com/filib/codeclimate-shellcheck/blob/master/test/example.sh

Follows on from #2.

Follows on from #3.

This should make it easier for people to get up and running for development.

Hi,

the docs suggest the shellcheck version is out of date which would require an engine update.

Would this be possible?

Cheers,

Amo

I'd like to make a PR updating ShellCheck to latest (0.7.0) because I'm seeing Issues on Code Climate that are incorrect due to bugs in the 0.4.6 version. I can provide details if interested, but I know the bug is fixed in my local 0.6.0 binary, so I assume updating will resolve it.

Looking at this repo, it seems the version of ShellCheck is not pinned anywhere, and so just performing an un-cached build should update things to latest. Is that correct?

If so, how do we poke Code Climate to rebuild the image? Is an implicit version desired or should we look to pin it in (I assume) the cabal file?

From speaking to @mrb, we think we should:

• Check files that have a .sh file extension.
• Check files that have no extension and have a shebang with an appropriate shell.

We think we should avoid:

• Checking the shebang for every file in a repo.

Here's what cloc does:

Scan the candidate file list for file extensions which cloc associates with programming languages (see the --show-lang and --show-ext options). Files which match are classified as containing source code for that language. Each file without an extensions is opened and its first line read to see if it is a Unix shell script (anything that begins with #!). If it is shell script, the file is classified by that scripting language (if the language is recognized). If the file does not have a recognized extension or is not a recognzied scripting language, the file is ignored.

This is a placeholder issue to track the results of the following ShellCheck issue: koalaman/shellcheck#737

If they decide to expose goodShells then we should extract it for use in place of replicating that data in validShells. (otherwise close this issue as wontfix)

https://github.com/codeclimate/spec/blob/master/SPEC.md#data-types

i do not currently have time to maintain this project and i'm not currently using codeclimate-shellcheck, so would like to find a new maintainer.

i'll be archiving and then deleting the repo in approx. 3 months if no one is interested in taking it on.

• Fix data dependency issue. [Done https://github.com/filib/codeclimate-shellcheck/commit/cf354d6e7f68aae61a4cdae5c28ca03d8541a2c6]

See context in #48

From the spec:

Engines stream static analysis Issues to STDOUT in JSON format. When possible, results should be emitted as soon as they are computed (streaming, not buffered)

We should fork a green thread to read from a channel and print analysis results as they're written to the channel.

https://hackage.haskell.org/package/base-4.8.1.0/docs/Control-Concurrent-Chan.html

Pipelines failing

Digest: sha256:3b3383f8f0199f8dfab9fc3a31fe003029e04c4f655d077871f0d205e5b09082
Status: Downloaded newer image for codeclimate/codeclimate-shellcheck:latest
/home/app/bin/engine: /usr/glibc-compat/lib/libm.so.6: version `GLIBC_2.27' not found (required by /home/app/bin/engine)

7 hours ago this digest worked fine:
Digest: sha256:6798eda0b248d6fb85d831553ba3300271d88d7efa5a0d987b0049baf9096795
And for extra trouble, it seems this has been deleted from the hub?
the "previous" release on the hub is now only b684 - Last updated 2 years ago 😢

Communicate this isn't currently available on CodeClimate.