[DEVOPS-1591] Install pre-commit, and fix all files (#12)

Install pre-commit, and fix all files

Author: robwittman

.github/workflows/build.yml

@@ -28,3 +28,24 @@ jobs:
           VALIDATE_BASH_EXEC: true
           VALIDATE_DOCKERFILE_HADOLINT: true
           VALIDATE_YAML: true
+
+  run-hooks:
+    name: Run pre-commit hooks
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+
+      - name: Set Up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+
+      - name: Install pre-commit
+        run: |
+          pip install --upgrade pip
+          pip install --upgrade pre-commit
+
+      - name: Run pre-commit hooks ✅
+        run: pre-commit run --all-files --hook-stage manual

.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.2.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-added-large-files
+      - id: check-shebang-scripts-are-executable
+      - id: check-executables-have-shebangs
+
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.9.0.5
+    hooks:
+      - id: shellcheck
+        args: ["-x"]
+
+  - repo: https://github.com/hadolint/hadolint.git
+    rev: v2.12.1-beta
+    hooks:
+      - id: hadolint-docker
+        entry: hadolint/hadolint:v2.12.1-beta hadolint
+
+  # Lint: YAML
+  - repo: https://github.com/adrienverge/yamllint.git
+    rev: v1.32.0
+    hooks:
+      - id: yamllint
+        args: [ "-d {extends: relaxed, rules: {line-length: disable}}", "-s" ]
+        files: \.(yaml|yml)$

CODE_OF_CONDUCT.md

@@ -26,4 +26,4 @@ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

CONTRIBUTING.md

@@ -3,12 +3,12 @@ library(repr)
 library(reticulate)
 
 prepare_dex_content <- function(df) {
-  #' 
+  #'
   #' Create schema and data structure for data frame to be rendered by DEX
-  #' 
+  #'
 
   # create a schema for a dataframe, which DEX uses to determine column dtypes.
-  # R data frames don't have this functionality, so we have to use reticulate 
+  # R data frames don't have this functionality, so we have to use reticulate
   # to call into the python pandas library
   pandas <- import("pandas")
 
@@ -41,9 +41,9 @@ prepare_dex_content <- function(df) {
 }
 
 prepare_dex_metadata <- function(df) {
-  #' 
+  #'
   #' Create metadata for data frame to be rendered by DEX
-  #' 
+  #'
   list(
     default_index_used=TRUE,
     dataframe_info = list(
@@ -72,11 +72,11 @@ repr_dex <- function(obj, ...) {
 enable_dex_formatter <- function() {
   # Add custom display formatter to newly added mimetype
   IRkernel:::replace_in_package('repr', 'mime2repr', c(repr::mime2repr, list(`application/vnd.dataresource+json` = repr_dex)))
-  
+
   # Add dataresource mimetype to list of recognized mimetypes
   mimetypes <- c(getOption('jupyter.display_mimetypes'), "application/vnd.dataresource+json")
   options(jupyter.display_mimetypes = mimetypes)
-  
+
   # Register custom formatter for matrix and data.frame
   registerS3method("repr_html", "matrix", repr_dex)
   registerS3method("repr_html", "data.frame", repr_dex)
@@ -85,11 +85,11 @@ enable_dex_formatter <- function() {
 disable_dex_formatter <- function() {
   # Remove custom display formatter
   IRkernel:::replace_in_package('repr', 'mime2repr', repr::mime2repr)
-  
+
   # Remove dataresource mimetype from list of recognized mimetypes
   mimetypes <- setdiff(getOption('jupyter.display_mimetypes'), "application/vnd.dataresource+json")
   options(jupyter.display_mimetypes = mimetypes)
-  
+
   # Reset the formatter for matrix and data.frame to the default
   registerS3method("repr_html", "matrix", repr:::repr_html.matrix)
   registerS3method("repr_html", "data.frame", repr:::repr_html.data.frame)