Update templates for new projects

Author: ofek

docs/config/project-templates.md

@@ -32,7 +32,7 @@ The list of licenses should be composed of [SPDX identifiers](https://spdx.org/l
 
 ### Tests
 
-This adds a `tests` directory with [pytest](https://github.com/pytest-dev/pytest) functionality.
+This adds a `tests` directory with environments for testing and linting.
 
 === ":octicons-file-code-16: config.toml"
 

docs/environment.md

@@ -59,16 +59,16 @@ hatch run python -c "import sys;print(sys.executable)"
 
 You can also run any [scripts](config/environment/overview.md#scripts) that have been defined.
 
-You'll notice that in the `pyproject.toml` file there are already scripts defined in the `default` environment. Try running the `cov` command, which invokes [pytest](https://github.com/pytest-dev/pytest) with some flags for tracking [coverage](https://github.com/nedbat/coveragepy):
+You'll notice that in the `pyproject.toml` file there are already scripts defined in the `default` environment. Try running the `test` command, which invokes [pytest](https://github.com/pytest-dev/pytest) with some default arguments:
 
 ```
-hatch run cov
+hatch run test
 ```
 
-All additional arguments are passed through to scripts, so for example if you wanted to see the version of `pytest` and which plugins are installed you could do:
+All additional arguments are passed through to that script, so for example if you wanted to see the version of `pytest` and which plugins are installed you could do:
 
 ```
-hatch run cov -VV
+hatch run test -VV
 ```
 
 ## Dependencies

docs/intro.md

@@ -18,9 +18,10 @@ This would create the following structure in your current working directory:
 
 ```
 hatch-demo
-├── hatch_demo
-│   ├── __about__.py
-│   └── __init__.py
+├── src
+│   └── hatch_demo
+│       ├── __about__.py
+│       └── __init__.py
 ├── tests
 │   └── __init__.py
 ├── LICENSE.txt

docs/version.md

@@ -12,14 +12,14 @@ The `regex` source requires an option `path` that represents a relative path to
 
     ```toml
     [tool.hatch.version]
-    path = "hatch_demo/__about__.py"
+    path = "src/hatch_demo/__about__.py"
     ```
 
 === ":octicons-file-code-16: hatch.toml"
 
     ```toml
     [version]
-    path = "hatch_demo/__about__.py"
+    path = "src/hatch_demo/__about__.py"
     ```
 
 The default pattern looks for a variable named `__version__` or `VERSION` that is set to a string containing the version, optionally prefixed with the lowercase letter `v`.

pyproject.toml

@@ -77,7 +77,6 @@ exclude = [
 ]
 
 [tool.black]
-include = '\.pyi?$'
 line-length = 120
 skip-string-normalization = true
 target-version = ["py37"]
@@ -104,12 +103,17 @@ select = [
   "YTT",
 ]
 ignore = [
+  # Allow non-abstract empty methods in abstract base classes
   "B027",
-  "FBT003",
+  # Ignore McCabe complexity
   "C901",
-  "S105",
+  # Allow boolean positional values in function calls, like `dict.get(... True)`
+  "FBT003",
+  # Ignore checks for possible passwords
+  "S105", "S106", "S107",
 ]
 unfixable = [
+  # Don't touch unused imports
   "F401",
 ]
 

src/hatch/template/files_default.py

@@ -68,6 +68,7 @@ class PyProject(File):
 
 [project]
 name = "{project_name_normalized}"
+dynamic = ["version"]
 description = {description!r}
 readme = "{readme_file_path}"
 requires-python = ">=3.7"
@@ -88,7 +89,6 @@ class PyProject(File):
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
 dependencies = {dependency_data}
-dynamic = ["version"]
 
 [project.urls]{project_url_data}{cli_scripts}
 
@@ -137,28 +137,62 @@ def __init__(self, template_config: dict, plugin_config: dict):
 [tool.hatch.envs.default]
 dependencies = [
   "pytest",
-  "pytest-cov",
 ]
 [tool.hatch.envs.default.scripts]
-cov = "pytest --cov-report=term-missing --cov-config=pyproject.toml --cov={package_location}{template_config['package_name']} --cov=tests {{args}}"
-no-cov = "cov --no-cov {{args}}"
+test = "pytest {{args:tests}}"
 
-[[tool.hatch.envs.test.matrix]]
+[[tool.hatch.envs.all.matrix]]
 python = ["3.7", "3.8", "3.9", "3.10", "3.11"]
 
-[tool.coverage.run]
-branch = true
-parallel = true
-omit = [
-  "{package_location}{template_config['package_name']}/__about__.py",
+[envs.lint]
+detached = true
+dependencies = [
+  "black",
+  "mypy",
+  "ruff",
+]
+[envs.lint.scripts]
+typing = "mypy --install-types --non-interactive {{args:{package_location}{template_config['package_name']} tests}}"
+style = [
+  "ruff {{args:.}}",
+  "black --check --diff {{args:.}}",
+]
+fmt = [
+  "black {{args:.}}",
+  "ruff --fix {{args:.}}",
+  "style",
+]
+all = [
+  "style",
+  "typing",
+]
+
+[tool.black]
+target-version = ["py37"]
+line-length = 120
+skip-string-normalization = true
+
+[tool.ruff]
+target-version = "py37"
+line-length = 120
+select = ["A", "B", "C", "E", "F", "FBT", "I", "M", "N", "Q", "RUF", "S", "T", "U", "W", "YTT"]
+ignore = [
+  # Allow non-abstract empty methods in abstract base classes
+  "B027",
+  # Ignore McCabe complexity
+  "C901",
+  # Allow boolean positional values in function calls, like `dict.get(... True)`
+  "FBT003",
+  # Ignore checks for possible passwords
+  "S105", "S106", "S107",
+]
+unfixable = [
+  # Don't touch unused imports
+  "F401",
 ]
 
-[tool.coverage.report]
-exclude_lines = [
-  "no cov",
-  "if __name__ == .__main__.:",
-  "if TYPE_CHECKING:",
-]"""  # noqa: E501
+[tool.ruff.isort]
+known-first-party = ["{template_config['package_name']}"]"""
 
         super().__init__(
             Path('pyproject.toml'),

tests/helpers/templates/new/basic.py

@@ -64,6 +64,7 @@ def get_files(**kwargs):
 
 [project]
 name = "{kwargs['project_name_normalized']}"
+dynamic = ["version"]
 description = ''
 readme = "README.md"
 requires-python = ">=3.7"
@@ -84,7 +85,6 @@ def get_files(**kwargs):
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
 dependencies = []
-dynamic = ["version"]
 
 [project.urls]
 Documentation = "https://github.com/unknown/{kwargs['project_name_normalized']}#readme"

tests/helpers/templates/new/default.py

@@ -74,6 +74,7 @@ def get_files(**kwargs):
 
 [project]
 name = "{kwargs['project_name_normalized']}"
+dynamic = ["version"]
 description = '{description}'
 readme = "README.md"
 requires-python = ">=3.7"
@@ -94,7 +95,6 @@ def get_files(**kwargs):
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
 dependencies = []
-dynamic = ["version"]
 
 [project.urls]
 Documentation = "https://github.com/unknown/{kwargs['project_name_normalized']}#readme"
@@ -107,28 +107,62 @@ def get_files(**kwargs):
 [tool.hatch.envs.default]
 dependencies = [
   "pytest",
-  "pytest-cov",
 ]
 [tool.hatch.envs.default.scripts]
-cov = "pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=src/{kwargs['package_name']} --cov=tests {{args}}"
-no-cov = "cov --no-cov {{args}}"
+test = "pytest {{args:tests}}"
 
-[[tool.hatch.envs.test.matrix]]
+[[tool.hatch.envs.all.matrix]]
 python = ["3.7", "3.8", "3.9", "3.10", "3.11"]
 
-[tool.coverage.run]
-branch = true
-parallel = true
-omit = [
-  "src/{kwargs['package_name']}/__about__.py",
+[envs.lint]
+detached = true
+dependencies = [
+  "black",
+  "mypy",
+  "ruff",
+]
+[envs.lint.scripts]
+typing = "mypy --install-types --non-interactive {{args:src/{kwargs['package_name']} tests}}"
+style = [
+  "ruff {{args:.}}",
+  "black --check --diff {{args:.}}",
+]
+fmt = [
+  "black {{args:.}}",
+  "ruff --fix {{args:.}}",
+  "style",
+]
+all = [
+  "style",
+  "typing",
 ]
 
-[tool.coverage.report]
-exclude_lines = [
-  "no cov",
-  "if __name__ == .__main__.:",
-  "if TYPE_CHECKING:",
+[tool.black]
+target-version = ["py37"]
+line-length = 120
+skip-string-normalization = true
+
+[tool.ruff]
+target-version = "py37"
+line-length = 120
+select = ["A", "B", "C", "E", "F", "FBT", "I", "M", "N", "Q", "RUF", "S", "T", "U", "W", "YTT"]
+ignore = [
+  # Allow non-abstract empty methods in abstract base classes
+  "B027",
+  # Ignore McCabe complexity
+  "C901",
+  # Allow boolean positional values in function calls, like `dict.get(... True)`
+  "FBT003",
+  # Ignore checks for possible passwords
+  "S105", "S106", "S107",
 ]
-""",  # noqa: E501
+unfixable = [
+  # Don't touch unused imports
+  "F401",
+]
+
+[tool.ruff.isort]
+known-first-party = ["{kwargs['package_name']}"]
+""",
         ),
     ]

tests/helpers/templates/new/feature_cli.py

@@ -104,6 +104,7 @@ def {kwargs['package_name']}(ctx: click.Context):
 
 [project]
 name = "{kwargs['project_name_normalized']}"
+dynamic = ["version"]
 description = ''
 readme = "README.md"
 requires-python = ">=3.7"
@@ -126,7 +127,6 @@ def {kwargs['package_name']}(ctx: click.Context):
 dependencies = [
   "click",
 ]
-dynamic = ["version"]
 
 [project.urls]
 Documentation = "https://github.com/unknown/{kwargs['project_name_normalized']}#readme"
@@ -142,28 +142,62 @@ def {kwargs['package_name']}(ctx: click.Context):
 [tool.hatch.envs.default]
 dependencies = [
   "pytest",
-  "pytest-cov",
 ]
 [tool.hatch.envs.default.scripts]
-cov = "pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=src/{kwargs['package_name']} --cov=tests {{args}}"
-no-cov = "cov --no-cov {{args}}"
+test = "pytest {{args:tests}}"
 
-[[tool.hatch.envs.test.matrix]]
+[[tool.hatch.envs.all.matrix]]
 python = ["3.7", "3.8", "3.9", "3.10", "3.11"]
 
-[tool.coverage.run]
-branch = true
-parallel = true
-omit = [
-  "src/{kwargs['package_name']}/__about__.py",
+[envs.lint]
+detached = true
+dependencies = [
+  "black",
+  "mypy",
+  "ruff",
+]
+[envs.lint.scripts]
+typing = "mypy --install-types --non-interactive {{args:src/{kwargs['package_name']} tests}}"
+style = [
+  "ruff {{args:.}}",
+  "black --check --diff {{args:.}}",
+]
+fmt = [
+  "black {{args:.}}",
+  "ruff --fix {{args:.}}",
+  "style",
+]
+all = [
+  "style",
+  "typing",
 ]
 
-[tool.coverage.report]
-exclude_lines = [
-  "no cov",
-  "if __name__ == .__main__.:",
-  "if TYPE_CHECKING:",
+[tool.black]
+target-version = ["py37"]
+line-length = 120
+skip-string-normalization = true
+
+[tool.ruff]
+target-version = "py37"
+line-length = 120
+select = ["A", "B", "C", "E", "F", "FBT", "I", "M", "N", "Q", "RUF", "S", "T", "U", "W", "YTT"]
+ignore = [
+  # Allow non-abstract empty methods in abstract base classes
+  "B027",
+  # Ignore McCabe complexity
+  "C901",
+  # Allow boolean positional values in function calls, like `dict.get(... True)`
+  "FBT003",
+  # Ignore checks for possible passwords
+  "S105", "S106", "S107",
 ]
-""",  # noqa: E501
+unfixable = [
+  # Don't touch unused imports
+  "F401",
+]
+
+[tool.ruff.isort]
+known-first-party = ["{kwargs['package_name']}"]
+""",
         ),
     ]