Skip to content
This repository has been archived by the owner on Jul 5, 2024. It is now read-only.

Commit

Permalink
feat: initial version (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
KATT authored Sep 30, 2023
1 parent 75b81f1 commit ccce25b
Show file tree
Hide file tree
Showing 28 changed files with 825 additions and 226 deletions.
2 changes: 1 addition & 1 deletion .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"README.md"
],
"imageSize": 100,
"projectName": "tson",
"projectName": "tupleson",
"projectOwner": "KATT",
"repoHost": "https://github.com",
"repoType": "github"
Expand Down
12 changes: 7 additions & 5 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -118,20 +118,22 @@ module.exports = {
root: true,
rules: {
// These off/less-strict-by-default rules work well for this repo and we like them on.

"@typescript-eslint/no-unused-vars": ["error", { caughtErrors: "all" }],
"no-only-tests/no-only-tests": "error",

// These on-by-default rules don't work well for this repo and we like them off.
"@typescript-eslint/padding-line-between-statements": [
"error",
{ blankLine: "always", next: "*", prev: "block-like" },
],
"no-case-declarations": "off",
"no-constant-condition": "off",
"no-inner-declarations": "off",
"no-mixed-spaces-and-tabs": "off",

// Stylistic concerns that don't interfere with Prettier
"@typescript-eslint/padding-line-between-statements": [
"error",
{ blankLine: "always", next: "*", prev: "block-like" },
],

"no-mixed-spaces-and-tabs": "off",
"perfectionist/sort-objects": [
"error",
{
Expand Down
10 changes: 5 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing

Thanks for your interest in contributing to `tson`! 💖
Thanks for your interest in contributing to `tupleson`! 💖

> After this page, see [DEVELOPMENT.md](./DEVELOPMENT.md) for local development instructions.
Expand All @@ -10,7 +10,7 @@ This project contains a [Contributor Covenant code of conduct](./CODE_OF_CONDUCT

## Reporting Issues

Please do [report an issue on the issue tracker](https://github.com/KATT/tson/issues/new/choose) if there's any bugfix, documentation improvement, or general enhancement you'd like to see in the repository! Please fully fill out all required fields in the most appropriate issue form.
Please do [report an issue on the issue tracker](https://github.com/KATT/tupleson/issues/new/choose) if there's any bugfix, documentation improvement, or general enhancement you'd like to see in the repository! Please fully fill out all required fields in the most appropriate issue form.

## Sending Contributions

Expand All @@ -22,8 +22,8 @@ There are two steps involved:

### Finding an Issue

With the exception of very small typos, all changes to this repository generally need to correspond to an [open issue marked as `accepting prs` on the issue tracker](https://github.com/KATT/tson/issues?q=is%3Aopen+is%3Aissue+label%3A%22accepting+prs%22).
If this is your first time contributing, consider searching for [unassigned issues that also have the `good first issue` label](https://github.com/KATT/tson/issues?q=is%3Aopen+is%3Aissue+label%3A%22accepting+prs%22+label%3A%22good+first+issue%22+no%3Aassignee).
With the exception of very small typos, all changes to this repository generally need to correspond to an [open issue marked as `accepting prs` on the issue tracker](https://github.com/KATT/tupleson/issues?q=is%3Aopen+is%3Aissue+label%3A%22accepting+prs%22).
If this is your first time contributing, consider searching for [unassigned issues that also have the `good first issue` label](https://github.com/KATT/tupleson/issues?q=is%3Aopen+is%3Aissue+label%3A%22accepting+prs%22+label%3A%22good+first+issue%22+no%3Aassignee).
If the issue you'd like to fix isn't found on the issue, see [Reporting Issues](#reporting-issues) for filing your own (please do!).

#### Issue Claiming
Expand All @@ -42,7 +42,7 @@ Be sure to fill out the pull request template's requested information -- otherwi
PRs are also expected to have a title that adheres to [commitlint](https://github.com/conventional-changelog/commitlint).
Only PR titles need to be in that format, not individual commits.
Don't worry if you get this wrong: you can always change the PR title after sending it.
Check [previously merged PRs](https://github.com/KATT/tson/pulls?q=is%3Apr+is%3Amerged+-label%3Adependencies+) for reference.
Check [previously merged PRs](https://github.com/KATT/tupleson/pulls?q=is%3Apr+is%3Amerged+-label%3Adependencies+) for reference.

#### Draft PRs

Expand Down
2 changes: 1 addition & 1 deletion .github/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
After [forking the repo from GitHub](https://help.github.com/articles/fork-a-repo) and [installing pnpm](https://pnpm.io/installation):

```shell
git clone https://github.com/<your-name-here>/tson
git clone https://github.com/KATT/tupleson
cd tson
pnpm install
```
Expand Down
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: KATT
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- Note: Please must use one of our issue templates to file an issue! 🛑 -->
<!-- 👉 https://github.com/KATT/tson/issues/new/choose 👈 -->
<!-- 👉 https://github.com/KATT/tupleson/issues/new/choose 👈 -->
<!-- **Issues that should have been filed with a template will be closed without action, and we will ask you to use a template.** -->

<!-- This blank issue template is only for issues that don't fit any of the templates. -->
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/01-bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ body:
required: true
- label: I have pulled the latest `main` branch of the repository.
required: true
- label: I have [searched for related issues](https://github.com/KATT/tson/issues?q=is%3Aissue) and found none that matched my issue.
- label: I have [searched for related issues](https://github.com/KATT/tupleson/issues?q=is%3Aissue) and found none that matched my issue.
required: true
type: checkboxes
- attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/02-documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ body:
options:
- label: I have pulled the latest `main` branch of the repository.
required: true
- label: I have [searched for related issues](https://github.com/KATT/tson/issues?q=is%3Aissue) and found none that matched my issue.
- label: I have [searched for related issues](https://github.com/KATT/tupleson/issues?q=is%3Aissue) and found none that matched my issue.
required: true
type: checkboxes
- attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/03-feature.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ body:
required: true
- label: I have pulled the latest `main` branch of the repository.
required: true
- label: I have [searched for related issues](https://github.com/KATT/tson/issues?q=is%3Aissue) and found none that matched my issue.
- label: I have [searched for related issues](https://github.com/KATT/tupleson/issues?q=is%3Aissue) and found none that matched my issue.
required: true
type: checkboxes
- attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/04-tooling.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ body:
required: true
- label: I have pulled the latest `main` branch of the repository.
required: true
- label: I have [searched for related issues](https://github.com/KATT/tson/issues?q=is%3Aissue) and found none that matched my issue.
- label: I have [searched for related issues](https://github.com/KATT/tupleson/issues?q=is%3Aissue) and found none that matched my issue.
required: true
type: checkboxes
- attributes:
Expand Down
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Otherwise we may not be able to review your PR. -->
## PR Checklist

- [ ] Addresses an existing open issue: fixes #000
- [ ] That issue was marked as [`status: accepting prs`](https://github.com/KATT/tson/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [ ] Steps in [CONTRIBUTING.md](https://github.com/KATT/tson/blob/main/.github/CONTRIBUTING.md) were taken
- [ ] That issue was marked as [`status: accepting prs`](https://github.com/KATT/tupleson/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [ ] Steps in [CONTRIBUTING.md](https://github.com/KATT/tupleson/blob/main/.github/CONTRIBUTING.md) were taken

## Overview

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/post-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
The release is available on:
* [GitHub releases](https://github.com/KATT/tson/releases/tag/{release_tag})
* [GitHub releases](https://github.com/KATT/tupleson/releases/tag/{release_tag})
* [npm package (@latest dist-tag)](https://www.npmjs.com/package/tson/v/${{ env.npm_version }})
Cheers! 📦🚀
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
script: |
try {
await github.request(
`DELETE /repos/KATT/tson/branches/main/protection`,
`DELETE /repos/KATT/tupleson/branches/main/protection`,
);
} catch (error) {
if (!error.message?.includes?.("Branch not protected")) {
Expand All @@ -43,7 +43,7 @@ jobs:
github-token: ${{ secrets.ACCESS_TOKEN }}
script: |
github.request(
`PUT /repos/KATT/tson/branches/main/protection`,
`PUT /repos/KATT/tupleson/branches/main/protection`,
{
allow_deletions: false,
allow_force_pushes: true,
Expand Down
25 changes: 25 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: ./.github/actions/prepare
- run: pnpm run test --coverage
- name: Codecov
uses: codecov/codecov-action@v3
with:
flags: unit
- if: always()
name: Archive code coverage results
uses: actions/upload-artifact@v3
with:
name: code-coverage-report
path: coverage

name: Test

on:
pull_request: ~
push:
branches:
- main
1 change: 0 additions & 1 deletion .husky/.gitignore

This file was deleted.

3 changes: 0 additions & 3 deletions .husky/pre-commit

This file was deleted.

20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h1 align="center">TSON</h1>
<h1 align="center">tupleSON</h1>

<p align="center">A hackable JSON (se|de)rializer</p>
<p align="center">A hackable JSON serializer/deserializer</p>

<p align="center">
<a href="#contributors" target="_blank">
Expand All @@ -10,19 +10,23 @@
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<!-- prettier-ignore-end -->
</a>
<a href="https://codecov.io/gh/KATT/tson" target="_blank">
<img alt="Codecov Test Coverage" src="https://codecov.io/gh/KATT/tson/branch/main/graph/badge.svg"/>
<a href="https://codecov.io/gh/KATT/tupleson" target="_blank">
<img alt="Codecov Test Coverage" src="https://codecov.io/gh/KATT/tupleson/branch/main/graph/badge.svg"/>
</a>
<a href="https://github.com/KATT/tson/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank">
<a href="https://github.com/KATT/tupleson/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank">
<img alt="Contributor Covenant" src="https://img.shields.io/badge/code_of_conduct-enforced-21bb42" />
</a>
<a href="https://github.com/KATT/tson/blob/main/LICENSE.md" target="_blank">
<img alt="License: MIT" src="https://img.shields.io/github/license/KATT/tson?color=21bb42">
<a href="https://github.com/KATT/tupleson/blob/main/LICENSE.md" target="_blank">
<img alt="License: MIT" src="https://img.shields.io/github/license/KATT/tupleson?color=21bb42">
</a>
<img alt="Style: Prettier" src="https://img.shields.io/badge/style-prettier-21bb42.svg" />
<img alt="TypeScript: Strict" src="https://img.shields.io/badge/typescript-strict-21bb42.svg" />
</p>

## Introduction

Not much to see yet, but you can spy on the tests.

## Contributors

<!-- spellchecker: disable -->
Expand All @@ -32,7 +36,7 @@
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://katt.dev/"><img src="https://avatars.githubusercontent.com/u/459267?v=4?s=100" width="100px;" alt="Alex / KATT"/><br /><sub><b>Alex / KATT</b></sub></a><br /><a href="https://github.com/KATT/tson/commits?author=KATT" title="Code">💻</a> <a href="#content-KATT" title="Content">🖋</a> <a href="https://github.com/KATT/tson/commits?author=KATT" title="Documentation">📖</a> <a href="#ideas-KATT" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-KATT" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-KATT" title="Maintenance">🚧</a> <a href="#projectManagement-KATT" title="Project Management">📆</a> <a href="#tool-KATT" title="Tools">🔧</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://katt.dev/"><img src="https://avatars.githubusercontent.com/u/459267?v=4?s=100" width="100px;" alt="Alex / KATT"/><br /><sub><b>Alex / KATT</b></sub></a><br /><a href="https://github.com/KATT/tupleson/commits?author=KATT" title="Code">💻</a> <a href="#content-KATT" title="Content">🖋</a> <a href="https://github.com/KATT/tupleson/commits?author=KATT" title="Documentation">📖</a> <a href="#ideas-KATT" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-KATT" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-KATT" title="Maintenance">🚧</a> <a href="#projectManagement-KATT" title="Project Management">📆</a> <a href="#tool-KATT" title="Tools">🔧</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://www.joshuakgoldberg.com/"><img src="https://avatars.githubusercontent.com/u/3335181?v=4?s=100" width="100px;" alt="Josh Goldberg ✨"/><br /><sub><b>Josh Goldberg ✨</b></sub></a><br /><a href="#tool-JoshuaKGoldberg" title="Tools">🔧</a></td>
</tr>
</tbody>
Expand Down
6 changes: 5 additions & 1 deletion cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
"packagejson",
"quickstart",
"tsup",
"wontfix"
"wontfix",
"tson",
"stringifier",
"KATT",
"tupleson"
]
}
16 changes: 4 additions & 12 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
{
"name": "tson",
"name": "tupleson",
"version": "0.0.0",
"description": "A hackable JSON (se|de)rializer",
"description": "A hackable JSON serializer/deserializer",
"repository": {
"type": "git",
"url": "https://github.com/KATT/tson"
"url": "https://github.com/KATT/tupleson"
},
"license": "MIT",
"author": {
"email": "[email protected]"
},
"author": "KATT",
"type": "module",
"main": "./lib/index.js",
"files": [
Expand All @@ -28,14 +26,10 @@
"lint:package-json": "npmPkgJsonLint .",
"lint:packages": "pnpm dedupe --check",
"lint:spelling": "cspell \"**\" \".github/**/*\"",
"prepare": "husky install",
"should-semantic-release": "should-semantic-release --verbose",
"test": "vitest",
"tsc": "tsc"
},
"lint-staged": {
"*": "prettier --ignore-unknown --write"
},
"devDependencies": {
"@release-it/conventional-changelog": "^7.0.2",
"@types/eslint": "^8.44.3",
Expand All @@ -56,10 +50,8 @@
"eslint-plugin-regexp": "^1.15.0",
"eslint-plugin-vitest": "^0.3.1",
"eslint-plugin-yml": "^1.9.0",
"husky": "^8.0.3",
"jsonc-eslint-parser": "^2.3.0",
"knip": "^2.30.0",
"lint-staged": "^14.0.1",
"markdownlint": "^0.31.1",
"markdownlint-cli": "^0.37.0",
"npm-package-json-lint": "^7.0.0",
Expand Down
Loading

0 comments on commit ccce25b

Please sign in to comment.