@nowarajs/elysia-cache 1.3.0 โ 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +44 -0
- package/package.json +8 -8
package/AGENTS.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Development_Workflow_and_Code_Standards
|
|
3
|
+
description: Guidelines for development workflow and code standards
|
|
4
|
+
applyTo: '**'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## TypeScript and Project Conventions
|
|
8
|
+
1. Use underscore prefix for private or non-exported elements (e.g., _privateMethod)
|
|
9
|
+
2. Always specify visibility modifiers (private, protected, public), plus readonly, override, etc. when applicable
|
|
10
|
+
3. Naming conventions: camelCase for variables/functions/methods; PascalCase for classes/interfaces/types; SCREAMING_CASE for constants
|
|
11
|
+
4. Explicit typing: Always specify types for variables, parameters, and return values; never use any; prefer unknown if type cannot be determined; prefer interface over type alias for extendable objects
|
|
12
|
+
5. Documentation: Use TSDoc style; explain purpose, parameters, return values, and behavior; only document code when requested; for @throws, use format "@throws ({@link Type}) โ description"; for object/interface properties, write comment above each property instead of @param
|
|
13
|
+
6. Control structures: Omit curly braces for single-statement bodies
|
|
14
|
+
7. Path Aliases: Use $ for internal imports; do not import barrel files except as entry points
|
|
15
|
+
8. Export Pattern: Each directory has index.ts re-exporting public items; types exported in types/index.ts
|
|
16
|
+
9. Function style: Class methods use standard method syntax; helpers/callbacks/HOFs prefer arrow functions unless function syntax is required
|
|
17
|
+
|
|
18
|
+
## Contribution Principles
|
|
19
|
+
1. Follow TypeScript best practices and idiomatic patterns
|
|
20
|
+
2. Maintain existing code structure and modular organization
|
|
21
|
+
3. Keep developer experience in mind
|
|
22
|
+
4. Keep pull requests focused and well-documented (with TsDoc if asked)
|
|
23
|
+
5. Commit different types of changes separately; avoid mixing tests and features in one commit
|
|
24
|
+
|
|
25
|
+
## Commit Message Convention (Conventional Commits + Emoji)
|
|
26
|
+
Format: <type>(<emoji>): [summary up to 72 chars]
|
|
27
|
+
(blank line, then context or description)
|
|
28
|
+
|
|
29
|
+
<type> is lowercase
|
|
30
|
+
summary is surrounded by brackets `[summary]`
|
|
31
|
+
|
|
32
|
+
Types:
|
|
33
|
+
feat(๐) โ New features
|
|
34
|
+
fix(๐ง) โ Bug fixes
|
|
35
|
+
perf(โก) โ Performance improvements
|
|
36
|
+
refactor(๐งน) โ Refactoring
|
|
37
|
+
build(๐ฆ) โ Build tools / dependency changes
|
|
38
|
+
types(๐) โ Type definitions
|
|
39
|
+
chore(๐ฆ) โ Maintenance, non-code/test changes
|
|
40
|
+
examples(๐) โ Example updates
|
|
41
|
+
docs(๐) โ Documentation changes
|
|
42
|
+
test(๐งช) โ Test code updates
|
|
43
|
+
style(๐จ) โ Style/formatting only
|
|
44
|
+
ci(๐ค) โ CI/CD configuration
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nowarajs/elysia-cache",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.1",
|
|
4
4
|
"author": "NowaraJS",
|
|
5
5
|
"description": "A template to create a bun package.",
|
|
6
6
|
"type": "module",
|
|
@@ -23,21 +23,21 @@
|
|
|
23
23
|
"test": "bun test --coverage"
|
|
24
24
|
},
|
|
25
25
|
"devDependencies": {
|
|
26
|
-
"@eslint/js": "^9.39.
|
|
26
|
+
"@eslint/js": "^9.39.2",
|
|
27
27
|
"@nowarajs/error": "^1.3.10",
|
|
28
28
|
"@nowarajs/kv-store": "^1.3.0",
|
|
29
|
-
"@stylistic/eslint-plugin": "^5.
|
|
30
|
-
"@types/bun": "^1.3.
|
|
31
|
-
"elysia": "^1.4.
|
|
32
|
-
"eslint": "^9.39.
|
|
29
|
+
"@stylistic/eslint-plugin": "^5.6.1",
|
|
30
|
+
"@types/bun": "^1.3.5",
|
|
31
|
+
"elysia": "^1.4.19",
|
|
32
|
+
"eslint": "^9.39.2",
|
|
33
33
|
"globals": "^16.5.0",
|
|
34
34
|
"typescript": "^5.9.3",
|
|
35
|
-
"typescript-eslint": "^8.
|
|
35
|
+
"typescript-eslint": "^8.51.0"
|
|
36
36
|
},
|
|
37
37
|
"peerDependencies": {
|
|
38
38
|
"@nowarajs/error": "^1.3.10",
|
|
39
39
|
"@nowarajs/kv-store": "^1.3.0",
|
|
40
|
-
"elysia": "^1.4.
|
|
40
|
+
"elysia": "^1.4.19"
|
|
41
41
|
},
|
|
42
42
|
"exports": {
|
|
43
43
|
"./types": "./dist/types/index.js",
|