Skip to content

Commit 04dfa30

Browse files
pawamoypawamoy
committed
build: Release no-op version
1 parent 00cd6f1 commit 04dfa30

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+3057
-4
lines changed

‎.copier-answers.yml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Changes here will be overwritten by Copier
2+
_commit: 1.1.0
3+
_src_path: gh:mkdocstrings/handler-template
4+
author_email: [email protected]
5+
author_fullname: Timothée Mazzucotelli
6+
author_username: pawamoy
7+
copyright_date: '2023'
8+
copyright_holder: Timothée Mazzucotelli
9+
copyright_holder_email: [email protected]
10+
copyright_license: ISC License
11+
insiders: true
12+
insiders_email: [email protected]
13+
insiders_repository_name: mkdocstrings-typescript
14+
language: TypeScript
15+
project_description: A Typescript handler for mkdocstrings.
16+
project_name: mkdocstrings-typescript
17+
public_release: false
18+
python_package_distribution_name: mkdocstrings-typescript
19+
python_package_import_name: typescript
20+
repository_name: typescript
21+
repository_namespace: mkdocstrings
22+
repository_provider: github.com
23+

‎.envrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
PATH_add scripts

‎.gitignore

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# editors
2+
.idea/
3+
.vscode/
4+
5+
# python
6+
*.egg-info/
7+
*.py[cod]
8+
.venv/
9+
.venvs/
10+
/build/
11+
/dist/
12+
13+
# tools
14+
.coverage*
15+
/.pdm-build/
16+
/htmlcov/
17+
/site/
18+
19+
# cache
20+
.cache/
21+
.pytest_cache/
22+
.mypy_cache/
23+
.ruff_cache/
24+
__pycache__/

‎.gitpod.dockerfile

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
FROM gitpod/workspace-full
2+
USER gitpod
3+
ENV PIP_USER=no
4+
RUN pip3 install pipx; \
5+
pipx install uv; \
6+
pipx ensurepath

‎.gitpod.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
vscode:
2+
extensions:
3+
- ms-python.python
4+
5+
image:
6+
file: .gitpod.dockerfile
7+
8+
ports:
9+
- port: 8000
10+
onOpen: notify
11+
12+
tasks:
13+
- init: make setup

‎CHANGELOG.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
7+
8+
<!-- insertion marker -->

‎CODE_OF_CONDUCT.md

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations
133+

‎CONTRIBUTING.md

+151
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
# Contributing
2+
3+
Contributions are welcome, and they are greatly appreciated!
4+
Every little bit helps, and credit will always be given.
5+
6+
## Environment setup
7+
8+
Nothing easier!
9+
10+
Fork and clone the repository, then:
11+
12+
```bash
13+
cd typescript
14+
make setup
15+
```
16+
17+
> NOTE:
18+
> If it fails for some reason,
19+
> you'll need to install
20+
> [uv](https://github.com/astral-sh/uv)
21+
> manually.
22+
>
23+
> You can install it with:
24+
>
25+
> ```bash
26+
> python3 -m pip install --user pipx
27+
> pipx install uv
28+
> ```
29+
>
30+
> Now you can try running `make setup` again,
31+
> or simply `uv install`.
32+
33+
You now have the dependencies installed.
34+
35+
Run `make help` to see all the available actions!
36+
37+
## Tasks
38+
39+
This project uses [duty](https://github.com/pawamoy/duty) to run tasks.
40+
A Makefile is also provided. The Makefile will try to run certain tasks
41+
on multiple Python versions. If for some reason you don't want to run the task
42+
on multiple Python versions, you run the task directly with `make run duty TASK`.
43+
44+
The Makefile detects if a virtual environment is activated,
45+
so `make` will work the same with the virtualenv activated or not.
46+
47+
If you work in VSCode, we provide
48+
[an action to configure VSCode](https://pawamoy.github.io/copier-uv/work/#vscode-setup)
49+
for the project.
50+
51+
## Development
52+
53+
As usual:
54+
55+
1. create a new branch: `git switch -c feature-or-bugfix-name`
56+
1. edit the code and/or the documentation
57+
58+
**Before committing:**
59+
60+
1. run `make format` to auto-format the code
61+
1. run `make check` to check everything (fix any warning)
62+
1. run `make test` to run the tests (fix any issue)
63+
1. if you updated the documentation or the project dependencies:
64+
1. run `make docs`
65+
1. go to http://localhost:8000 and check that everything looks good
66+
1. follow our [commit message convention](#commit-message-convention)
67+
68+
If you are unsure about how to fix or ignore a warning,
69+
just let the continuous integration fail,
70+
and we will help you during review.
71+
72+
Don't bother updating the changelog, we will take care of this.
73+
74+
## Commit message convention
75+
76+
Commit messages must follow our convention based on the
77+
[Angular style](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message)
78+
or the [Karma convention](https://karma-runner.github.io/4.0/dev/git-commit-msg.html):
79+
80+
```
81+
<type>[(scope)]: Subject
82+
83+
[Body]
84+
```
85+
86+
**Subject and body must be valid Markdown.**
87+
Subject must have proper casing (uppercase for first letter
88+
if it makes sense), but no dot at the end, and no punctuation
89+
in general.
90+
91+
Scope and body are optional. Type can be:
92+
93+
- `build`: About packaging, building wheels, etc.
94+
- `chore`: About packaging or repo/files management.
95+
- `ci`: About Continuous Integration.
96+
- `deps`: Dependencies update.
97+
- `docs`: About documentation.
98+
- `feat`: New feature.
99+
- `fix`: Bug fix.
100+
- `perf`: About performance.
101+
- `refactor`: Changes that are not features or bug fixes.
102+
- `style`: A change in code style/format.
103+
- `tests`: About tests.
104+
105+
If you write a body, please add trailers at the end
106+
(for example issues and PR references, or co-authors),
107+
without relying on GitHub's flavored Markdown:
108+
109+
```
110+
Body.
111+
112+
Issue #10: https://github.com/namespace/project/issues/10
113+
Related to PR namespace/other-project#15: https://github.com/namespace/other-project/pull/15
114+
```
115+
116+
These "trailers" must appear at the end of the body,
117+
without any blank lines between them. The trailer title
118+
can contain any character except colons `:`.
119+
We expect a full URI for each trailer, not just GitHub autolinks
120+
(for example, full GitHub URLs for commits and issues,
121+
not the hash or the #issue-number).
122+
123+
We do not enforce a line length on commit messages summary and body,
124+
but please avoid very long summaries, and very long lines in the body,
125+
unless they are part of code blocks that must not be wrapped.
126+
127+
## Pull requests guidelines
128+
129+
Link to any related issue in the Pull Request message.
130+
131+
During the review, we recommend using fixups:
132+
133+
```bash
134+
# SHA is the SHA of the commit you want to fix
135+
git commit --fixup=SHA
136+
```
137+
138+
Once all the changes are approved, you can squash your commits:
139+
140+
```bash
141+
git rebase -i --autosquash main
142+
```
143+
144+
And force-push:
145+
146+
```bash
147+
git push -f
148+
```
149+
150+
If this seems all too complicated, you can push or force-push each new commit,
151+
and we will squash them ourselves if needed, before merging.

‎LICENSE

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
ISC License
2+
3+
Copyright (c) 2023, Timothée Mazzucotelli
4+
5+
Permission to use, copy, modify, and/or distribute this software for any
6+
purpose with or without fee is hereby granted, provided that the above
7+
copyright notice and this permission notice appear in all copies.
8+
9+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10+
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11+
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12+
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13+
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14+
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15+
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

0 commit comments

Comments
 (0)