Skip to content

Commit

Permalink
Set up editorconfig and MegaLinter
Browse files Browse the repository at this point in the history
  • Loading branch information
pkubowicz committed Dec 16, 2023
1 parent f49a3ef commit 80d7e15
Show file tree
Hide file tree
Showing 6 changed files with 231 additions and 139 deletions.
15 changes: 15 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
root = true
[*]
charset = utf-8
end_of_line = lf
indent_style = space
indent_size = 4
insert_final_newline = true
max_line_length = 120
trim_trailing_whitespace = true

[*.yml]
indent_size = 2

[{Makefile,README,*.pl,*.sh,*.l,*.h}]
indent_style = tab
62 changes: 62 additions & 0 deletions .github/workflows/mega-linter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
# MegaLinter GitHub Action configuration file
# More info at https://megalinter.io
name: MegaLinter

on:

Check warning on line 6 in .github/workflows/mega-linter.yml

View workflow job for this annotation

GitHub Actions / MegaLinter

6:1 [truthy] truthy value should be one of [false, true]
# Trigger mega-linter at every push. Action will also be visible from Pull Requests to main
push: # Comment this line to trigger action only on pull-requests (not recommended if you don't pay for GH Actions)
pull_request:
branches: [master, main]

# env: # Comment env block if you don't want to apply fixes
# Apply linter fixes configuration

Check warning on line 13 in .github/workflows/mega-linter.yml

View workflow job for this annotation

GitHub Actions / MegaLinter

13:3 [comments-indentation] comment not indented like content
# APPLY_FIXES: all # When active, APPLY_FIXES must also be defined as environment variable (in github/workflows/mega-linter.yml or other CI tool)
# APPLY_FIXES_EVENT: pull_request # Decide which event triggers application of fixes in a commit or a PR (pull_request, push, all)
# APPLY_FIXES_MODE: commit # If APPLY_FIXES is used, defines if the fixes are directly committed (commit) or posted in a PR (pull_request)

concurrency:
group: ${{ github.ref }}-${{ github.workflow }}
cancel-in-progress: true

jobs:
megalinter:
name: MegaLinter
runs-on: ubuntu-latest
# permissions:
# Give the default GITHUB_TOKEN write permission to commit and push, comment issues & post new PR

Check warning on line 27 in .github/workflows/mega-linter.yml

View workflow job for this annotation

GitHub Actions / MegaLinter

27:7 [comments-indentation] comment not indented like content
# Remove the ones you do not need
# contents: write
# issues: write
# pull-requests: write
steps:
# Git Checkout
- name: Checkout Code
uses: actions/checkout@v3
with:
token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
fetch-depth: 0 # If you use VALIDATE_ALL_CODEBASE = true, you can remove this line to improve performances

# MegaLinter
- name: MegaLinter
id: ml
# You can override MegaLinter flavor used to have faster performances
# More info at https://megalinter.io/flavors/
uses: oxsecurity/megalinter@v7
env:
# All available variables are described in documentation
# https://megalinter.io/configuration/
VALIDATE_ALL_CODEBASE: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} # Validates all source when push on main, else just the git diff with main. Override with true if you always want to lint all sources
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# ADD YOUR CUSTOM ENV VARIABLES HERE OR DEFINE THEM IN A FILE .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
# DISABLE: COPYPASTE,SPELL # Uncomment to disable copy-paste and spell checks

# Upload MegaLinter artifacts
- name: Archive production artifacts
if: success() || failure()
uses: actions/upload-artifact@v3
with:
name: MegaLinter reports
path: |
megalinter-reports
mega-linter.log
15 changes: 15 additions & 0 deletions .mega-linter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# ENABLE:
# - ACTION
# - EDITORCONFIG
# - REPOSITORY
# - YAML

DISABLE:

Check warning on line 7 in .mega-linter.yml

View workflow job for this annotation

GitHub Actions / MegaLinter

7:1 [document-start] missing document start "---"
- C

Check failure on line 8 in .mega-linter.yml

View workflow job for this annotation

GitHub Actions / MegaLinter

8:1 [indentation] wrong indentation: expected at least 1
- CPP
- SPELL

DISABLE_ERRORS_LINTERS:
- MAKEFILE_CHECKMAKE
- REPOSITORY_CHECKOV
- REPOSITORY_KICS
12 changes: 6 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
# Copyright (c) 1986-2007 Purdue University
# All rights reserved.
#
#
# Developed by: Daniel Trinkle
# Department of Computer Science, Purdue University
# http://www.cs.purdue.edu/
#
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal with the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
#
# o Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimers.
#
#
# o Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimers in the
# documentation and/or other materials provided with the distribution.
#
#
# o Neither the names of Daniel Trinkle, Purdue University, nor the
# names of its contributors may be used to endorse or promote products
# derived from this Software without specific prior written
# permission.
#
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Expand Down
12 changes: 6 additions & 6 deletions detex.h
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
/*
* Copyright (c) 1986-2007 Purdue University
* All rights reserved.
*
*
* Developed by: Daniel Trinkle
* Department of Computer Science, Purdue University
* http://www.cs.purdue.edu/
*
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal with the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
*
* o Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimers.
*
*
* o Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimers in the
* documentation and/or other materials provided with the distribution.
*
*
* o Neither the names of Daniel Trinkle, Purdue University, nor the
* names of its contributors may be used to endorse or promote products
* derived from this Software without specific prior written
* permission.
*
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Expand Down
Loading

0 comments on commit 80d7e15

Please sign in to comment.