From 75ba91a14620afc5d2b2a5a25e4e31f4d25fb9e8 Mon Sep 17 00:00:00 2001 From: Lazaro Alonso Date: Mon, 9 Mar 2026 09:23:22 +0100 Subject: [PATCH] do less --- .JuliaFormatter.toml | 3 --- .all-contributorsrc | 5 ---- .copier-answers.yml | 12 ---------- .editorconfig | 10 -------- .markdownlint.json | 13 ----------- .pre-commit-config.yaml | 49 ---------------------------------------- .yamllint.yml | 2 -- README.md | 5 ++-- docs/src/91-developer.md | 37 ------------------------------ lychee.toml | 11 --------- 10 files changed, 2 insertions(+), 145 deletions(-) delete mode 100644 .JuliaFormatter.toml delete mode 100644 .all-contributorsrc delete mode 100644 .copier-answers.yml delete mode 100644 .editorconfig delete mode 100644 .markdownlint.json delete mode 100644 .pre-commit-config.yaml delete mode 100644 .yamllint.yml delete mode 100644 lychee.toml diff --git a/.JuliaFormatter.toml b/.JuliaFormatter.toml deleted file mode 100644 index fb22863..0000000 --- a/.JuliaFormatter.toml +++ /dev/null @@ -1,3 +0,0 @@ -indent = 2 -margin = 92 -normalize_line_endings = "unix" diff --git a/.all-contributorsrc b/.all-contributorsrc deleted file mode 100644 index f51dc78..0000000 --- a/.all-contributorsrc +++ /dev/null @@ -1,5 +0,0 @@ -{ - "projectName": "UnpackSinTiles", - "projectOwner": "lazarusA", - "files": ["README.md", "docs/src/index.md"] -} diff --git a/.copier-answers.yml b/.copier-answers.yml deleted file mode 100644 index 7ed37cd..0000000 --- a/.copier-answers.yml +++ /dev/null @@ -1,12 +0,0 @@ -# Changes here will be overwritten by Copier -AnswerStrategy: recommended -AuthorEmail: lazarus.alon@gmail.com -AuthorName: Lazaro Alonso -Indentation: 2 -JuliaMinVersion: '1.10' -License: MIT -PackageName: UnpackSinTiles -PackageOwner: lazarusA -PackageUUID: 017367d4-aa44-5400-a2e3-1f6255c9d3f1 -_commit: v0.9.1 -_src_path: https://github.com/JuliaBesties/BestieTemplate.jl diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 9f5c55f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,10 +0,0 @@ -# https://editorconfig.org -root = true - -[*] -end_of_line = lf -insert_final_newline = true -charset = utf-8 -indent_size = 2 -indent_style = space -trim_trailing_whitespace = true diff --git a/.markdownlint.json b/.markdownlint.json deleted file mode 100644 index 8bf958a..0000000 --- a/.markdownlint.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "MD007": { - "indent": 2, - "start_indented": false - }, - "MD013": { - "line_length": 1000, - "tables": false - }, - "MD033": false, - "MD041": false, - "default": true -} diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml deleted file mode 100644 index d21ba48..0000000 --- a/.pre-commit-config.yaml +++ /dev/null @@ -1,49 +0,0 @@ -repos: - - repo: local - hooks: - # Prevent committing .rej files - - id: forbidden-files - name: forbidden files - entry: found Copier update rejection files; review them and remove them - language: fail - files: "\\.rej$" - - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.6.0 - hooks: - - id: check-json - - id: check-toml - - id: check-yaml - - id: end-of-file-fixer - - id: file-contents-sorter - files: .JuliaFormatter.toml - args: [--unique] - - id: mixed-line-ending - args: [--fix=lf] - - id: no-commit-to-branch - - id: pretty-format-json - args: [--autofix, --indent=2] - - id: trailing-whitespace - - id: check-merge-conflict - args: [--assume-in-merge] - - repo: https://github.com/igorshubovych/markdownlint-cli - rev: v0.41.0 - hooks: - - id: markdownlint-fix - - repo: https://github.com/citation-file-format/cffconvert - rev: 054bda51dbe278b3e86f27c890e3f3ac877d616c - hooks: - - id: validate-cff - - repo: https://github.com/pre-commit/mirrors-prettier - rev: "v4.0.0-alpha.8" # Use the sha or tag you want to point at - hooks: - - id: prettier - types_or: [yaml, json] - exclude: ".copier-answers.yml" - - repo: https://github.com/adrienverge/yamllint - rev: v1.35.1 - hooks: - - id: yamllint - - repo: https://github.com/domluna/JuliaFormatter.jl - rev: v1.0.58 - hooks: - - id: julia-formatter diff --git a/.yamllint.yml b/.yamllint.yml deleted file mode 100644 index 5e16e5f..0000000 --- a/.yamllint.yml +++ /dev/null @@ -1,2 +0,0 @@ -rules: - indentation: { spaces: 2 } diff --git a/README.md b/README.md index d91ae11..4be7d02 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,10 @@ [![Build Status](https://github.com/lazarusA/UnpackSinTiles.jl/workflows/Test/badge.svg)](https://github.com/lazarusA/UnpackSinTiles.jl/actions) [![Test workflow status](https://github.com/lazarusA/UnpackSinTiles.jl/actions/workflows/Test.yml/badge.svg?branch=main)](https://github.com/lazarusA/UnpackSinTiles.jl/actions/workflows/Test.yml?query=branch%3Amain) [![Docs workflow Status](https://github.com/lazarusA/UnpackSinTiles.jl/actions/workflows/Docs.yml/badge.svg?branch=main)](https://github.com/lazarusA/UnpackSinTiles.jl/actions/workflows/Docs.yml?query=branch%3Amain) - [![Coverage](https://codecov.io/gh/lazarusA/UnpackSinTiles.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/lazarusA/UnpackSinTiles.jl) - [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md) -[![All Contributors](https://img.shields.io/github/all-contributors/lazarusA/UnpackSinTiles.jl?labelColor=5e1ec7&color=c0ffee&style=flat-square)](#contributors) + + ## How to Cite diff --git a/docs/src/91-developer.md b/docs/src/91-developer.md index ec92a5f..82e31b0 100644 --- a/docs/src/91-developer.md +++ b/docs/src/91-developer.md @@ -23,43 +23,6 @@ If this is the first time you work with this repository, follow the instructions This will ensure that you have two remotes in your git: `origin` and `upstream`. You will create branches and push to `origin`, and you will fetch and update your local `main` branch from `upstream`. -## Linting and formatting - -Install a plugin on your editor to use [EditorConfig](https://editorconfig.org). -This will ensure that your editor is configured with important formatting settings. - - -We use [https://pre-commit.com](https://pre-commit.com) to run the linters and formatters. -In particular, the Julia code is formatted using [JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl), so please install it globally first: - -```julia-repl -julia> # Press ] -pkg> activate -pkg> add JuliaFormatter -``` - -To install `pre-commit`, we recommend using [pipx](https://pipx.pypa.io) as follows: - -```bash -# Install pipx following the link -pipx install pre-commit -``` - -With `pre-commit` installed, activate it as a pre-commit hook: - -```bash -pre-commit install -``` - -To run the linting and formatting manually, enter the command below: - -```bash -pre-commit run -a -``` - -**Now, you can only commit if all the pre-commit tests pass**. - - ## Testing As with most Julia packages, you can just open Julia in the repository folder, activate the environment, and run `test`: diff --git a/lychee.toml b/lychee.toml deleted file mode 100644 index 2685130..0000000 --- a/lychee.toml +++ /dev/null @@ -1,11 +0,0 @@ -exclude = [ - "@ref", - "^https://github.com/.*/releases/tag/v.*$", - "^https://doi.org/FIXME$", - "^https://lazarusA.github.io/UnpackSinTiles.jl/stable$", - "zenodo.org/badge/DOI/FIXME$" -] - -exclude_path = [ - "docs/build" -]