Skip to content

Commit

Permalink
Update hook configuration with new/changed settings since last upgrade
Browse files Browse the repository at this point in the history
  • Loading branch information
CAM-Gerlach committed Sep 22, 2024
1 parent 038d6c5 commit fe0454f
Show file tree
Hide file tree
Showing 12 changed files with 209 additions and 101 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,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
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'
44 changes: 23 additions & 21 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,6 @@ repos:
exclude: '\.gitattributes|\bworkshops\b'
args: [--write-changes]

# Format CSS with Prettier
- repo: https://github.com/rbubley/mirrors-prettier
rev: v3.3.3
hooks:
- id: prettier
name: Format CSS (Prettier)
types: [css]

# Lint and fix CSS with stylelint
- repo: https://github.com/thibaudcolas/pre-commit-stylelint
rev: v16.9.0
Expand All @@ -91,6 +83,14 @@ repos:
# https://github.com/RJWadley/stylelint-no-unsupported-browser-features/issues/299
- 'caniuse-lite@1.0.30001653'

# Format CSS with Prettier
- repo: https://github.com/rbubley/mirrors-prettier
rev: v3.3.3
hooks:
- id: prettier
name: Format CSS (Prettier)
types: [css]

# Pretty-format INI
- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
rev: v2.14.0
Expand All @@ -100,14 +100,6 @@ repos:
types: [ini]
args: [--autofix]

# Format JavaScript with Prettier
- repo: https://github.com/rbubley/mirrors-prettier
rev: v3.3.3
hooks:
- id: prettier
name: Format JavaScript (Prettier)
types: [javascript]

# Lint and fix JavaScript
- repo: https://github.com/eslint/eslint
rev: v9.11.0
Expand All @@ -121,14 +113,23 @@ repos:
- 'eslint-plugin-promise@7.1.0'
- 'neostandard@0.11.5'

# Format JavaScript with Prettier
- repo: https://github.com/rbubley/mirrors-prettier
rev: v3.3.3
hooks:
- id: prettier
name: Format JavaScript (Prettier)
types: [javascript]

# Lint Jinja
- repo: https://github.com/thibaudcolas/curlylint
rev: v0.13.1
hooks:
- id: curlylint
name: Lint Jinja templates
types: [html]
types: [html, jinja, twig]
files: 'templates/'
require_serial: true

# Check JSON
- repo: https://github.com/pre-commit/pre-commit-hooks
Expand All @@ -146,10 +147,10 @@ repos:
args: [--maxlevel, '3', --update-only]

# Lint Markdown
- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.41.0
- repo: https://github.com/DavidAnson/markdownlint-cli2
rev: v0.14.0
hooks:
- id: markdownlint
- id: markdownlint-cli2
name: Lint Markdown
args: [--fix]

Expand Down Expand Up @@ -181,6 +182,7 @@ repos:
hooks:
- id: python-safety-dependencies-check
name: Check Python dependencies (Safety)
args: [--disable-optional-telemetry]
files: '.*requirements.*.txt'
types: [text]

Expand Down Expand Up @@ -235,7 +237,7 @@ repos:
- id: yamllint
name: Lint YAML
types: [yaml]
args: [-s, -f, colored]
args: [--strict, --format, colored]

# Replace CRLF with LF post-prettify
- repo: https://github.com/Lucas-C/pre-commit-hooks
Expand Down
4 changes: 2 additions & 2 deletions .prettierrc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ tabWidth: 2
useTabs: false
semi: true
singleQuote: false
trailingComma: 'es5'
trailingComma: 'all'
bracketSpacing: false
arrowParens: 'always'
proseWrap: 'preserve'
endOfLine: 'lf'
singleAttributePerLine: false
singleAttributePerLine: true

overrides:
- files: '*.css'
Expand Down
2 changes: 2 additions & 0 deletions .yamllint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ rules:
spaces: 2
indent-sequences: consistent
check-multi-line-strings: true
key-duplicates:
forbid-duplicated-merge-keys: true
line-length: disable
new-lines: disable
octal-values: enable
Expand Down
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ First off, thanks for your interest in helping out with the documentation for Sp

**Important Note:** This is the repository for the documentation sources used to build the [Spyder docs site](https://docs.Spyder-IDE.org/)—not the IDE itself.
For more information about Spyder, please see the [website](https://www.spyder-ide.org/), and for the core Spyder codebase, visit the [main repo](https://github.com/spyder-ide/spyder).
You can view the live documentation for current and past Spyder versions at [docs.Spyder-IDE.org](https://docs.spyder-ide.org).
You can view the live documentation for current and past Spyder versions at [docs.spyder-ide.org](https://docs.spyder-ide.org).

Spyder-Docs is part of the Spyder IDE GitHub org, and is developed with standard GitHub flow.
If you're not comfortable with at least the basics of ``git`` and GitHub, we recommend reading beginner tutorials such as [GitHub's Git Guide](https://github.com/git-guides/), its [introduction to basic Git commands](https://docs.github.com/en/get-started/using-git/about-git#basic-git) and its [guide to the fork workflow](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project).
Expand Down Expand Up @@ -313,7 +313,7 @@ Where ``<FEATURE-BRANCH>`` is the name of your feature branch, e.g. ``fix-docs-t

## Submitting a Pull Request

Finally, create a pull request to the [spyder-ide/spyder-docs repository](https://github.com/spyder-ide/spyder-docs/) on GitHub.
Finally, create a pull request to the [``spyder-ide/spyder-docs`` repository](https://github.com/spyder-ide/spyder-docs/) on GitHub.
Make sure to set the target branch to the one you based your PR off of (``master`` or ``X.x``).

We'll then review your changes, and after they're ready to go, your work will become an official part of Spyder-Docs.
Expand All @@ -324,6 +324,7 @@ Thanks for taking the time to read and follow this guide, and we look forward to

## Standards and Conventions


### Key standards

Make sure you follow these to ensure clarity, consistency and correctness throughout our documentation and its repo.
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,14 @@
## Overview

This repository contains the documentation for Spyder, the Scientific Python Development Environment.
You can view the live docs for current and past Spyder versions at [docs.Spyder-IDE.org](https://docs.spyder-ide.org).
You can view the live docs for current and past Spyder versions at [docs.spyder-ide.org](https://docs.spyder-ide.org).

For more information about Spyder itself, please see our [website](https://www.spyder-ide.org/) and the [main repo](https://github.com/spyder-ide/spyder).


## Building and Deploying

The docs are built with [Sphinx](https://www.sphinx-doc.org/) and deployed with GitHub Actions to the [docs.Spyder-IDE.org](https://docs.spyder-ide.org/) domain.
The docs are built with [Sphinx](https://www.sphinx-doc.org/) and deployed with GitHub Actions to the [docs.spyder-ide.org](https://docs.spyder-ide.org/) domain.
[Nox](https://nox.thea.codes/) is used to automate setup, building and numerous other project tasks.
The ``master`` branch contains the in-development docs for Spyder 5, while the frozen ``4.x`` and ``3.x`` branches retain the docs for Spyder 4 and Spyder 3.

Expand All @@ -61,7 +61,7 @@ Thanks for your interest in Spyder and its documentation, and we appreciate your

[Online Documentation](https://docs.spyder-ide.org/)

[Spyder Github](https://github.com/spyder-ide/spyder)
[Spyder GitHub](https://github.com/spyder-ide/spyder)

[Development Wiki](https://github.com/spyder-ide/spyder/wiki/Dev:-Index)

Expand Down
3 changes: 2 additions & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Security Policy


## Reporting a Vulnerability

If you believe you've discovered a security vulnerability in this website or its dependencies, please contact the docs maintainer at <CAM.Gerlach@Gerlach.CAM> or the Spyder team at <spyder.python@gmail.com>.
If you believe you've discovered a security vulnerability in this website or its dependencies, please contact the docs maintainer at <CAM.Gerlach@Gerlach.CAM> or the Spyder team at <spyder.python@gmail.com>. <!-- markdownlint-disable-line link-image-style -->
Please be sure to carefully document the vulnerability, including a summary, describing the impacts, identifying the line(s) of code affected, stating the conditions under which it is exploitable and including a minimal reproducible test case.
Further information and advice or patches on how to mitigate it is always welcome.
You can usually expect to hear back within one week, at which point we'll inform you of our evaluation of the vulnerability and what steps we plan to take, and will reach out if we need further clarification from you.
Expand Down
Loading

0 comments on commit fe0454f

Please sign in to comment.