Merge pull request #172 from Tecnativa/update-docs

Update docs and add better autoformatting for them

Author: yajo

.github/workflows/ci.yml

@@ -21,16 +21,21 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: generate cache key PY
-        run: echo "::set-env name=PY::$((python -VV; pip freeze) | sha256sum | cut -d' '
+        run:
+          echo "::set-env name=PY::$((python -VV; pip freeze) | sha256sum | cut -d' '
           -f1)"
       - uses: actions/cache@v1
         with:
           path: ~/.cache
-          key: cache-${{ env.PY }}|${{ hashFiles('pyproject.toml') }}|${{ hashFiles('poetry.lock') }}|${{ hashFiles('.pre-commit-config.yaml') }}
+          key:
+            cache-${{ env.PY }}|${{ hashFiles('pyproject.toml') }}|${{
+            hashFiles('poetry.lock') }}|${{ hashFiles('.pre-commit-config.yaml') }}
       - uses: actions/cache@v1
         with:
           path: ~/.local
-          key: local-${{ env.PY }}|${{ hashFiles('pyproject.toml') }}|${{ hashFiles('poetry.lock') }}|${{ hashFiles('.pre-commit-config.yaml') }}
+          key:
+            local-${{ env.PY }}|${{ hashFiles('pyproject.toml') }}|${{
+            hashFiles('poetry.lock') }}|${{ hashFiles('.pre-commit-config.yaml') }}
       - run: git config --global user.name copier-ci
       - run: git config --global user.email copier@copier
       - run: python -m pip install poetry poetry-dynamic-versioning
@@ -56,12 +61,15 @@ jobs:
           python-version: 3.8
       - run: python -m pip install poetry poetry-dynamic-versioning
       - name: generate cache key PY
-        run: echo "::set-env name=PY::$((python -VV; pip freeze) | sha256sum | cut -d' '
+        run:
+          echo "::set-env name=PY::$((python -VV; pip freeze) | sha256sum | cut -d' '
           -f1)"
       - uses: actions/cache@v1
         with:
           path: ~/.cache
-          key: ${{ env.PY }}|${{ hashFiles('pyproject.toml') }}|${{ hashFiles('poetry.lock') }}|${{ hashFiles('.pre-commit-config.yaml') }}
+          key:
+            ${{ env.PY }}|${{ hashFiles('pyproject.toml') }}|${{
+            hashFiles('poetry.lock') }}|${{ hashFiles('.pre-commit-config.yaml') }}
       - run: poetry install
       - name: Build dist
         run: |

.github/workflows/coverage.yml

@@ -17,12 +17,15 @@ jobs:
           python-version: 3.8
       - run: python -m pip install poetry poetry-dynamic-versioning
       - name: generate cache key PY
-        run: echo "::set-env name=PY::$((python -VV; pip freeze) | sha256sum | cut -d' '
+        run:
+          echo "::set-env name=PY::$((python -VV; pip freeze) | sha256sum | cut -d' '
           -f1)"
       - uses: actions/cache@v1
         with:
           path: ~/.cache
-          key: ${{ env.PY }}|${{ hashFiles('pyproject.toml') }}|${{ hashFiles('poetry.lock') }}|${{ hashFiles('.pre-commit-config.yaml') }}
+          key:
+            ${{ env.PY }}|${{ hashFiles('pyproject.toml') }}|${{
+            hashFiles('poetry.lock') }}|${{ hashFiles('.pre-commit-config.yaml') }}
       - run: git config --global user.name copier-ci
       - run: git config --global user.email copier@copier
       - run: poetry install

.prettierrc.yml

@@ -2,3 +2,4 @@
 bracketSpacing: false
 endOfLine: lf
 printWidth: 88
+proseWrap: always

CHANGELOG.md

@@ -1,24 +1,26 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
-This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
+All notable changes to this project will be documented in this file. This project
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
 
 ### Version 3.0.0 (2020-03)
 
-This is a big release with many new features added and improved.
-The code base also received a lot of love and hardening.
+This is a big release with many new features added and improved. The code base also
+received a lot of love and hardening.
 
 #### Features:
 
 - Minimal supported Python version is now 3.6.
 - Dropped support for deprecated `voodoo.json`.
 - Introduced gitignore-style patterns for `exclude` und `skip-if-exists`.
 - Dropped support for `include` option.
-- Added support for extending content of config files via content of other files via `pyaml-include`.
+- Added support for extending content of config files via content of other files via
+  `pyaml-include`.
 - Customizable template extension.
 - Ability to remember last answers.
 - Ability to choose where to remember them.
-- Template upgrades support, (based on the previous points) with migration tasks specification.
+- Template upgrades support, (based on the previous points) with migration tasks
+  specification.
 - Extended questions format, supporting help, format, choices and secrets.
 - More beautiful prompts.
 - New CLI experience.
@@ -41,21 +43,24 @@ The code base also received a lot of love and hardening.
 - Improve the output when running tasks.
 - Remove the destination folder if the copy process or one of the tasks fail.
 - Add a `cleanup_on_error` flag to optionally disable the cleanup feature.
-- Add the `skip_if_exists` option to skip files, without asking, if they already exists in the destination folder.
+- Add the `skip_if_exists` option to skip files, without asking, if they already exists
+  in the destination folder.
 
 ### Version 2.4.2 (2019-06)
 
 - Fix MAJOR bug that was preventing the `_exclude`, `_include` and `_tasks` keys from
-  `copier.yml` (or alternatives) to be used at all. It also interpreted `_tasks` as
-  a user-provided variable.
+  `copier.yml` (or alternatives) to be used at all. It also interpreted `_tasks` as a
+  user-provided variable.
 
 ### Version 2.4 (2019-06)
 
 - Empty folders are now copied. The folders are also displayed in the console output
   instead of just the files.
-- `prompt_bool` can now have an undefined default (ans answer is mandatory in that case).
+- `prompt_bool` can now have an undefined default (ans answer is mandatory in that
+  case).
 - Reactivates the `copier.yml` and `copier.yaml` as configuration files.
-- The new `extra_paths` argument specifies additional paths to find templates to inherit from.
+- The new `extra_paths` argument specifies additional paths to find templates to inherit
+  from.
 
 ### Version 2.3 (2019-04)
 
@@ -69,17 +74,17 @@ The code base also received a lot of love and hardening.
 ### Version 2.1 (2019-02)
 
 - Task runner 🎉.
-- Use `_exclude`, `_include`, and `_tasks` keys in `copier.yml` as the default
-  values for the `.copy()` arguments `exclude`, `include`, and `tasks`.
+- Use `_exclude`, `_include`, and `_tasks` keys in `copier.yml` as the default values
+  for the `.copy()` arguments `exclude`, `include`, and `tasks`.
 
 ### Version 2.0 (2019-02)
 
 - Rebranded from `Voodoo` to `Copier`!
 - Dropped support for Python 2.x, the minimal version is now Python 3.5.
 - Cleanup and 100% test coverage.
-- The recommended configuration file is now `copier.yaml`, but a `copier.json`
-  can be used as well. The old `voodoo.json` is also supported _for now_ but is
-  deprecated and will be removed in version 2.2.
+- The recommended configuration file is now `copier.yaml`, but a `copier.json` can be
+  used as well. The old `voodoo.json` is also supported _for now_ but is deprecated and
+  will be removed in version 2.2.
 - Python package format updated to the latest standard (no `setup.py` 😵).
 - Renamed the `render_skeleton()` function to `copy()`. The function signature remains
   almost the same, the only changes are:

CONTRIBUTING.md

@@ -1,7 +1,7 @@
 # Contributing
 
-Contributions are welcome, and they are greatly appreciated! Every
-little bit helps, and credit will always be given.
+Contributions are welcome, and they are greatly appreciated! Every little bit helps, and
+credit will always be given.
 
 You can contribute in many ways:
 
@@ -12,25 +12,23 @@ Report bugs at <https://github.com/jpscaletti/copier/issues>.
 If you are reporting a bug, please include:
 
 - Your operating system name and version.
-- Any details about your local setup that might be helpful in
-  troubleshooting.
+- Any details about your local setup that might be helpful in troubleshooting.
 - Detailed steps to reproduce the bug.
 
 ### Fix Bugs
 
-Look through the GitHub issues for bugs. Anything tagged with "bug" is
-open to whoever wants to implement it.
+Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever
+wants to implement it.
 
 ### Implement Features
 
-Look through the GitHub issues for features. Anything tagged with
-"Feature request" is open to whoever wants to implement it.
+Look through the GitHub issues for features. Anything tagged with "Feature request" is
+open to whoever wants to implement it.
 
 ### Write Documentation
 
-The project could always use more documentation, whether as part of the
-official project docs, or even on the web in blog posts, articles, and
-such.
+The project could always use more documentation, whether as part of the official project
+docs, or even on the web in blog posts, articles, and such.
 
 ### Submit Feedback
 
@@ -41,8 +39,8 @@ If you are proposing a feature:
 
 - Explain in detail how it would work.
 - Keep the scope as narrow as possible, to make it easier to implement.
-- Remember that this is a volunteer-driven project, and that
-  contributions are welcome :)
+- Remember that this is a volunteer-driven project, and that contributions are welcome
+  :)
 
 ## Get Started!
 
@@ -96,8 +94,7 @@ git push origin name-of-your-bugfix-or-feature
 Before you submit a pull request, check that it meets these guidelines:
 
 1.  The pull request has code, it should include tests.
-2.  Run `tox` and make sure that the tests pass for all supported Python
-    versions.
+2.  Run `tox` and make sure that the tests pass for all supported Python versions.
 
 ## Tips