Skip to content

Commit acda84d

Browse files
jdesrosiersjdesrosiers
committed
Setup project
0 parents  commit acda84d

16 files changed

+6768
-0
lines changed

‎.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text eol=lf

‎.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: [hyperjump-io]

‎.github/dependabot.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "npm"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"
7+
- package-ecosystem: "github-actions"
8+
directory: "/"
9+
schedule:
10+
interval: "weekly"

‎.github/workflows/docs.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- "main"
7+
workflow_dispatch:
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- uses: actions/setup-node@v4
15+
with:
16+
node-version: lts/*
17+
- run: npm install
18+
- run: npm run docs
19+
- uses: actions/configure-pages@v5
20+
- uses: actions/upload-pages-artifact@v3
21+
with:
22+
path: './docs'
23+
deploy:
24+
needs: build
25+
permissions:
26+
pages: write
27+
id-token: write
28+
environment:
29+
name: github-pages
30+
url: ${{ steps.deployment.outputs.page_url }}
31+
runs-on: ubuntu-latest
32+
steps:
33+
- uses: actions/deploy-pages@v4
34+
id: deployment

‎.github/workflows/nodejs.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Node.js Automation
2+
3+
on:
4+
push:
5+
pull_request:
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v4
12+
- uses: actions/setup-node@v4
13+
with:
14+
node-version: lts/*
15+
- run: npm install
16+
- run: npm test
17+
- run: npm run lint
18+
- run: npm run type-check
19+
- run: npm run docs

‎.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
node_modules/
2+
3+
docs/
4+
5+
scratch/
6+
TODO*

‎.npmignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.github/
2+
eslint.config.js
3+
**/*.test.js
4+
tsconfig.json
5+
tsconfig.build.json
6+
scratch/
7+
TODO*

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Hyperjump Software, LLC
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Hyperjump - Better JSON Schema Errors
2+
3+
TODO: Write a short description of the package
4+
5+
## Install
6+
7+
This module is designed for node.js (ES Modules, TypeScript) and browsers. It
8+
should work in Bun and Deno as well, but the test runner doesn't work in these
9+
environments, so this module may be less stable in those environments.
10+
11+
### Node.js
12+
13+
```bash
14+
npm install @hyperjump/better-json-schema-errors
15+
```
16+
17+
## Examples and Usage
18+
19+
TODO: Write some examples
20+
21+
## Contributing
22+
23+
Contributions are welcome! Please create an issue to propose and discuss any
24+
changes you'd like to make before implementing it. If it's an obvious bug with
25+
an obvious solution or something simple like a fixing a typo, creating an issue
26+
isn't required. You can just send a PR without creating an issue. Before
27+
submitting any code, please remember to first run the following tests.
28+
29+
- `npm test` (Tests can also be run continuously using `npm test -- --watch`)
30+
- `npm run lint`
31+
- `npm run type-check`

‎eslint.config.js

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
import tseslint from "typescript-eslint";
2+
import stylistic from "@stylistic/eslint-plugin";
3+
// @ts-expect-error No types available
4+
import importPlugin from "eslint-plugin-import";
5+
6+
export default tseslint.config(
7+
...tseslint.configs.recommendedTypeChecked,
8+
...tseslint.configs.stylisticTypeChecked,
9+
importPlugin.flatConfigs.recommended, // eslint-disable-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access
10+
importPlugin.flatConfigs.typescript, // eslint-disable-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access
11+
stylistic.configs.customize({
12+
arrowParens: true,
13+
braceStyle: "1tbs",
14+
commaDangle: "never",
15+
jsx: false,
16+
quotes: "double",
17+
semi: true
18+
}),
19+
{
20+
languageOptions: {
21+
parserOptions: {
22+
projectService: true,
23+
tsconfigRootDir: import.meta.dirname
24+
}
25+
},
26+
settings: {
27+
"import/resolver": {
28+
typescript: {}
29+
}
30+
},
31+
rules: {
32+
// TypeScript
33+
"@typescript-eslint/no-unused-vars": ["error", {
34+
argsIgnorePattern: "^_",
35+
varsIgnorePattern: "^_",
36+
caughtErrorsIgnorePattern: "^_"
37+
}],
38+
"@typescript-eslint/no-empty-function": "off",
39+
"@typescript-eslint/consistent-type-definitions": ["error", "type"],
40+
"no-console": "error",
41+
42+
// Imports
43+
"import/extensions": ["error", "ignorePackages"],
44+
"import/no-named-as-default-member": "off",
45+
46+
// Stylistic
47+
"@stylistic/yield-star-spacing": ["error", "after"],
48+
"@stylistic/multiline-ternary": "off",
49+
"@stylistic/no-mixed-operators": "off",
50+
"@stylistic/quote-props": ["error", "as-needed"]
51+
}
52+
}
53+
);

0 commit comments

Comments
 (0)