Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update pre-commit hooks and config for 2024-09 #383

Merged
merged 3 commits into from
Sep 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 0 additions & 17 deletions .eslintrc.json

This file was deleted.

5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Issue Report

<!--- **PLEASE NOTE:** This is the issue tracker for Spyder's documentation, not problems with the Spyder application itself nor general help with Spyder. For that, please see the main Spyder repo: <https://github.com/spyder-ide/spyder> . --->

<!--- Please make sure you fill out this template completely so we can find and fix your issue. Otherwise, it may be closed. Thanks! --->

# Issue Report

## Issue Description

Expand Down Expand Up @@ -35,7 +36,7 @@
* [ ] Spyder 3 (``3.x``, frozen)


* Are you planning on submitting a Github pull request with a suitable change?
* Are you planning on submitting a GitHub pull request with a suitable change?

* [ ] Yes
* [ ] No
Expand Down
3 changes: 2 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Pull Request

<!--- Before submitting your pull request, --->
<!--- please complete as much as possible of the following checklist: --->

# Pull Request

## Pull Request Checklist

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ jobs:
with:
python-version: '3.11'
- name: Run pre-commit hooks
uses: pre-commit/[email protected].0
uses: pre-commit/[email protected].1
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ develop-eggs/
dist/
downloads/
eggs/
lib/
lib64/
MANIFEST
parts/
Expand Down
44 changes: 0 additions & 44 deletions .markdownlint.json

This file was deleted.

146 changes: 146 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
# Configuration file for markdownlint

# Default state for all rules
default: true

# MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md003.md
heading-style:
# Heading style
style: 'atx'

# MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md004.md
ul-style:
# List style
style: 'asterisk'

# MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md007.md
ul-indent:
# Spaces for indent
indent: 4
# Whether to indent the first level of the list
start_indented: false
# Spaces for first level indent (when start_indented is set)
start_indent: 4

# MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md009.md
no-trailing-spaces:
# Spaces for line break
br_spaces: 0
# Allow spaces for empty lines in list items
list_item_empty_lines: false
# Include unnecessary breaks
strict: true

# MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md010.md
no-hard-tabs:
# Include code blocks
code_blocks: true
# Fenced code languages to ignore
ignore_code_languages: []
# Number of spaces for each hard tab
spaces_per_tab: 4

# MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md012.md
no-multiple-blanks:
# Consecutive blank lines
maximum: 4

# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
line-length: false

# MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md022.md
blanks-around-headings:
# Blank lines above heading
lines_above: 2
# Blank lines below heading
lines_below: 1

# MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md024.md
no-duplicate-heading:
# Only check sibling headings
siblings_only: true

# MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md029.md
ol-prefix:
# List style
style: 'one'

# MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md031.md
blanks-around-fences:
# Include list items
list_items: false

# MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md035.md
hr-style:
# Horizontal rule style
style: '---'

# MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md040.md
fenced-code-language:
# List of languages
allowed_languages: []
# Require language only
language_only: true

# MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md044.md
MD044:
# List of proper names
names:
- 'CAM Gerlach'
- 'GitHub'
- 'github.com'
- 'Python'
- 'python.org'
- 'reStructuredText'
- 'Sphinx'
- 'sphinx-doc.org'
- 'Spyder'
- 'Spyder-IDE'
- 'spyder-ide.org'
- 'Spyder-API-Docs'
- 'Spyder-Docs'
- 'Spyder-Website'
# Include code blocks
code_blocks: false
# Include HTML elements
html_elements: false

# MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md046.md
code-block-style:
# Block style
style: 'fenced'

# MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md048.md
code-fence-style:
# Code fence style
style: 'backtick'

# MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md049.md
emphasis-style:
# Emphasis style
style: 'asterisk'

# MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md050.md
strong-style:
# Strong style
style: 'asterisk'

# MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md054.md
link-image-style:
# Allow autolinks
autolink: false
# Allow inline links and images
inline: true
# Allow full reference links and images
full: true
# Allow collapsed reference links and images
collapsed: false
# Allow shortcut reference links and images
shortcut: false
# Allow URLs as inline links
url_inline: false

# MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md055.md
table-pipe-style:
# Table pipe style
style: 'leading_and_trailing'
Loading