diff --git a/.github/ISSUE_TEMPLATE/ENHANCEMENT-REQUEST.md b/.github/ISSUE_TEMPLATE/ENHANCEMENT-REQUEST.md index 74cec1fe..b80cd55f 100644 --- a/.github/ISSUE_TEMPLATE/ENHANCEMENT-REQUEST.md +++ b/.github/ISSUE_TEMPLATE/ENHANCEMENT-REQUEST.md @@ -27,5 +27,5 @@ about: Used for requesting enhancements to the GitHub Super-Linter - [ ] Important: Will significantly enhance the overall utility of the demo - [ ] Nice to have: self-explanatory -**Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc) +**Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. Stack Overflow, gitter, etc) diff --git a/README.md b/README.md index 026609d0..dac1e185 100644 --- a/README.md +++ b/README.md @@ -351,11 +351,11 @@ But if you wish to select or exclude specific linters, we give you full control | **VALIDATE_GROOVY** | `true` | Flag to enable or disable the linting process of the language. | | **VALIDATE_HTML** | `true` | Flag to enable or disable the linting process of the HTML language. | | **VALIDATE_JAVA** | `true` | Flag to enable or disable the linting process of the Java language. (Utilizing: checkstyle) | -| **VALIDATE_JAVASCRIPT_ES** | `true` | Flag to enable or disable the linting process of the JavaScript language. (Utilizing: eslint) | +| **VALIDATE_JAVASCRIPT_ES** | `true` | Flag to enable or disable the linting process of the JavaScript language. (Utilizing: ESLint) | | **VALIDATE_JAVASCRIPT_STANDARD** | `true` | Flag to enable or disable the linting process of the JavaScript language. (Utilizing: standard) | | **VALIDATE_JSCPD** | `true` | Flag to enable or disable the JSCPD. | | **VALIDATE_JSON** | `true` | Flag to enable or disable the linting process of the JSON language. | -| **VALIDATE_JSX** | `true` | Flag to enable or disable the linting process for jsx files (Utilizing: eslint) | +| **VALIDATE_JSX** | `true` | Flag to enable or disable the linting process for jsx files (Utilizing: ESLint) | | **VALIDATE_KOTLIN** | `true` | Flag to enable or disable the linting process of the Kotlin language. | | **VALIDATE_KOTLIN_ANDROID** | `true` | Flag to enable or disable the linting process of the Kotlin language. (Utilizing: `ktlint --android`) | | **VALIDATE_KUBERNETES_KUBEVAL** | `true` | Flag to enable or disable the linting process of Kubernetes descriptors with Kubeval | @@ -396,8 +396,8 @@ But if you wish to select or exclude specific linters, we give you full control | **VALIDATE_TERRAFORM_TERRASCAN** | `true` | Flag to enable or disable the linting process of the Terraform language for security related issues. | | **VALIDATE_TERRAFORM_TFLINT** | `true` | Flag to enable or disable the linting process of the Terraform language. (Utilizing tflint) | | **VALIDATE_TERRAGRUNT** | `true` | Flag to enable or disable the linting process for Terragrunt files. | -| **VALIDATE_TSX** | `true` | Flag to enable or disable the linting process for tsx files (Utilizing: eslint) | -| **VALIDATE_TYPESCRIPT_ES** | `true` | Flag to enable or disable the linting process of the TypeScript language. (Utilizing: eslint) | +| **VALIDATE_TSX** | `true` | Flag to enable or disable the linting process for tsx files (Utilizing: ESLint) | +| **VALIDATE_TYPESCRIPT_ES** | `true` | Flag to enable or disable the linting process of the TypeScript language. (Utilizing: ESLint) | | **VALIDATE_TYPESCRIPT_STANDARD** | `true` | Flag to enable or disable the linting process of the TypeScript language. (Utilizing: ts-standard) | | **VALIDATE_XML** | `true` | Flag to enable or disable the linting process of the XML language. | | **VALIDATE_YAML** | `true` | Flag to enable or disable the linting process of the YAML language. | @@ -563,7 +563,7 @@ Once found, it will load the certificate contents to a file, and to the trust st Below are a list of the known limitations for the **GitHub Super-Linter**: -- Due to being completely packaged at run time, you will not be able to update dependencies or change versions of the enclosed linters and binaries +- Due to being completely packaged at runtime, you will not be able to update dependencies or change versions of the enclosed linters and binaries - Additional details from `package.json` are not read by the **GitHub Super-Linter** - Downloading additional codebases as dependencies from private repositories will fail due to lack of permissions diff --git a/SECURITY.md b/SECURITY.md index 2613106d..a9e9052f 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,5 +1,5 @@ # Security Policy -If you discover a security issue in this repo, please submit it through the [GitHub Security Bug Bounty](https://hackerone.com/github) +If you discover a security issue in this repository, please submit it through the [GitHub Security Bug Bounty](https://hackerone.com/github) Thanks for helping make GitHub Actions safe for everyone. diff --git a/dependencies/package-lock.json b/dependencies/package-lock.json index 4362e63b..895b93f2 100644 --- a/dependencies/package-lock.json +++ b/dependencies/package-lock.json @@ -53,7 +53,7 @@ "textlint": "^12.2.1", "textlint-filter-rule-allowlist": "^4.0.0", "textlint-filter-rule-comments": "^1.2.2", - "textlint-rule-terminology": "^3.0.1", + "textlint-rule-terminology": "^3.0.3", "ts-standard": "^11.0.0", "typescript": "^4.8.4" } @@ -10346,9 +10346,9 @@ } }, "node_modules/textlint-rule-terminology": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/textlint-rule-terminology/-/textlint-rule-terminology-3.0.1.tgz", - "integrity": "sha512-jk2SGGep+XBckhIm9u6CG7NeMZiosJRPfoh7ISlCZizj/JGNk/zheDYGVXwKbFu20SxsguyUIpTF1z/d1Q+NeQ==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/textlint-rule-terminology/-/textlint-rule-terminology-3.0.3.tgz", + "integrity": "sha512-c1AzZ7ztXZfLySI8j7CnUGj8leNsfTCs+OPwJQV0ZWpKIZ7FsuRULCof1wLxsOZM+9MpVkmJWGfi6/qR6kRGIg==", "dependencies": { "lodash": "^4.17.15", "strip-json-comments": "^3.0.1", @@ -19386,9 +19386,9 @@ } }, "textlint-rule-terminology": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/textlint-rule-terminology/-/textlint-rule-terminology-3.0.1.tgz", - "integrity": "sha512-jk2SGGep+XBckhIm9u6CG7NeMZiosJRPfoh7ISlCZizj/JGNk/zheDYGVXwKbFu20SxsguyUIpTF1z/d1Q+NeQ==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/textlint-rule-terminology/-/textlint-rule-terminology-3.0.3.tgz", + "integrity": "sha512-c1AzZ7ztXZfLySI8j7CnUGj8leNsfTCs+OPwJQV0ZWpKIZ7FsuRULCof1wLxsOZM+9MpVkmJWGfi6/qR6kRGIg==", "requires": { "lodash": "^4.17.15", "strip-json-comments": "^3.0.1", diff --git a/dependencies/package.json b/dependencies/package.json index 3daa8a0a..0e94080c 100644 --- a/dependencies/package.json +++ b/dependencies/package.json @@ -48,7 +48,7 @@ "textlint": "^12.2.1", "textlint-filter-rule-allowlist": "^4.0.0", "textlint-filter-rule-comments": "^1.2.2", - "textlint-rule-terminology": "^3.0.1", + "textlint-rule-terminology": "^3.0.3", "ts-standard": "^11.0.0", "typescript": "^4.8.4" } diff --git a/docs/disabling-linters.md b/docs/disabling-linters.md index f0398604..20bced6c 100644 --- a/docs/disabling-linters.md +++ b/docs/disabling-linters.md @@ -6,7 +6,7 @@ To run with your own configuration for a linter, copy the relevant [`TEMPLATE` c How the changes are made differ for each linter, and also how much the **GitHub Super-Linter** has decided to change the linter's defaults. So, for some linters (e.g. [pylint for python](https://github.com/github/super-linter/blob/main/TEMPLATES/.python-lint)), there may be a large configuration file. For others (e.g. [stylelint for CSS](https://github.com/github/super-linter/blob/main/TEMPLATES/.stylelintrc.json)) the default configuration file may initially be nearly empty. And for some (e.g. StandardJS) it may not be possible to change configuration at all so there is no Template file. -Where a configuration file exists in your repo, it will be used in preference to the default one in the **GitHub Super-Linter** `TEMPLATES` directory (not in addition to it), and where one doesn't exist the `TEMPLATES` version will be used. So you should copy the complete configuration file you require to change from the `TEMPLATES` directory and not just the lines of config you want to change. +Where a configuration file exists in your repository, it will be used in preference to the default one in the **GitHub Super-Linter** `TEMPLATES` directory (not in addition to it), and where one doesn't exist the `TEMPLATES` version will be used. So you should copy the complete configuration file you require to change from the `TEMPLATES` directory and not just the lines of config you want to change. It is possible to have custom configurations for some linters, and continue to use the default from `TEMPLATES` directory for others, so if you use `Python` and `JavaScript` and only need to tweak the `Python` rules, then you only need to have a custom configuration for _pylint_ and continue to use the default `TEMPLATE` from the main repository for _ESLint_, for example. diff --git a/docs/run-linter-locally.md b/docs/run-linter-locally.md index 808a70de..30a96b81 100644 --- a/docs/run-linter-locally.md +++ b/docs/run-linter-locally.md @@ -101,7 +101,7 @@ jobs: ### Run container and gain access to the command-line -If you need to run the container locally and gain access to its command line, you can run the following command: +If you need to run the container locally and gain access to its command-line, you can run the following command: - `docker run -it --entrypoint /bin/bash github/super-linter` - This will drop you in the command-line of the docker container for any testing or troubleshooting that may be needed.