super-linter · ferrarimarco · Dec 12, 2023 · Dec 7, 2023 · Dec 7, 2023 · Dec 7, 2023
@@ -9,7 +9,7 @@ body:
       value: |
         Thanks for taking the time to fill out this feature request!
         If this is a request to add a new language, after submitting this issue
-        check out [the wiki](https://github.com/super-linter/super-linter/wiki/Adding-new-language-support-to-Super-Linter)
+        check out [the instructions](https://github.com/super-linter/super-linter/blob/main/docs/add-new-linter.md)
         for more information on how to accomplish that.
   - type: checkboxes
     attributes:

@@ -1,8 +1,8 @@
 ## This /.sqlfluff file can be used to configure the SQLFluff linter when
-## used via the GitHub Super Linter. Copy it to the .github/linters folder of
+## used via the Super Linter. Copy it to the .github/linters folder of
 ## your repo, and uncomment the necessary lines to configure the Super Linter.
 ##
-## IMPORTANT NOTE: The GitHub Super Linter configuration file for SQLFluff
+## IMPORTANT NOTE: The Super Linter configuration file for SQLFluff
 ## supersedes any local configuration files you might have in within your
 ## codebase. For this reason it should only be used when you want the same
 ## configuration for your entire code base. If you need different configuration

@@ -1,8 +1,8 @@
 ## This /.sqlfluff file can be used to configure the SQLFluff linter when
-## used via the GitHub Super Linter. Copy it to the .github/linters folder of
+## used via the Super Linter. Copy it to the .github/linters folder of
 ## your repo, and uncomment the necessary lines to configure the Super Linter.
 ##
-## IMPORTANT NOTE: The GitHub Super Linter configuration file for SQLFluff
+## IMPORTANT NOTE: The Super Linter configuration file for SQLFluff
 ## supersedes any local configuration files you might have in within your
 ## codebase. For this reason it should only be used when you want the same
 ## configuration for your entire code base. If you need different configuration

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 
 <ruleset name="super-linter">
-    <description>The default coding standard for usage with GitHub Super-Linter. It just includes PSR12.</description>
+    <description>The default coding standard for usage with Super-Linter. It just includes PSR12.</description>
     <rule ref="PSR12" />
 </ruleset>
@@ -0,0 +1,100 @@
+# How to add support for a new tool to super-linter
+
+If you want to propose a *Pull Request* to add **new** language support or a
+new tool, it should include:
+
+- Update documentation:
+  - `README.md`
+- Provide test cases:
+
+  1. Create the `.automation/test/<LANGUGAGE>` directory.
+  2. Provide at least one test case with a file that is supposed to pass validation: `.automation/test/<LANGUAGE>/<name-of-tool>-good.ext`
+  3. Provide at least one test case with a file that is supposed to fail validation: `.automation/test/<LANGUAGE>/<name-of-tool>-bad.ext`
+
+- Update the test suite to check for installed packages, the commands that your new tool needs in the `PATH`, and the expected version command:
+
+  - `test/inspec/super-linter/controls/super_linter.rb`
+
+- Install the tool by pointing to specific package or container image versions:
+
+  - If there are PyPi packages, create a text file named `dependencies/python/<name-of-tool>.txt`
+    and list the packages there.
+  - If there are npm packages, update `dependencies/package.json` and `dependencies/package-lock.json`.
+    by adding the new packages.
+  - If there are Ruby Gems, update `dependencies/Gemfile` and `dependencies/Gemfile.lock`
+  - If there are Maven or Java packages:
+
+    1. Create a directory named `dependencies/<name-of-tool>`.
+    2. Create a `dependencies/<name-of-tool>/build.gradle` file with the following contents:
+
+        ```gradle
+        repositories {
+          mavenLocal()
+          mavenCentral()
+        }
+
+        // Hold this dependency here so we can get automated updates using DependaBot
+        dependencies {
+          implementation 'your:dependency-here:version'
+        }
+
+        group 'com.github.super-linter'
+        version '1.0.0-SNAPSHOT'
+        ```
+
+    3. Update the `dependencies` section in `dependencies/<name-of-tool>/build.gradle` to
+      install your dependencies.
+    4. Add the following content to the `Dockerfile`:
+
+        ```dockerfile
+        COPY scripts/install-<name-of-tool>.sh /
+        RUN --mount=type=secret,id=GITHUB_TOKEN /<name-of-tool>.sh && rm -rf /<name-of-tool>.sh
+        ```
+
+    5. Create `scripts/install-<name-of-tool>.sh`, and implement the logic to install your tool.
+      You get the version of a dependency from `build.gradle`. Example:
+
+        ```sh
+        GOOGLE_JAVA_FORMAT_VERSION="$(grep <"google-java-format/build.gradle" "google-java-format" | awk -F ':' '{print $3}' | tr -d "'")"
+        ```
+
+    6. Add the new to DependaBot configuration:
+
+        ```yaml
+          - package-ecosystem: "gradle"
+            directory: "/dependencies/<name-of-tool>"
+            schedule:
+              interval: "weekly"
+            open-pull-requests-limit: 10
+        ```
+
+  - If there is a container (Docker) image:
+
+    1. Add a new build stage to get the image:
+
+        ```dockerfile
+        FROM your/image:version as <name-of-tool>
+        ```
+
+    1. Copy the necessary binaries and libraries to the relevant locations. Example:
+
+        ```sh
+        COPY --from=<name-of-tool> /usr/local/bin/<name-of-command> /usr/bin/
+        ```
+
+- Configure the new tool:
+
+  - Provide a default configuration file only if the tool cannot function without one: `TEMPLATES/<template file for language>`
+  - Provide a configuration file for the new linter only if the default configuration is unsuitable for the super-linter repository: `.github/linters/.<lintrc>`
+
+- Update the orchestration scripts to run the new tool:
+
+  - `lib/linter.sh`
+  - Provide the logic to populate the list of files or directories to examine: `lib/buildFileList.sh`
+  - If necessary, provide elaborate logic to detect if the tool should examine a file or a directory: `lib/detectFiles.sh`
+  - If the tool needs to take into account special cases:
+
+    - Provide new runtime validation checks in `lib/validation.sh`.
+    - Customize the logic to get the installed version of the tool: `lib/linterVersions.sh`
+    - Provide custom logic to load configuration files: `lib/linterRules.sh`
+    - Provide custom logic for test cases and to run the tool: `lib/worker.sh`
@@ -1,4 +1,4 @@
-# Creating GitHub Super-Linter Release
+# Creating Super-Linter Release
 
 The Process to create a `Release` of the **super-linter/super-linter** is as follows: