Make little changes about copier-python HOT 43 CLOSED

These may not be necessary. See how debugging behaves and decide...

• As in boilercv, modify last launch.json entry to permit temporary deeper debugging of failed tests.

    {
      "name": "Python: Current file, not just my code",
      "type": "python",
      "request": "launch",
      "program": "${file}",
      "justMyCode": false,
      // "purpose": ["debug-test"], // Temporarily uncomment to debug tests deeply.
      "console": "internalConsole"
    }

• Implement a talisman pre-commit hook to forbid it to be uncommented by commit time. (https://github.com/thoughtworks/talisman#custom-search-patterns)

from copier-python.

• Make pyproject.toml additions

    "F841",   # Don't check for or fix unused variables

from copier-python.

• Implement requirements_nodeps.txt like in boilercv, including changes to "blakeNaccarato/[email protected]"

from copier-python.

• Incorporate the advice in the latest Pylance documentation

https://github.com/microsoft/pylance-release/blob/main/USING_WITH_PYRIGHT.md

from copier-python.

• Add local hooks like in captivate

from copier-python.

• Rebuild docs when root-level Markdown files change, too, as in boilercv

from copier-python.

• Wrap occurrences of ${file} and other similar variables in tasks.json and launch.json with single quotes to permit paths with spaces

from copier-python.

• Compose pyproject.toml as local pre-commit hook

from copier-python.

• Ensure ruff bumping script is actually working.

from copier-python.

• Back-propagate ruff GitHub Action from boilercv

from copier-python.

• Try/catch version-related copier error in template bumping, updating copier if necessary

from copier-python.

• Propagate pre-commit related changes back from boilercv

from copier-python.

• Make tasks more verbose but more robust to commands with spaces in paths, etc.

For example, see the below task where ${file} may contain spaces. The more compact representation just uses pwsh as command and array ["-Command", "..."] as args, where "..." represents the input isolated at command below. The implementation below gracefully handles spaces (in a single-quoted VSCode variable as below), whereas the approach seen in copier-python template tasks right now is fragile to this.

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Sort by package identifier",
      "type": "shell",
      "options": {
        "shell": { "executable": "pwsh", "args": ["-Command"] }
      },
      "command": "Get-ChildItem '${file}' | Invoke-Python -Module sort_by_package_identifier | prettier --parser json | Set-Content '${file}'",
      "icon": { "id": "json" },
      "problemMatcher": []
    }
  ]
}

from copier-python.

• Change pyrightconfig.json include statement to "include": ["src", "tests"] so that module renaming propagates to tests

from copier-python.

• Exclude Pylance temporary files so they can be filtered in the problems pane

.vscode/settings.json

  //* Exclude problematic files in Problems panel filter and elsewhere
  "files.exclude": {
    "**/.git": true,
    "**/.svn": true,
    "**/.hg": true,
    "**/CVS": true,
    "**/.DS_Store": true,
    "**/Thumbs.db": true,
    //? Pylance notebook cell temp files that get picked up in Problems pane before deletion
    "**/*pylance-notebook-cell*": true
  },

from copier-python.

• Add GitHub annotations to Pytest output

https://github.com/pytest-dev/pytest-github-actions-annotate-failures

• Add GitHub annotations to Pyright output

https://github.com/jordemort/action-pyright

from copier-python.

• Propagate update.ps1 from softboiler/boilerdata@18288f2

from copier-python.

• Figure out correct configuration of "git.commandsToLog": ["commit", "push"], to get pre-commit stdout showing in Output window. See boilerdata

from copier-python.

• Add "active" question to the Copier template. Enable monthly checks for PRs based on its state.

from copier-python.

• Establish top-level .pre-commit-config.yaml to install all hooks by default and other things

See the docs. Be careful with default_stages, which will cause all things to run at a certain stage. Could be useful as pre-push, but probably unnecessary.

from copier-python.

• Expand documentation rebuilding to happen when deps/requirements change as wel

from copier-python.

• Recommend setting the following in .gitconfig so that local submodules update upon pulling/syncing changes as well

Also need to explore why sometimes clicking the "sync" button to push changes to remote fails in VSCode GUI. Has something to do with the GUI trying to pull first. Change this behavior, possibly?

[submodule]
    recurse = true

from copier-python.

• Consider pinning docutils to 0.17.1 until myst-parser allows later (e.g. 0.20 and up) docutils versions

See the page rendering issue when using a bibliography, though footbibliography works fine.

executablebooks/jupyter-book#1997 (comment)
https://jupyterbook.org/en/stable/content/citations.html

from copier-python.

• Update core template configs, including disabling Renovate automerge.

from copier-python.

• Consider the effect of bumping the pages upload action, as it now requires the user to chmod properly.

https://github.com/actions/upload-pages-artifact/releases/tag/v1.0.9

from copier-python.

• Check that bumping myst-parser to 2.0 doesn't break websites when propagated to other templates

from copier-python.

• Add git commit, git pull, and git push tasks

from copier-python.

• Bump version of ruff in nbqa-ruff pre-commit hook alongside main ruff bump

from copier-python.

• Add punctuation to readme and init where the Copier description goes

from copier-python.

• Incorporate question about private/public repo, and disable tools like Sourcery or Pre-commit CI if the repo is private

from copier-python.

• Make all pip install commands on the same line to reduce runaround during update.ps1

from copier-python.

• Fix tasks that call PowerShell functions, e.g. softboiler/boilerdaq@eb5c841

from copier-python.

• Keep track of #349 and whether this breaks any deploys because chmod is not being done on every file anymore

from copier-python.

• See whether fawltydeps can be used as a pre-commit hook https://github.com/tweag/FawltyDeps/releases/tag/v0.12.1

from copier-python.

• See if underlying Sphinx is bumped after new release of https://github.com/executablebooks/sphinx-design

from copier-python.

• Pin flit in pyproject.toml

from copier-python.

• Figure out cache excluding for large dependencies, for example opencv, https://github.com/actions/toolkit/tree/main/packages/glob#exclude-patterns

from copier-python.

• Add fawltydeps to Renovate exclusions and manage the dependency here

from copier-python.

• Propagate Python script-based warning filtering back here

from copier-python.

• Introduce the all-contributors automation like nbQA has

https://github.com/nbQA-dev

from copier-python.

• Don't wrap TXT files by default

from copier-python.

• Fix template script

The $Recopy path always forces without questions due to --force. Remove that so the --defaults flag can function

    copier recopy --force $(if ($Defaults) { '--defaults' })

from copier-python.

Wow, guess I did most of this!

from copier-python.