Skip to content

Commit

Permalink
refactor: streamline project setup and configuration
Browse files Browse the repository at this point in the history
- Simplified environment setup by updating .envrc and removing unnecessary Python-specific configurations.
- Consolidated and centralized configuration files for MegaLinter and Renovate.
- Removed redundant CI workflows and optimized MegaLinter workflow.
- Updated .gitignore to exclude unnecessary LaTeX and Python-generated files.
- Enhanced LaTeX formatting configuration and VSCode settings for better LaTeX support.
- Removed outdated and redundant documentation and demo files.
- Updated license information and Makefile to reflect current project structure.

This refactor improves maintainability and reduces redundancy across the project.
  • Loading branch information
liblaf committed Nov 8, 2024
1 parent b4581d7 commit a40bd88
Show file tree
Hide file tree
Showing 86 changed files with 267 additions and 1,714 deletions.
87 changes: 79 additions & 8 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,88 @@
"$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/packages/cspell-types/cspell.schema.json",
"version": "0.2",
"language": "en",
"words": [],
"words": [
"achemso",
"amsmath",
"amssymb",
"amsthm",
"auctex",
"beamer",
"biber",
"cleveref",
"cprotect",
"csdef",
"ctex",
"dpth",
"eledsec",
"enumitem",
"esint",
"etoolbox",
"expex",
"fancyhdr",
"feynmf",
"feynmp",
"gaux",
"glog",
"glsdefs",
"glstex",
"graphicx",
"gtex",
"gummi",
"htlatex",
"iwork",
"kfamily",
"kile",
"knitr",
"kvoptions",
"latexmk",
"liblaf",
"ltjruby",
"luatexja",
"makeidx",
"mathrsfs",
"minitoc",
"nofootinbib",
"noitemsep",
"nolinkurl",
"pdfpc",
"pdfpcnotes",
"pytxcode",
"redef",
"runin",
"sarif",
"scmd",
"scrwfile",
"siunitx",
"sout",
"stefanzweifel",
"sympy",
"tabularx",
"tcolorbox",
"texpadtmp",
"textbf",
"theid",
"thetcbcounter",
"thmtools",
"tikz",
"titletoc",
"todonotes",
"vhistory",
"xcolor",
"xindy",
"xmpi",
"xmpincl",
"xnic",
"xparse",
"xwatermark",
"xypic"
],
"ignorePaths": [
".vscode",
"**/.cspell.*",
"**/.git/**",
"**/.git",
"**/.vscode",
"**/*-lock.*",
"**/*.lock*",
"**/node_modules/**",
"**/vscode-extension/**",
"megalinter",
"report"
"**/*.lock*"
],
"allowCompoundWords": true
}
3 changes: 2 additions & 1 deletion .envrc
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
layout micromamba
#!/bin/bash
export TEXINPUTS=".:$PWD:"
2 changes: 1 addition & 1 deletion .github/.mega-linter.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
# ref: <https://megalinter.io/latest/config-file/>

EXTENDS:
- https://github.com/liblaf/repo/raw/refs/heads/main/.github/linters/.mega-linter.yaml
- https://github.com/liblaf/.github/raw/refs/heads/main/.mega-linter.yaml
6 changes: 6 additions & 0 deletions .github/copier/.copier-answers.share.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
_commit: f98a063
_src_path: gh:liblaf/copier-share
copyright_holder: liblaf
license: MIT
owner: liblaf
3 changes: 1 addition & 2 deletions .github/renovate.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": ["config:recommended", "default:automergeAll"],
"gitIgnoredAuthors": ["66853113+pre-commit-ci[bot]@users.noreply.github.com"]
"extends": ["github>liblaf/.github:renovate-config"]
}
23 changes: 0 additions & 23 deletions .github/workflows/ci.yaml

This file was deleted.

42 changes: 0 additions & 42 deletions .github/workflows/docs.yaml

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ name: MegaLinter
on:
push:
pull_request:
branches:
- main

env:
APPLY_FIXES: all
Expand All @@ -19,7 +17,7 @@ concurrency:
cancel-in-progress: true

jobs:
megalinter:
mega-linter:
name: MegaLinter
permissions:
contents: write
Expand All @@ -42,8 +40,6 @@ jobs:
# Common Variables
MEGALINTER_CONFIG: .github/.mega-linter.yaml
VALIDATE_ALL_CODEBASE: true
# Linters
PYTHON_PYRIGHT_DISABLE_ERRORS: true
# Reporters
TEXT_REPORTER: true
GITHUB_COMMENT_REPORTER: true
Expand All @@ -70,14 +66,6 @@ jobs:
- if: success() || failure()
name: Add GitHub summary
run: cat megalinter-reports/megalinter-report.md >> "$GITHUB_STEP_SUMMARY"
- name: Remove MegaLinter reports
run: >-
sudo rm --force --recursive
.checkov.yml
.devskim.json
kics.config
mega-linter.log
megalinter-reports/
- id: cpr
if: >-
steps.ml.outputs.has_updated_sources == 1 &&
Expand All @@ -95,8 +83,8 @@ jobs:
uses: peter-evans/create-pull-request@v7
with:
token: ${{ github.token }}
commit-message: "chore(MegaLinter): apply linters automatic fixes"
title: "chore(MegaLinter): apply linters automatic fixes"
commit-message: "chore(mega-linter): apply linters automatic fixes"
title: "chore(mega-linter): apply linters automatic fixes"
# TODO: add labels
- if: >-
steps.ml.outputs.has_updated_sources == 1 &&
Expand Down Expand Up @@ -145,12 +133,13 @@ jobs:
name: Commit and push applied linter fixes
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: "chore(mega-linter): apply linters fixes"
branch: >-
${{
github.event.pull_request.head.ref ||
github.head_ref ||
github.ref
}}
commit_message: "chore(MegaLinter): apply linters fixes"
add_options: --update
commit_user_name: megalinter-bot
commit_user_email: [email protected]
Loading

0 comments on commit a40bd88

Please sign in to comment.