Skip to content

Commit d1e7de5

Browse files
authored
Updating all the things (#188)
* Adding a cursor rules file * Adding docblocks * Updating README.md * Updating README.md * Updating type defs * Adding docs * Updating docs * Updating github workflows * Returning 'module' to 'package.json' * Returning 'sourceType' to 'package.json'
1 parent 104eac4 commit d1e7de5

25 files changed

+4101
-2753
lines changed

.cursor/rules/javascript.mdc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
description: JavaScript module
3+
globs:
4+
alwaysApply: true
5+
---
6+
7+
- Use JSDoc standard for creating docblocks of functions and classes.
8+
- Always use camelCase for function names.
9+
- Always use upper-case snake_case for constants.
10+
- Create integration tests in 'tests/integration' that use node-assert, which run with mocha.
11+
- Create unit tests in 'tests/unit' that use node-assert, which run with mocha.
12+
- Use node.js community "Best Practices".
13+
- Adhere to DRY, KISS, YAGNI, & SOLID principles
14+
- Adhere to OWASP security guidance

.github/workflows/ci.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212

1313
strategy:
1414
matrix:
15-
node-version: [18.x, 20.x]
15+
node-version: [20.x, 22.x]
1616

1717
steps:
1818
- name: Checkout Repository
@@ -21,7 +21,7 @@ jobs:
2121
fetch-depth: 1
2222

2323
- name: Setup Node ${{ matrix.node-version }}
24-
uses: actions/setup-node@v3
24+
uses: actions/setup-node@v4
2525
with:
2626
always-auth: false
2727
node-version: ${{ matrix.node-version }}
@@ -30,10 +30,10 @@ jobs:
3030
run: npm install
3131

3232
- name: Build
33-
run: npm run rollup
33+
run: npm run build
3434

3535
- name: Run Tests
36-
run: npm run test
36+
run: npm test
3737

3838
automerge:
3939
needs: build

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
.husky
2-
.nyc_output
32
node_modules
43
.idea
5-
test/webpack
4+
coverage

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2024, Jason Mulligan
1+
Copyright (c) 2025, Jason Mulligan
22
All rights reserved.
33

44
Redistribution and use in source and binary forms, with or without

0 commit comments

Comments
 (0)