Skip to content

Commit fa3db1e

Browse files
mcnaveenmcnaveen
committed
feat(core): ✨ initial release
0 parents  commit fa3db1e

Some content is hidden

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

55 files changed

+8609
-0
lines changed

‎.all-contributorsrc

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
{
2+
"badgeTemplate": "<img alt=\"All Contributors: <%= contributors.length %>\" src=\"https://img.shields.io/badge/all_contributors-<%= contributors.length %>-21bb42.svg\" />",
3+
"commit": false,
4+
"commitConvention": "angular",
5+
"contributors": [
6+
{
7+
"login": "mcnaveen",
8+
"name": "MC Naveen",
9+
"avatar_url": "https://avatars.githubusercontent.com/u/8493007?v=4",
10+
"profile": "https://github.com/mcnaveen",
11+
"contributions": [
12+
"code",
13+
"content",
14+
"doc",
15+
"ideas",
16+
"infra",
17+
"maintenance",
18+
"projectManagement",
19+
"tool"
20+
]
21+
},
22+
{
23+
"login": "JoshuaKGoldberg",
24+
"name": "Josh Goldberg ✨",
25+
"avatar_url": "https://avatars.githubusercontent.com/u/3335181?v=4",
26+
"profile": "http://www.joshuakgoldberg.com/",
27+
"contributions": [
28+
"tool"
29+
]
30+
}
31+
],
32+
"contributorsPerLine": 7,
33+
"contributorsSortAlphabetically": true,
34+
"files": [
35+
"README.md"
36+
],
37+
"imageSize": 100,
38+
"projectName": "Cart",
39+
"projectOwner": "mcnaveen",
40+
"repoHost": "https://github.com",
41+
"repoType": "github"
42+
}

‎.eslintignore

Lines changed: 5 additions & 0 deletions
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

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

‎.github/CODE_OF_CONDUCT.md

Lines changed: 132 additions & 0 deletions
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)