Skip to content

Commit 45368ee

Browse files
committed
chore: update Dependabot schedule to run on Tuesdays, remove .npmignore, and enhance package.json
1 parent c1d2197 commit 45368ee

File tree

7 files changed

+54
-31
lines changed

7 files changed

+54
-31
lines changed

.github/dependabot.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ updates:
55
directory: "/"
66
schedule:
77
interval: "weekly"
8-
day: "monday"
8+
day: "tuesday"
99
time: "09:00"
1010
open-pull-requests-limit: 1
1111
groups:
@@ -31,7 +31,7 @@ updates:
3131
directory: "/"
3232
schedule:
3333
interval: "weekly"
34-
day: "monday"
34+
day: "tuesday"
3535
time: "09:00"
3636
commit-message:
3737
prefix: "ci"

.github/workflows/npm-publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ on:
99
push:
1010
branches: [ master ]
1111
schedule:
12-
- cron: '0 12 * * 1' # Every Monday at 12:00 UTC (3 hours after Dependabot runs at 09:00)
12+
- cron: '0 12 * * 2' # Every Tuesday at 12:00 UTC (3 hours after Dependabot runs at 09:00)
1313
workflow_dispatch:
1414

1515
permissions:

.husky/commit-msg

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1 @@
1-
#!/usr/bin/env sh
2-
. "$(dirname -- "$0")/_/husky.sh"
3-
41
npx commitlint --edit $1

.husky/pre-commit

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1 @@
1-
#!/bin/sh
2-
. "$(dirname "$0")/_/husky.sh"
3-
41
npx lint-staged

.npmignore

Lines changed: 0 additions & 5 deletions
This file was deleted.

README.md

Lines changed: 41 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# ts-serializable
22

3-
> Powerful and flexible TypeScript/JavaScript library for serialization and deserialization with decorators
4-
53
[![npm version](https://img.shields.io/npm/v/ts-serializable.svg)](https://www.npmjs.com/package/ts-serializable)
64
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
75

6+
Powerful and flexible TypeScript/JavaScript library for serialization and deserialization with decorators
7+
88
## ✨ Features
99

1010
- 🎯 **Type-safe** - Convert JSON to strongly-typed class instances
@@ -18,20 +18,45 @@
1818

1919
## 📋 Table of Contents
2020

21-
- [Installation](#-installation)
22-
- [Quick Start](#-quick-start)
23-
- [Core Concepts](#-core-concepts)
24-
- [Decorators](#-decorators)
25-
- [Advanced Usage](#-advanced-usage)
26-
- [Standalone Functions](#-standalone-functions)
27-
- [Naming Strategies](#-naming-strategies)
28-
- [Configuration Settings](#️-configuration-settings)
29-
- [View Models and DTOs](#-view-models-and-dtos)
30-
- [FormData Conversion](#-formdata-conversion)
31-
- [Additional Features](#-additional-features)
32-
- [API Reference](#-api-reference)
33-
- [Contributing](#-contributing)
34-
- [License](#-license)
21+
- [ts-serializable](#ts-serializable)
22+
- [✨ Features](#-features)
23+
- [📋 Table of Contents](#-table-of-contents)
24+
- [🚀 Installation](#-installation)
25+
- [🎯 Quick Start](#-quick-start)
26+
- [Why Use ts-serializable?](#why-use-ts-serializable)
27+
- [🎓 Core Concepts](#-core-concepts)
28+
- [Type Safety](#type-safety)
29+
- [Default Values](#default-values)
30+
- [Error Handling](#error-handling)
31+
- [🎨 Decorators](#-decorators)
32+
- [@jsonProperty](#jsonproperty)
33+
- [@jsonIgnore](#jsonignore)
34+
- [@jsonName](#jsonname)
35+
- [@jsonObject](#jsonobject)
36+
- [🔧 Advanced Usage](#-advanced-usage)
37+
- [🔧 Standalone Functions](#-standalone-functions)
38+
- [🐍 Naming Strategies](#-naming-strategies)
39+
- [⚙️ Configuration Settings](#️-configuration-settings)
40+
- [🎭 View Models and DTOs](#-view-models-and-dtos)
41+
- [📤 FormData Conversion](#-formdata-conversion)
42+
- [Basic Usage](#basic-usage)
43+
- [Complex Object Graphs](#complex-object-graphs)
44+
- [With Custom Prefix](#with-custom-prefix)
45+
- [Appending to Existing FormData](#appending-to-existing-formdata)
46+
- [Special Type Handling](#special-type-handling)
47+
- [💡 Additional Features](#-additional-features)
48+
- [Deep Copy](#deep-copy)
49+
- [Nested Objects](#nested-objects)
50+
- [Arrays of Objects](#arrays-of-objects)
51+
- [📚 API Reference](#-api-reference)
52+
- [Serializable Class Methods](#serializable-class-methods)
53+
- [Static Methods](#static-methods)
54+
- [Instance Methods](#instance-methods)
55+
- [Standalone Functions](#standalone-functions)
56+
- [Available Naming Strategies](#available-naming-strategies)
57+
- [🤝 Contributing](#-contributing)
58+
- [📄 License](#-license)
59+
- [🙏 Acknowledgments](#-acknowledgments)
3560

3661
## 🚀 Installation
3762

package.json

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@
88
"main": "./dist/index.js",
99
"type": "module",
1010
"typings": "./dist/index.d.ts",
11+
"files": [
12+
"dist",
13+
"README.md",
14+
"LICENSE",
15+
"CHANGELOG.md",
16+
"CODE_OF_CONDUCT.md",
17+
"CONTRIBUTING.md",
18+
"SECURITY.md"
19+
],
1120
"repository": {
1221
"type": "git",
1322
"url": " [email protected]:LabEG/Serializable.git"
@@ -28,7 +37,7 @@
2837
"build": "tsc --project tsconfig.build.json && node ./dist/index.js",
2938
"prepublishOnly": "npm run lint && npm run build && npm run test",
3039
"release": "cliff-jumper --name 'ts-serializable' --package-path '.' --no-skip-changelog --no-skip-tag",
31-
"prepare": "husky install"
40+
"prepare": "husky"
3241
},
3342
"peerDependencies": {
3443
"reflect-metadata": ">=0.1.0"

0 commit comments

Comments
 (0)