-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
49 changed files
with
3,057 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Changes here will be overwritten by Copier | ||
_commit: 1.1.0 | ||
_src_path: gh:mkdocstrings/handler-template | ||
author_email: dev@pawamoy.fr | ||
author_fullname: Timothée Mazzucotelli | ||
author_username: pawamoy | ||
copyright_date: '2023' | ||
copyright_holder: Timothée Mazzucotelli | ||
copyright_holder_email: dev@pawamoy.fr | ||
copyright_license: ISC License | ||
insiders: true | ||
insiders_email: insiders@pawamoy.fr | ||
insiders_repository_name: mkdocstrings-typescript | ||
language: TypeScript | ||
project_description: A Typescript handler for mkdocstrings. | ||
project_name: mkdocstrings-typescript | ||
public_release: false | ||
python_package_distribution_name: mkdocstrings-typescript | ||
python_package_import_name: typescript | ||
repository_name: typescript | ||
repository_namespace: mkdocstrings | ||
repository_provider: github.com | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
PATH_add scripts |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# editors | ||
.idea/ | ||
.vscode/ | ||
|
||
# python | ||
*.egg-info/ | ||
*.py[cod] | ||
.venv/ | ||
.venvs/ | ||
/build/ | ||
/dist/ | ||
|
||
# tools | ||
.coverage* | ||
/.pdm-build/ | ||
/htmlcov/ | ||
/site/ | ||
|
||
# cache | ||
.cache/ | ||
.pytest_cache/ | ||
.mypy_cache/ | ||
.ruff_cache/ | ||
__pycache__/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
FROM gitpod/workspace-full | ||
USER gitpod | ||
ENV PIP_USER=no | ||
RUN pip3 install pipx; \ | ||
pipx install uv; \ | ||
pipx ensurepath |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
vscode: | ||
extensions: | ||
- ms-python.python | ||
|
||
image: | ||
file: .gitpod.dockerfile | ||
|
||
ports: | ||
- port: 8000 | ||
onOpen: notify | ||
|
||
tasks: | ||
- init: make setup |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Changelog | ||
|
||
All notable changes to this project will be documented in this file. | ||
|
||
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) | ||
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). | ||
|
||
<!-- insertion marker --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,133 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
We as members, contributors, and leaders pledge to make participation in our | ||
community a harassment-free experience for everyone, regardless of age, body | ||
size, visible or invisible disability, ethnicity, sex characteristics, gender | ||
identity and expression, level of experience, education, socio-economic status, | ||
nationality, personal appearance, race, caste, color, religion, or sexual | ||
identity and orientation. | ||
|
||
We pledge to act and interact in ways that contribute to an open, welcoming, | ||
diverse, inclusive, and healthy community. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment for our | ||
community include: | ||
|
||
* Demonstrating empathy and kindness toward other people | ||
* Being respectful of differing opinions, viewpoints, and experiences | ||
* Giving and gracefully accepting constructive feedback | ||
* Accepting responsibility and apologizing to those affected by our mistakes, | ||
and learning from the experience | ||
* Focusing on what is best not just for us as individuals, but for the overall | ||
community | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
* The use of sexualized language or imagery, and sexual attention or advances of | ||
any kind | ||
* Trolling, insulting or derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or email address, | ||
without their explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Enforcement Responsibilities | ||
|
||
Community leaders are responsible for clarifying and enforcing our standards of | ||
acceptable behavior and will take appropriate and fair corrective action in | ||
response to any behavior that they deem inappropriate, threatening, offensive, | ||
or harmful. | ||
|
||
Community leaders have the right and responsibility to remove, edit, or reject | ||
comments, commits, code, wiki edits, issues, and other contributions that are | ||
not aligned to this Code of Conduct, and will communicate reasons for moderation | ||
decisions when appropriate. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all community spaces, and also applies when | ||
an individual is officially representing the community in public spaces. | ||
Examples of representing our community include using an official e-mail address, | ||
posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported to the community leaders responsible for enforcement at | ||
dev@pawamoy.fr. | ||
All complaints will be reviewed and investigated promptly and fairly. | ||
|
||
All community leaders are obligated to respect the privacy and security of the | ||
reporter of any incident. | ||
|
||
## Enforcement Guidelines | ||
|
||
Community leaders will follow these Community Impact Guidelines in determining | ||
the consequences for any action they deem in violation of this Code of Conduct: | ||
|
||
### 1. Correction | ||
|
||
**Community Impact**: Use of inappropriate language or other behavior deemed | ||
unprofessional or unwelcome in the community. | ||
|
||
**Consequence**: A private, written warning from community leaders, providing | ||
clarity around the nature of the violation and an explanation of why the | ||
behavior was inappropriate. A public apology may be requested. | ||
|
||
### 2. Warning | ||
|
||
**Community Impact**: A violation through a single incident or series of | ||
actions. | ||
|
||
**Consequence**: A warning with consequences for continued behavior. No | ||
interaction with the people involved, including unsolicited interaction with | ||
those enforcing the Code of Conduct, for a specified period of time. This | ||
includes avoiding interactions in community spaces as well as external channels | ||
like social media. Violating these terms may lead to a temporary or permanent | ||
ban. | ||
|
||
### 3. Temporary Ban | ||
|
||
**Community Impact**: A serious violation of community standards, including | ||
sustained inappropriate behavior. | ||
|
||
**Consequence**: A temporary ban from any sort of interaction or public | ||
communication with the community for a specified period of time. No public or | ||
private interaction with the people involved, including unsolicited interaction | ||
with those enforcing the Code of Conduct, is allowed during this period. | ||
Violating these terms may lead to a permanent ban. | ||
|
||
### 4. Permanent Ban | ||
|
||
**Community Impact**: Demonstrating a pattern of violation of community | ||
standards, including sustained inappropriate behavior, harassment of an | ||
individual, or aggression toward or disparagement of classes of individuals. | ||
|
||
**Consequence**: A permanent ban from any sort of public interaction within the | ||
community. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
version 2.1, available at | ||
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. | ||
|
||
Community Impact Guidelines were inspired by | ||
[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. | ||
|
||
For answers to common questions about this code of conduct, see the FAQ at | ||
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at | ||
[https://www.contributor-covenant.org/translations][translations]. | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html | ||
[Mozilla CoC]: https://github.com/mozilla/diversity | ||
[FAQ]: https://www.contributor-covenant.org/faq | ||
[translations]: https://www.contributor-covenant.org/translations | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,151 @@ | ||
# Contributing | ||
|
||
Contributions are welcome, and they are greatly appreciated! | ||
Every little bit helps, and credit will always be given. | ||
|
||
## Environment setup | ||
|
||
Nothing easier! | ||
|
||
Fork and clone the repository, then: | ||
|
||
```bash | ||
cd typescript | ||
make setup | ||
``` | ||
|
||
> NOTE: | ||
> If it fails for some reason, | ||
> you'll need to install | ||
> [uv](https://github.com/astral-sh/uv) | ||
> manually. | ||
> | ||
> You can install it with: | ||
> | ||
> ```bash | ||
> python3 -m pip install --user pipx | ||
> pipx install uv | ||
> ``` | ||
> | ||
> Now you can try running `make setup` again, | ||
> or simply `uv install`. | ||
You now have the dependencies installed. | ||
Run `make help` to see all the available actions! | ||
## Tasks | ||
This project uses [duty](https://github.com/pawamoy/duty) to run tasks. | ||
A Makefile is also provided. The Makefile will try to run certain tasks | ||
on multiple Python versions. If for some reason you don't want to run the task | ||
on multiple Python versions, you run the task directly with `make run duty TASK`. | ||
The Makefile detects if a virtual environment is activated, | ||
so `make` will work the same with the virtualenv activated or not. | ||
If you work in VSCode, we provide | ||
[an action to configure VSCode](https://pawamoy.github.io/copier-uv/work/#vscode-setup) | ||
for the project. | ||
## Development | ||
As usual: | ||
1. create a new branch: `git switch -c feature-or-bugfix-name` | ||
1. edit the code and/or the documentation | ||
**Before committing:** | ||
1. run `make format` to auto-format the code | ||
1. run `make check` to check everything (fix any warning) | ||
1. run `make test` to run the tests (fix any issue) | ||
1. if you updated the documentation or the project dependencies: | ||
1. run `make docs` | ||
1. go to http://localhost:8000 and check that everything looks good | ||
1. follow our [commit message convention](#commit-message-convention) | ||
If you are unsure about how to fix or ignore a warning, | ||
just let the continuous integration fail, | ||
and we will help you during review. | ||
Don't bother updating the changelog, we will take care of this. | ||
## Commit message convention | ||
Commit messages must follow our convention based on the | ||
[Angular style](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message) | ||
or the [Karma convention](https://karma-runner.github.io/4.0/dev/git-commit-msg.html): | ||
``` | ||
<type>[(scope)]: Subject | ||
[Body] | ||
``` | ||
**Subject and body must be valid Markdown.** | ||
Subject must have proper casing (uppercase for first letter | ||
if it makes sense), but no dot at the end, and no punctuation | ||
in general. | ||
|
||
Scope and body are optional. Type can be: | ||
|
||
- `build`: About packaging, building wheels, etc. | ||
- `chore`: About packaging or repo/files management. | ||
- `ci`: About Continuous Integration. | ||
- `deps`: Dependencies update. | ||
- `docs`: About documentation. | ||
- `feat`: New feature. | ||
- `fix`: Bug fix. | ||
- `perf`: About performance. | ||
- `refactor`: Changes that are not features or bug fixes. | ||
- `style`: A change in code style/format. | ||
- `tests`: About tests. | ||
|
||
If you write a body, please add trailers at the end | ||
(for example issues and PR references, or co-authors), | ||
without relying on GitHub's flavored Markdown: | ||
|
||
``` | ||
Body. | ||
Issue #10: https://github.com/namespace/project/issues/10 | ||
Related to PR namespace/other-project#15: https://github.com/namespace/other-project/pull/15 | ||
``` | ||
|
||
These "trailers" must appear at the end of the body, | ||
without any blank lines between them. The trailer title | ||
can contain any character except colons `:`. | ||
We expect a full URI for each trailer, not just GitHub autolinks | ||
(for example, full GitHub URLs for commits and issues, | ||
not the hash or the #issue-number). | ||
|
||
We do not enforce a line length on commit messages summary and body, | ||
but please avoid very long summaries, and very long lines in the body, | ||
unless they are part of code blocks that must not be wrapped. | ||
|
||
## Pull requests guidelines | ||
|
||
Link to any related issue in the Pull Request message. | ||
|
||
During the review, we recommend using fixups: | ||
|
||
```bash | ||
# SHA is the SHA of the commit you want to fix | ||
git commit --fixup=SHA | ||
``` | ||
|
||
Once all the changes are approved, you can squash your commits: | ||
|
||
```bash | ||
git rebase -i --autosquash main | ||
``` | ||
|
||
And force-push: | ||
|
||
```bash | ||
git push -f | ||
``` | ||
|
||
If this seems all too complicated, you can push or force-push each new commit, | ||
and we will squash them ourselves if needed, before merging. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
ISC License | ||
|
||
Copyright (c) 2023, Timothée Mazzucotelli | ||
|
||
Permission to use, copy, modify, and/or distribute this software for any | ||
purpose with or without fee is hereby granted, provided that the above | ||
copyright notice and this permission notice appear in all copies. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
Oops, something went wrong.