Commit graph

417 commits

Author SHA1 Message Date
Marco Ferrari
ac4b767bd7
Reduce duplication in CI and CD workflows (#4982)
* Reduce duplication in CI and CD workflows

* Fix indentation in README

* Load token from file

* Fix instructions

* Ignore test leftovers
2023-12-12 18:53:48 +00:00
Marco Ferrari
d465382ed5
Update documentation (#4981)
* Update documentation

* Fix typos

* Update security policy

* Remove outdated instructions

* Fix list

* Add more info to config load step

* Don't test linter.yml

* Point to the cd workflow in README

* Move badge up

* Add info about Make help

---------

Co-authored-by: Zack Koppert <zkoppert@github.com>
2023-12-11 21:35:20 +00:00
Zack Koppert
304ca185da
Update PHP dependencies and GPG verification keys (#4960)
* Update phive locations

* Update phar keys and versions

* Add phpstan key

---------

Co-authored-by: Marco Ferrari <ferrari.marco@gmail.com>
2023-12-11 18:37:24 +01:00
Marco Ferrari
879672e936
Don't write colors and logs on disk if not necessary (#4934)
* Don't write colors and logs on disk if not necessary

* Set color markers

* Fix colors

* Fix linting errors

* Fix linting errors

* Use sudo to access logs
2023-12-05 08:04:13 +00:00
Marco Ferrari
a8150b40c8
Fix ts-standard configuration (#4932)
* Fix ts-standard configuration

* Fix default TYPESCRIPT_STANDARD_TSCONFIG_FILE assignment
2023-12-02 08:35:41 +00:00
dependabot[bot]
cd8a239bd5
Bump textlint-rule-terminology from 4.0.0 to 4.0.1 in /dependencies (#4839)
* Bump textlint-rule-terminology from 4.0.0 to 4.0.1 in /dependencies

Bumps [textlint-rule-terminology](https://github.com/sapegin/textlint-rule-terminology) from 4.0.0 to 4.0.1.
- [Release notes](https://github.com/sapegin/textlint-rule-terminology/releases)
- [Commits](https://github.com/sapegin/textlint-rule-terminology/compare/v4.0.0...v4.0.1)

---
updated-dependencies:
- dependency-name: textlint-rule-terminology
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* Fix linting errors

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Marco Ferrari <ferrari.marco@gmail.com>
2023-11-27 09:15:09 +00:00
Götz
e067545476
Allow to overwrite PHP_PHPCS_FILE_NAME value (#4849)
* Allow to overwrite PHP_PHPCS_FILE_NAME value

* Update README.md
2023-11-15 06:10:36 +00:00
Kin Fai Tse
c3ac3aa5d9
Batched & parallel support for cfn-lint, eslint, gitleaks (#4088)
* faster linter for cfn-lint and eslint

* workaround shfmt error

* fix xargs interleave large outputs

* parallel gitleaks

* fix exec bit, shfmt, bash linter

* show parallel --citation

* refactor a common interface using named pipe

* add readme for the experimental impl

* fix readme format

* minimize change in worker.sh

* will cite, showed once

* remove junk comment

* explicitly set EXPERIMENTAL_BATCH_WORKER=false

* fix: errors from github/super-linter:v5
2023-10-31 00:13:33 +00:00
pollenJP
40b5a7da51
Update ansible-lint configuration link (#4795) 2023-10-27 00:56:55 +00:00
Vadim Hatsura
80476af4f7
feat: use built-in dotnet format linter for csharp language (#4627)
* chore: add test case for csharp language which should pass

it shows that the current version of linter for csharp language reports false positive issues

* feat: use built-in linter for csharp language

https://github.com/dotnet/format/issues/1268

* chore: remove dotnet-format installation from install-dotnet.sh

dotnet format is a part of .NET 6 SDK and shouldn't be installed separately anymore

* docs: update linter name for dotnet

instead of dotnet-format built-in format command from dotnet is used (points to the same repository as before)

* chore: update linter name for dotnet in tests

---------

Co-authored-by: Zack Koppert <zkoppert@github.com>
2023-10-16 18:31:03 +00:00
Zack Koppert
f76e0a23e2
Remove codecov reports (#4737)
* Remove codecov reports

* Remove Codacy Badge
2023-10-16 10:31:52 +00:00
Masaya Suzuki
50d462e0ec
renovate-config-validator: validate shareable config preset (#4674)
* renovate-config-validator: validate default.json

* Add RENOVATE_SHAREABLE_CONFIG_PRESET_FILE

* Allow specifying multiple additional files with a environment variable

* Add break
2023-09-29 20:25:37 +00:00
Zack Koppert
8ef34029f7
Remove notice from april availability issue (#4654) 2023-09-17 12:29:30 +00:00
Zack Koppert
8761cb2691
use checkout v4 in README (#4644)
* use checkout v4 in README

* use checkout v4 in docs
2023-09-14 14:38:17 -07:00
Masaya Suzuki
3703f392e8
Add renovate-config-validator (#4643) 2023-09-12 16:58:09 +00:00
Zack Koppert
da4dd08cd6
Follow up with several more documentation and automation renames for the org move from github to super-linter (#4543)
* move from github org to super-linter org

* rename to super-linter org

* rename to super-linter org

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter and remove dockerhub reference

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rename org to super-linter

* rm dockerhub section link
2023-08-17 15:12:11 +00:00
Maik Müller
a797192e18
docs(readme): changing DEFAULT_BRANCH to main (#4563) 2023-08-15 16:42:04 -07:00
Kerwin Bryant
98b9f97a88
Update README.md (#4393)
Update github/super-linter to super-linter/super-linter

Co-authored-by: Philip Mallegol-Hansen <philip@mallegolhansen.com>
2023-07-03 19:37:29 +00:00
Zack Koppert
68d7903c34
Fix badging in the README (#4202) 2023-05-15 12:15:17 -07:00
Philip Mallegol-Hansen
e048fe4f46
Moves notice under h1 (#4189) 2023-05-15 09:55:51 -07:00
Zack Koppert
59fac7946c
Switch name of organization to super-linter (#4152)
* Switch name of organization to super-linter

* Add notice

* Add year

Co-authored-by: Cory Calahan <corycalahan@github.com>

---------

Co-authored-by: Cory Calahan <corycalahan@github.com>
2023-05-11 10:00:00 -07:00
Henry Asa
47884a0e25 Update all super-linter v4 version references to v5 2023-04-17 15:19:54 -04:00
liangbowen
4e8371f370 add env BASH_SEVERITY to specify minimum severity of errors in shellcheck 2023-04-16 23:54:10 -04:00
Leith Caldwell
2307d9a099 Document GITHUB_TOKEN permissions
Required to support MULTI_STATUS (which is true by default)
2023-04-16 23:53:49 -04:00
mdsakalu
404dc12a41 Add missing doc for GITHUB_ACTIONS_COMMAND_ARGS env var 2023-04-10 19:32:47 -04:00
Jeff Widman
e954bee85d Fix typo 2023-02-27 20:37:23 -05:00
Brett Logan
aa6f589b25 Address PR comments
Signed-off-by: Brett Logan <lindluni@github.com>
2023-01-16 21:14:13 -05:00
Brett Logan
189af88996 Close parentheses
Signed-off-by: Brett Logan <lindluni@github.com>
2023-01-16 21:14:13 -05:00
Rui Chen
e6445c358f replace kubeval with kubeconform
Signed-off-by: Rui Chen <rui@chenrui.dev>
Signed-off-by: Brett Logan <lindluni@github.com>
2023-01-16 21:14:13 -05:00
Marco Ferrari
a68245e640 Fix linting errors 2023-01-05 09:42:11 -05:00
Marco Ferrari
f0fe1c900b Conditionally create log file 2023-01-05 09:42:11 -05:00
Algin Maduro
50be96aaf9 review comments 2023-01-04 22:44:16 -05:00
Algin Maduro
9f4a208eb5 Add terraform fmt support 2023-01-04 22:44:16 -05:00
Brett Logan
6f804d1b87 Add GITHUB_ACTIONS_COMMAND_ARGS environment variable
Signed-off-by: Brett Logan <lindluni@github.com>
2023-01-04 00:35:25 -05:00
Tim Bond
5b75b61ea1 Docs: update PHP linter link 2022-12-30 18:41:42 -05:00
xginn8
193ab6cdba Update README.md
Fix typo in mypy path example
2022-12-22 12:23:39 -05:00
Peter Dave Hello
489166b2a3
docs: Fix link of Pylint in README.md (#3379)
The original link in the README.md is now `pylint.org is coming soon`
parking page from NameBright.com.

Co-authored-by: Marco Ferrari <ferrari.marco@gmail.com>
2022-09-30 20:33:31 +02:00
Peter Dave Hello
a3fc0c0c6a
Correct ShellCheck's name in README.md to make it happy! (#3378)
Co-authored-by: Marco Ferrari <ferrari.marco@gmail.com>
2022-09-30 20:28:04 +02:00
Marco Ferrari
84c0d52acc
Remove non-working cauldron report (#3373) 2022-09-29 14:43:15 +02:00
dependabot[bot]
c266045e2b
Bump textlint-rule-terminology from 3.0.1 to 3.0.3 in /dependencies (#3247)
* Bump textlint-rule-terminology from 3.0.1 to 3.0.3 in /dependencies

Bumps [textlint-rule-terminology](https://github.com/sapegin/textlint-rule-terminology) from 3.0.1 to 3.0.3.
- [Release notes](https://github.com/sapegin/textlint-rule-terminology/releases)
- [Commits](https://github.com/sapegin/textlint-rule-terminology/compare/v3.0.1...v3.0.3)

---
updated-dependencies:
- dependency-name: textlint-rule-terminology
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* Fix linting errors

* Fix linting errors

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Marco Ferrari <ferrari.marco@gmail.com>
2022-09-28 18:27:12 +02:00
Marco Ferrari
23e8ced872
Fix issues in the build workflow (#3357)
* Fix issues in the build workflow

* Don't build the image when running trivy

* Move the alpine glibc package key in the repo

* Move the alpine glibc package key in the repo

* Update labels

* Pull and tag
2022-09-27 14:30:54 +00:00
Marco Ferrari
2d7b73b7b9
Change directory to ANSIBLE_DIRECTORY before running ansible-lint and enable autodetection (#3350)
* Change directory to ANSIBLE_DIRECTORY before running ansible-lint

* move log so we see it

* Don't pass the directory to enable autodetection
2022-09-27 07:59:15 +00:00
Bastian Ebeling
d47cecf31c
linebreak because yamllint complains of this template (#3317) 2022-09-24 09:42:41 +02:00
Sergei K
910fbe6263 edit Kubernetes language 2022-09-03 09:49:59 -05:00
Christian Oliff
5cdfa85ecf
use latest version of actions/checkout in README (#3186) 2022-08-01 15:45:06 -05:00
Tejas Nagchandi
9a81ed68bb
Updated README and remove the support referrence of bicep with arm-ttk (#3164) 2022-07-25 08:31:03 -05:00
Sebass van Boxel
94efa68edf
Update codespaces instruction (#3138)
Co-authored-by: Brett Logan <lindluni@github.com>
2022-07-25 08:30:25 -05:00
Lukas Gravley
a34f330477
add bicep info (#2953) 2022-05-24 14:46:16 -05:00
David Piggott
589beb2693
s/VALIDATE_SCALAFMT_LINT/VALIDATE_SCALAFMT/ in README (#2722)
* s/VALIDATE_SCALAFMT_LINT/VALIDATE_SCALAFMT/ in README

I needed to disable this linter in a project just now and found that setting VALIDATE_SCALAFMT_LINT had no effect. When I looked at https://github.com/github/super-linter/pull/2053/files it became clear to me it was a typo in the README - I then set VALIDATE_SCALAFMT to false, and that worked as I expected it to.

* Fix column alignment
2022-04-04 09:02:39 -05:00
Stephen Abbene
32eb1cccda
Add Perl::Critic::Community and PERL_PERLCRITIC_OPTIONS to allow passing command line options to perlcritic (#2684)
Co-authored-by: Stephen Abbene <sabbene@users.noreply.github.com>
2022-03-28 08:56:50 -05:00
Alexandre Favre
edc7095b4b
Add Android support for Kotlin (#2670)
* Fix Kotlin good test case (incorrect filename)

* Add Android support for Kotlin

Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
2022-03-24 15:39:52 -05:00
Lukas Gravley
aee503c133
trying to create diagram (#2674)
* trying to create diagram

* typo

* typo

* typo

* typo

* typo

* typo

* dope code
2022-03-24 13:46:42 -05:00
Masaya Suzuki
e277edca06
Use ts-standard instead of standard as TYPESCRIPT_STANDARD (#2614)
* Use ts-standard instead of standard as TYPESCRIPT_STANDARD

* Add ts-standard

* Update test case

* Update test case

* Add tsconfig.json

* Add tsconfig.json environment value

* Fix "TypeScript"

* Fix package version

* Fix package version

* Fix package version

* Fix package version

* Fix settings

* Remove config file env

* Fix version

* Fix eslintrc

* Fix project path

* Fix project path

* Fix setting

* Fix env

* Add .eslintrc.yml for ts-standard

* Fix README

* Fix settings

* Change include paths

* Change include paths

* Change include paths

* Change include paths

* Fix dependencies

* Fix dependencies

* Fix dependence versions
2022-03-16 10:21:57 -05:00
Marco Ferrari
4b16b5b473
Lint the whole Ansible directory (#2576) 2022-03-14 20:47:04 +01:00
Kristjan ESPERANTO
09d9321d15
Fix link to Actions Badges documentation (#2615) 2022-03-14 09:24:37 -05:00
Marco Ferrari
d7cefe279b
Don't populate FILE_ARRAY_JSCPD with single files when scanning the whole codebase (#2580) 2022-03-14 09:22:23 -05:00
Christian Oliff
b80c79d647
Update README.md (#2610)
update example from actions/checkout@v2 to actions/checkout@v3
2022-03-14 08:57:50 -05:00
Colwyn Fritze-Moor
eb4aad643b
feat: add SSH key support (#2454)
* feat: add support for ssh keys and github.com connections

* refactor: allow github.com setup and update docs

* docs: add note about using ssh_key

* fix: run shfmt

* fix: add language to ssh key fence

* fix: make ssh setup script executable

* fix: gitleaks wins, openssh example removed

* notes

* docs: make the docs a little more clear

Co-authored-by: Admiral Awkbar <admiralawkbar@github.com>
2022-02-09 15:24:57 -06:00
Lukas Gravley
d92f3364de
adding flag for error on warning (#2397)
* adding flag for error on warning

* remove bug
2022-01-27 10:47:52 -06:00
Barry Pollard
19abf45423
Correct SQLFluff config filename (#2366) 2022-01-24 09:01:37 -06:00
Ross Smith II
7308cbd1ad
docs: Alphabetize lists (#2362) 2022-01-20 14:07:07 -06:00
Barry Pollard
3d54fce1f0
Allow SQLFluff configuration file to be used from standard Super Linter location (#2361) 2022-01-20 09:02:30 -06:00
Brett Logan
35d23ba664
Revert "Add find-unicode-control2 (#2286)" (#2299)
This reverts commit 46b9e49099.
2022-01-06 11:00:57 -06:00
Masaya Suzuki
46b9e49099
Add find-unicode-control2 (#2286)
* Add find-unicode-control2

* make version easier

* cleaner version

Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
2022-01-04 10:07:45 -06:00
Iori IKEDA
2d82178aee
add protolint config (#2252) 2022-01-03 11:30:56 -06:00
Marco Ferrari
e4b08ec842
Lint the whole code base with JSCPD (#2180)
* Lint the whole code base with JSCPD if VALIDATE_ALL_CODEBASE is true

* Use VALIDATE_JSCPD_ALL_CODEBASE

Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
2021-12-08 14:28:30 -06:00
James Garcia
49a1836796
Updating docs link in the template (#2218)
* Updating docs link in the template

* Update template docs link
2021-12-08 14:28:01 -06:00
Marco Ferrari
ee99da290b
Uninstall Dockerfilelint (#2195)
* Uninstall Dockerfilelint

* remove dockerfilelint packages

* trying ca-certs

Co-authored-by: Admiral Awkbar <admiralawkbar@github.com>
2021-12-08 09:53:05 -06:00
Antonio Yang
1d4680e2a7
Update rustfmt with 2021 edition (#2196) 2021-12-07 11:18:34 -06:00
Rohan Jaswal
c4e6b0c6f4
fix default value name for JAVA_FILE_NAME in README (#2204)
The default vale name for JAVA_FILE_NAME is `sun_checks.yml` and not `sun-checks.yml` as mentioned in the README.
2021-12-05 16:07:50 +01:00
Ross Smith II
fee08c5991
doc: fix sort oder of options (#2161) 2021-11-18 09:31:45 -06:00
Lukas Gravley
fb82126082
Typescript prettier (#2121)
* adding typescript prettier

* adding typescript prettier

* fix scala
2021-11-12 10:25:32 -06:00
Jake Herbst
897185a4aa
Adding scalafmt (#2053)
* Adding scalafmt

* add it

Co-authored-by: Jake Herbst <jherbst@rsglab.com>
Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
2021-11-10 12:28:50 -06:00
Masaya Suzuki
fafdcd214e
Add textlint (#2021)
* Add textlint

* Fix by textlint

* Fix package-lock.json

* Fix package-lock.json
2021-10-05 08:29:05 -05:00
Dylan Richards
b734f074f2
Updated README links (#2026) 2021-10-03 20:46:38 -07:00
Ed Sabol
1459131900
Trivial fix to README.md (#2020) 2021-10-02 01:43:50 +00:00
Lukas Gravley
57e0530d1b
cleaner (#2008)
* cleaner

* fix bad name

* fix name

* adding flag

* fix links

* noise

* fix rules

* fix to warn

* remove textlint
2021-10-01 12:41:13 -05:00
Masaya Suzuki
3472ac360c
Add textlint (#2006)
* Add textlint

* Add new final newline

* Validate only markdown files

* txt -> md
2021-09-30 13:40:44 -05:00
guotongfei
1afc7f8409
Enhancement: Add support for google-java-format (#1969)
* Add support for google-java-format

* adding tests and array

* fix comma

* Update linter.sh

* get it in order

* fix hava version

Co-authored-by: Admiral Awkbar <admiralawkbar@github.com>
2021-09-28 17:09:21 -05:00
Patrick Huy
9b8c1ba0a9
docs: correct GITHUB_CUSTOM_API_URL format (#1991)
In the README.md file the example value of `GITHUB_CUSTOM_API_URL` for usage on GHES ends in a `api/v3/` this is incorrect, instead `api/v3` needs to be used. Also it states that the defautl value is `api.github.com`, the true default value is `https://api.github.com`, this again is confusing whether or not the `https` needs to be included or not (it does need to be included)

Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
2021-09-27 13:38:12 -05:00
Masaya Suzuki
0e1a1e50d6
Add Gitleaks for secret scanning (#1951)
* Add actionlint

* adding gitleaks

* rm secretlint

* Update .gitleaks.toml

Co-authored-by: Admiral Awkbar <admiralawkbar@github.com>
2021-09-27 09:32:18 -05:00
Kurt von Laven
eab7a6aad2
Correct spelling of "sqlfluff" in README. (#1988)
It was previously spelled "slqfluff."
2021-09-21 21:56:10 -07:00
Søren Mathiasen
7038c42bff
feat: adding slim action (#1946) 2021-09-08 15:18:59 -05:00
Lukas Gravley
c649496209
suppress warn messages (#1943) 2021-09-07 10:12:49 -05:00
Kurt von Laven
8227f79074
Add a template config file for ShellCheck (#1900)
* Improve wording of LINTER_RULES_PATH docs (#1634).

* Add a template config file for ShellCheck (#1633).

Instruct ShellCheck to search SCRIPTDIR, the directory that the script
being linted is in, for other scripts that are sourced. Otherwise, the
commonly-used source command results in linter error SC1091. See
https://github.com/koalaman/shellcheck/wiki/SC1091 for more details.

* fix line ending

Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
2021-08-30 11:19:56 -05:00
Lukas Gravley
5f65429f2c
adding tflint (#1899)
* adding tflint

* fixed array

* i thought this was fixed
2021-08-30 09:47:50 -05:00
Philip Jake
a6d60d8fa8
Editorial: linked the example linter.yml file (#1872) 2021-08-17 15:00:53 -05:00
Linda_pp
8e17b57c1a
Update link to the document of actionlint configuration file (#1857)
Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
2021-08-16 09:19:47 -05:00
Andrew Ogburn
8e308dcb0c
Update GitHub Actions config file default (#1855)
The default value is actionlint.yml, not .actionlint.yml, as previously
reported by the README.md.
2021-08-10 09:25:30 -05:00
Lukas Gravley
148622b273
Sqlfluff (#1834)
* adding sqlfluff

* adding sqlfluff

* update test

* adding sql file array
2021-08-05 15:32:27 -05:00
Lukas Gravley
ab24b82199
Adding actionlint (#1775)
* Adding action lint

* adding tests

* adding tests

* Update Dockerfile

Co-authored-by: Masaya Suzuki <15100604+massongit@users.noreply.github.com>

* cleanup name

* fix test

* typo

* fix file name

* fix our own errors

* more cleanup

* angry

* make it happy

* stop double jobs

Co-authored-by: Masaya Suzuki <15100604+massongit@users.noreply.github.com>
2021-07-19 09:28:49 -05:00
Stepan Koltsov
0e3ade060c
Better link to clang-format in README.md (#1766)
Link to clang-format configuration page.
2021-07-15 08:49:40 -05:00
Stepan Koltsov
44e69ba2ff
Minor clang-format linter cleanup (#1764)
Follow-up to #1762
2021-07-14 16:05:37 -07:00
Lukas Gravley
1481793072
adding clang (#1762)
* adding clang

* fix hado

* adding files

* fixing naming

* fixing test

* fixing space

* removing config file

* fix tests

* fix tests

* fix file array
2021-07-14 14:43:10 -05:00
Aldana Vaca
8b75fbf345
Adding terrascan config file (#1761)
* adding terrascan config file

* fix line ending

Co-authored-by: Admiral Awkbar <admiralawkbar@github.com>
2021-07-14 10:20:24 -05:00
Thomas Iguchi
fad8d1cde2
Added support for changing Checkstyle rules file name (#1760)
Resolves https://github.com/github/super-linter/issues/680
2021-07-14 09:45:07 -05:00
Lukas Gravley
100c674c6d
adding tflint config (#1753) 2021-07-13 09:44:27 -05:00
Lukas Gravley
d24eb27b4c
move from jsonlint to eslint (#1752)
* move from jsonlint to eslint

* move from jsonlint to eslint

* adding test
2021-07-13 09:10:37 -05:00
Stepan Koltsov
e059100991
Ignore files marked with @generated marker (#1689)
* Ignore files marked with @generated marker

`@generated` marker is used by certain tools to understand that the
file is generated, so it should be treated differently than a file
written by a human:
* these files do not need to be reformatted,
* diffs in these files are less important,
* and linters should not be invoked on these files.

This PR proposes builtin support for `@generated` marker (and
`@not-generated` marker to mark file as not generated when it
contains `@generated` marker, like `README.md`).

I have not found a standard for a generated file marker, but:
* Facebook [uses `@generated` marker](https://tinyurl.com/fb-generated)
* Phabricator tool which was spawned from Facebook internal tool
  [also understands `@generated` marker](https://git.io/JnVHa)
* Cargo inserts `@generated` marker into [generated Cargo.lock files](https://git.io/JnVHP)

Super-linter supports regex includes and excludes, but they are
harder to maintain (each repository needs to be configured) than
patching the tools which generate the files.

My personal story is that I maintain rust-protobuf crate, which
started emitting `@generated` markers [six years ago](https://git.io/JnV5h)
after a request of a Phabricator user.

Test Plan:

Create a test file `test.sh`:

```
echo $a
```

Run:

```
docker run -e RUN_LOCAL=true -v $HOME/tmp/g:/tmp/lint super-linter-test
```

Result is:

```
In /tmp/lint/test.sh line 1:
echo $a
^-- SC2148: Tips depend on target shell and yours is unknown. Add a shebang or a 'shell' directive.
     ^-- SC2154: a is referenced but not assigned.
     ^-- SC2086: Double quote to prevent globbing and word splitting.
...
2021-06-22 23:46:16 [ERROR]   ERRORS FOUND in BASH:[1]
```

Now add `@generated` to the file and run again:

```
2021-06-22 23:47:13 [NOTICE]   All file(s) linted successfully with no errors detected
```

Additionally, add `@not-generated` in addition to `@generated`, and
linter error pops up again.

* cleanup

* remove space

* fix non utf return

* fix non utf return

Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
2021-06-28 07:59:11 -05:00
Marco Ferrari
d5b94b9108
Fix README issues (#1666) 2021-06-15 19:11:45 +02:00