Skip to content

Commit 8df7221

Browse files
pawamoypawamoy
committed
chore: Template upgrade
1 parent 1608b7c commit 8df7221

25 files changed

Lines changed: 558 additions & 189 deletions

‎.copier-answers.yml‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
# Changes here will be overwritten by Copier
2-
_commit: 0.2.1
2+
_commit: 0.2.2
33
_src_path: gh:mkdocstrings/handler-template
4-
author_email: pawamoy@pm.me
4+
author_email: dev@pawamoy.fr
55
author_fullname: Timothée Mazzucotelli
66
author_username: pawamoy
77
copyright_date: '2023'
88
copyright_holder: Timothée Mazzucotelli
9-
copyright_holder_email: pawamoy@pm.me
9+
copyright_holder_email: dev@pawamoy.fr
1010
copyright_license: ISC License
1111
insiders: true
12+
insiders_repository_name: mkdocstrings-typescript
1213
language: TypeScript
1314
project_description: A Typescript handler for mkdocstrings.
1415
project_name: mkdocstrings-typescript
16+
public_release: false
1517
python_package_distribution_name: mkdocstrings-typescript
1618
python_package_import_name: typescript
1719
repository_name: typescript

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 51 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,61 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
4-
title: ''
3+
about: Create a bug report to help us improve.
4+
title: "bug: "
55
labels: unconfirmed
6-
assignees: ''
7-
6+
assignees: [pawamoy]
87
---
98

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
9+
### Description of the bug
10+
<!-- Please provide a clear and concise description of what the bug is. -->
11+
12+
### To Reproduce
13+
<!-- Please provide a Minimal Reproducible Example (MRE) if possible.
14+
Try to boil down the problem to a few lines of code.
15+
Your code should run by simply copying and pasting it.
16+
17+
Example:
18+
19+
```
20+
git clone https://github.com/username/repro
21+
cd repro
22+
python -m venv .venv
23+
. .venv/bin/activate
24+
pip install -r requirements.txt
25+
... # command or code showing the issue
26+
```
27+
-->
28+
29+
```
30+
WRITE MRE / INSTRUCTIONS HERE
31+
```
32+
33+
### Full traceback
34+
<!-- Please provide the full error message / traceback if any, by pasting it in the code block below.
35+
No screenshots! -->
36+
37+
<details><summary>Full traceback</summary>
38+
39+
```python
40+
PASTE TRACEBACK HERE
41+
```
42+
43+
</details>
1244

13-
**To Reproduce**
14-
Steps to reproduce the behavior:
15-
1. Go to '...'
16-
2. Run command '...'
17-
3. Scroll down to '...'
18-
4. See error
45+
### Expected behavior
46+
<!-- Please provide a clear and concise description of what you expected to happen. -->
1947

20-
**Expected behavior**
21-
A clear and concise description of what you expected to happen.
48+
### Environment information
49+
<!-- Please run the following command in your repository and paste its output below it,
50+
redacting sensitive information. -->
2251

23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
52+
```bash
53+
python -m mkdocstrings_handlers.typescript.debug # | xclip -selection clipboard
54+
```
2555

26-
**System (please complete the following information):**
27-
- `mkdocstrings-typescript` version: [e.g. 0.2.1]
28-
- Python version: [e.g. 3.8]
29-
- OS: [Windows/Linux]
56+
PASTE OUTPUT HERE
3057

31-
**Additional context**
32-
Add any other context about the problem here.
58+
### Additional context
59+
<!-- Add any other relevant context about the problem here,
60+
like links to other issues or pull requests, screenshots, etc.
61+
-->

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: I have a question / I need help
4+
url: https://github.com/mkdocstrings/typescript/discussions/new?category=q-a
5+
about: Ask and answer questions in the Discussions tab.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
---
22
name: Feature request
3-
about: Suggest an idea for this project
4-
title: ''
3+
about: Suggest an idea for this project.
4+
title: "feature: "
55
labels: feature
6-
assignees: ''
7-
6+
assignees: pawamoy
87
---
98

10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
### Is your feature request related to a problem? Please describe.
10+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]. -->
1211

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
12+
### Describe the solution you'd like
13+
<!-- A clear and concise description of what you want to happen. -->
1514

16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
15+
### Describe alternatives you've considered
16+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
1817

19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
18+
### Additional context
19+
<!-- Add any other context or screenshots about the feature request here. -->

‎CODE_OF_CONDUCT.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ representative at an online or offline event.
6060

6161
Instances of abusive, harassing, or otherwise unacceptable behavior may be
6262
reported to the community leaders responsible for enforcement at
63-
pawamoy@pm.me.
63+
dev@pawamoy.fr.
6464
All complaints will be reviewed and investigated promptly and fairly.
6565

6666
All community leaders are obligated to respect the privacy and security of the

‎CONTRIBUTING.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,9 @@ on multiple Python versions, you run the task directly with `pdm run duty TASK`.
4444
The Makefile detects if a virtual environment is activated,
4545
so `make` will work the same with the virtualenv activated or not.
4646
47-
If you work in VSCode,
48-
[see examples of tasks and run configurations](https://pawamoy.github.io/copier-pdm/work/#vscode-setup).
47+
If you work in VSCode, we provide
48+
[an action to configure VSCode](https://pawamoy.github.io/copier-pdm/work/#vscode-setup)
49+
for the project.
4950
5051
## Development
5152

‎Makefile‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ BASIC_DUTIES = \
1818
docs \
1919
docs-deploy \
2020
format \
21-
release
21+
release \
22+
vscode
2223

2324
QUALITY_DUTIES = \
2425
check-quality \

‎README.md‎

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,13 @@
11
# mkdocstrings-typescript
22

3-
[![ci](https://github.com/mkdocstrings/typescript/workflows/ci/badge.svg)](https://github.com/mkdocstrings/typescript/actions?query=workflow%3Aci)
43
[![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://mkdocstrings.github.io/typescript/)
5-
[![pypi version](https://img.shields.io/pypi/v/mkdocstrings-typescript.svg)](https://pypi.org/project/mkdocstrings-typescript/)
64
[![gitpod](https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/typescript)
7-
[![gitter](https://badges.gitter.im/join%20chat.svg)](https://gitter.im/mkdocstrings/typescript)
5+
[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#typescript:gitter.im)
86

97
A Typescript handler for mkdocstrings. :warning: **Work in progress** :warning:
108

119
## Installation
1210

13-
With `pip`:
14-
```bash
15-
pip install mkdocstrings-typescript
16-
```
17-
18-
With [`pipx`](https://github.com/pipxproject/pipx):
19-
```bash
20-
python3.8 -m pip install --user pipx
21-
pipx install mkdocstrings-typescript
22-
```
11+
This project is available to sponsors only, through my Insiders program.
12+
See Insiders [explanation](https://mkdocstrings.github.io/typescript/insiders/)
13+
and [installation instructions](https://mkdocstrings.github.io/typescript/insiders/installation/).

‎config/git-changelog.toml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
bump = "auto"
2+
convention = "angular"
3+
in-place = true
4+
output = "CHANGELOG.md"
5+
parse-refs = false
6+
parse-trailers = true
7+
sections = ["build", "deps", "feat", "fix", "refactor"]
8+
template = "keepachangelog"

‎config/ruff.toml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,9 @@ ignore = [
7777
"src/*/cli.py" = [
7878
"T201", # Print statement
7979
]
80+
"src/*/debug.py" = [
81+
"T201", # Print statement
82+
]
8083
"scripts/*.py" = [
8184
"INP001", # File is part of an implicit namespace package
8285
"T201", # Print statement
@@ -95,7 +98,7 @@ docstring-quotes = "double"
9598
ban-relative-imports = "all"
9699

97100
[isort]
98-
known-first-party = ["typescript"]
101+
known-first-party = ["mkdocstrings_handlers.typescript"]
99102

100103
[pydocstyle]
101104
convention = "google"

0 commit comments

Comments
 (0)