Skip to content

Commit ea4dd3e

Browse files
JoshuaKGoldbergJoshuaKGoldberg
committed
feat: initialized repo ✨
0 parents  commit ea4dd3e

Some content is hidden

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

58 files changed

+8821
-0
lines changed

‎.all-contributorsrc

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"badgeTemplate": "\t<a href=\"#contributors\" target=\"_blank\"><img alt=\"All Contributors: <%= contributors.length %> 👪\" src=\"https://img.shields.io/badge/all_contributors-<%= contributors.length %>_👪-21bb42.svg\" /></a>",
3+
"commit": false,
4+
"commitConvention": "angular",
5+
"contributors": [
6+
{
7+
"login": "JoshuaKGoldberg",
8+
"name": "Josh Goldberg ✨",
9+
"avatar_url": "https://avatars.githubusercontent.com/u/3335181?v=4",
10+
"profile": "http://www.joshuakgoldberg.com/",
11+
"contributions": [
12+
"code",
13+
"content",
14+
"doc",
15+
"ideas",
16+
"infra",
17+
"maintenance",
18+
"projectManagement",
19+
"tool"
20+
]
21+
}
22+
],
23+
"contributorsPerLine": 7,
24+
"contributorsSortAlphabetically": true,
25+
"files": [
26+
"README.md"
27+
],
28+
"imageSize": 100,
29+
"projectName": "github-username-to-emails",
30+
"projectOwner": "JoshuaKGoldberg",
31+
"repoHost": "https://github.com",
32+
"repoType": "github"
33+
}

‎.eslintignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
!.*
2+
coverage
3+
lib
4+
node_modules
5+
pnpm-lock.yaml

‎.eslintrc.cjs

+156
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
/** @type {import("@types/eslint").Linter.Config} */
2+
module.exports = {
3+
env: {
4+
es2022: true,
5+
node: true,
6+
},
7+
extends: [
8+
"eslint:recommended",
9+
"plugin:eslint-comments/recommended",
10+
"plugin:n/recommended",
11+
"plugin:perfectionist/recommended-natural",
12+
"plugin:regexp/recommended",
13+
"plugin:vitest/recommended",
14+
],
15+
overrides: [
16+
{
17+
extends: ["plugin:markdown/recommended"],
18+
files: ["**/*.md"],
19+
processor: "markdown/markdown",
20+
},
21+
{
22+
extends: [
23+
"plugin:jsdoc/recommended-typescript-error",
24+
"plugin:@typescript-eslint/strict",
25+
"plugin:@typescript-eslint/stylistic",
26+
],
27+
files: ["**/*.ts"],
28+
parser: "@typescript-eslint/parser",
29+
rules: {
30+
// These off-by-default rules work well for this repo and we like them on.
31+
"jsdoc/informative-docs": "error",
32+
"logical-assignment-operators": [
33+
"error",
34+
"always",
35+
{ enforceForIfStatements: true },
36+
],
37+
"operator-assignment": "error",
38+
39+
// These on-by-default rules don't work well for this repo and we like them off.
40+
"jsdoc/require-jsdoc": "off",
41+
"jsdoc/require-param": "off",
42+
"jsdoc/require-property": "off",
43+
"jsdoc/require-returns": "off",
44+
},
45+
},
46+
{
47+
files: "**/*.md/*.ts",
48+
rules: {
49+
"n/no-missing-import": [
50+
"error",
51+
{ allowModules: ["github-username-to-emails"] },
52+
],
53+
},
54+
},
55+
{
56+
excludedFiles: ["**/*.md/*.ts"],
57+
extends: [
58+
"plugin:@typescript-eslint/strict-type-checked",
59+
"plugin:@typescript-eslint/stylistic-type-checked",
60+
],
61+
files: ["**/*.ts"],
62+
parser: "@typescript-eslint/parser",
63+
parserOptions: {
64+
project: "./tsconfig.eslint.json",
65+
},
66+
rules: {
67+
// These off-by-default rules work well for this repo and we like them on.
68+
"deprecation/deprecation": "error",
69+
},
70+
},
71+
{
72+
excludedFiles: ["package.json"],
73+
extends: ["plugin:jsonc/recommended-with-json"],
74+
files: ["*.json", "*.jsonc"],
75+
parser: "jsonc-eslint-parser",
76+
rules: {
77+
"jsonc/sort-keys": "error",
78+
},
79+
},
80+
{
81+
files: ["*.jsonc"],
82+
rules: {
83+
"jsonc/no-comments": "off",
84+
},
85+
},
86+
{
87+
files: "**/*.test.ts",
88+
rules: {
89+
// These on-by-default rules aren't useful in test files.
90+
"@typescript-eslint/no-unsafe-assignment": "off",
91+
"@typescript-eslint/no-unsafe-call": "off",
92+
},
93+
},
94+
{
95+
extends: ["plugin:yml/standard", "plugin:yml/prettier"],
96+
files: ["**/*.{yml,yaml}"],
97+
parser: "yaml-eslint-parser",
98+
rules: {
99+
"yml/file-extension": ["error", { extension: "yml" }],
100+
"yml/sort-keys": [
101+
"error",
102+
{
103+
order: { type: "asc" },
104+
pathPattern: "^.*$",
105+
},
106+
],
107+
"yml/sort-sequence-values": [
108+
"error",
109+
{
110+
order: { type: "asc" },
111+
pathPattern: "^.*$",
112+
},
113+
],
114+
},
115+
},
116+
],
117+
parser: "@typescript-eslint/parser",
118+
plugins: [
119+
"@typescript-eslint",
120+
"deprecation",
121+
"jsdoc",
122+
"no-only-tests",
123+
"perfectionist",
124+
"regexp",
125+
"vitest",
126+
],
127+
reportUnusedDisableDirectives: true,
128+
root: true,
129+
rules: {
130+
// These off/less-strict-by-default rules work well for this repo and we like them on.
131+
"@typescript-eslint/no-unused-vars": ["error", { caughtErrors: "all" }],
132+
"no-only-tests/no-only-tests": "error",
133+
134+
// These on-by-default rules don't work well for this repo and we like them off.
135+
"no-case-declarations": "off",
136+
"no-constant-condition": "off",
137+
"no-inner-declarations": "off",
138+
"no-mixed-spaces-and-tabs": "off",
139+
140+
// Stylistic concerns that don't interfere with Prettier
141+
"@typescript-eslint/padding-line-between-statements": [
142+
"error",
143+
{ blankLine: "always", next: "*", prev: "block-like" },
144+
],
145+
"no-useless-rename": "error",
146+
"object-shorthand": "error",
147+
"perfectionist/sort-objects": [
148+
"error",
149+
{
150+
order: "asc",
151+
"partition-by-comment": true,
152+
type: "natural",
153+
},
154+
],
155+
},
156+
};

‎.github/CODE_OF_CONDUCT.md

+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
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

0 commit comments

Comments
 (0)